sh_eth: fix EESIPR values for SH77{34|63}
[linux/fpc-iii.git] / drivers / ata / libata-scsi.c
blob1f863e757ee47189e9cef517a09d3045d0f2fd1f
1 /*
2 * libata-scsi.c - helper library for ATA
4 * Maintained by: Tejun Heo <tj@kernel.org>
5 * Please ALWAYS copy linux-ide@vger.kernel.org
6 * on emails.
8 * Copyright 2003-2004 Red Hat, Inc. All rights reserved.
9 * Copyright 2003-2004 Jeff Garzik
12 * This program is free software; you can redistribute it and/or modify
13 * it under the terms of the GNU General Public License as published by
14 * the Free Software Foundation; either version 2, or (at your option)
15 * any later version.
17 * This program is distributed in the hope that it will be useful,
18 * but WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 * GNU General Public License for more details.
22 * You should have received a copy of the GNU General Public License
23 * along with this program; see the file COPYING. If not, write to
24 * the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
27 * libata documentation is available via 'make {ps|pdf}docs',
28 * as Documentation/DocBook/libata.*
30 * Hardware documentation available from
31 * - http://www.t10.org/
32 * - http://www.t13.org/
36 #include <linux/slab.h>
37 #include <linux/kernel.h>
38 #include <linux/blkdev.h>
39 #include <linux/spinlock.h>
40 #include <linux/export.h>
41 #include <scsi/scsi.h>
42 #include <scsi/scsi_host.h>
43 #include <scsi/scsi_cmnd.h>
44 #include <scsi/scsi_eh.h>
45 #include <scsi/scsi_device.h>
46 #include <scsi/scsi_tcq.h>
47 #include <scsi/scsi_transport.h>
48 #include <linux/libata.h>
49 #include <linux/hdreg.h>
50 #include <linux/uaccess.h>
51 #include <linux/suspend.h>
52 #include <asm/unaligned.h>
53 #include <linux/ioprio.h>
55 #include "libata.h"
56 #include "libata-transport.h"
58 #define ATA_SCSI_RBUF_SIZE 4096
60 static DEFINE_SPINLOCK(ata_scsi_rbuf_lock);
61 static u8 ata_scsi_rbuf[ATA_SCSI_RBUF_SIZE];
63 typedef unsigned int (*ata_xlat_func_t)(struct ata_queued_cmd *qc);
65 static struct ata_device *__ata_scsi_find_dev(struct ata_port *ap,
66 const struct scsi_device *scsidev);
67 static struct ata_device *ata_scsi_find_dev(struct ata_port *ap,
68 const struct scsi_device *scsidev);
70 #define RW_RECOVERY_MPAGE 0x1
71 #define RW_RECOVERY_MPAGE_LEN 12
72 #define CACHE_MPAGE 0x8
73 #define CACHE_MPAGE_LEN 20
74 #define CONTROL_MPAGE 0xa
75 #define CONTROL_MPAGE_LEN 12
76 #define ALL_MPAGES 0x3f
77 #define ALL_SUB_MPAGES 0xff
80 static const u8 def_rw_recovery_mpage[RW_RECOVERY_MPAGE_LEN] = {
81 RW_RECOVERY_MPAGE,
82 RW_RECOVERY_MPAGE_LEN - 2,
83 (1 << 7), /* AWRE */
84 0, /* read retry count */
85 0, 0, 0, 0,
86 0, /* write retry count */
87 0, 0, 0
90 static const u8 def_cache_mpage[CACHE_MPAGE_LEN] = {
91 CACHE_MPAGE,
92 CACHE_MPAGE_LEN - 2,
93 0, /* contains WCE, needs to be 0 for logic */
94 0, 0, 0, 0, 0, 0, 0, 0, 0,
95 0, /* contains DRA, needs to be 0 for logic */
96 0, 0, 0, 0, 0, 0, 0
99 static const u8 def_control_mpage[CONTROL_MPAGE_LEN] = {
100 CONTROL_MPAGE,
101 CONTROL_MPAGE_LEN - 2,
102 2, /* DSENSE=0, GLTSD=1 */
103 0, /* [QAM+QERR may be 1, see 05-359r1] */
104 0, 0, 0, 0, 0xff, 0xff,
105 0, 30 /* extended self test time, see 05-359r1 */
108 static const char *ata_lpm_policy_names[] = {
109 [ATA_LPM_UNKNOWN] = "max_performance",
110 [ATA_LPM_MAX_POWER] = "max_performance",
111 [ATA_LPM_MED_POWER] = "medium_power",
112 [ATA_LPM_MIN_POWER] = "min_power",
115 static ssize_t ata_scsi_lpm_store(struct device *device,
116 struct device_attribute *attr,
117 const char *buf, size_t count)
119 struct Scsi_Host *shost = class_to_shost(device);
120 struct ata_port *ap = ata_shost_to_port(shost);
121 struct ata_link *link;
122 struct ata_device *dev;
123 enum ata_lpm_policy policy;
124 unsigned long flags;
126 /* UNKNOWN is internal state, iterate from MAX_POWER */
127 for (policy = ATA_LPM_MAX_POWER;
128 policy < ARRAY_SIZE(ata_lpm_policy_names); policy++) {
129 const char *name = ata_lpm_policy_names[policy];
131 if (strncmp(name, buf, strlen(name)) == 0)
132 break;
134 if (policy == ARRAY_SIZE(ata_lpm_policy_names))
135 return -EINVAL;
137 spin_lock_irqsave(ap->lock, flags);
139 ata_for_each_link(link, ap, EDGE) {
140 ata_for_each_dev(dev, &ap->link, ENABLED) {
141 if (dev->horkage & ATA_HORKAGE_NOLPM) {
142 count = -EOPNOTSUPP;
143 goto out_unlock;
148 ap->target_lpm_policy = policy;
149 ata_port_schedule_eh(ap);
150 out_unlock:
151 spin_unlock_irqrestore(ap->lock, flags);
152 return count;
155 static ssize_t ata_scsi_lpm_show(struct device *dev,
156 struct device_attribute *attr, char *buf)
158 struct Scsi_Host *shost = class_to_shost(dev);
159 struct ata_port *ap = ata_shost_to_port(shost);
161 if (ap->target_lpm_policy >= ARRAY_SIZE(ata_lpm_policy_names))
162 return -EINVAL;
164 return snprintf(buf, PAGE_SIZE, "%s\n",
165 ata_lpm_policy_names[ap->target_lpm_policy]);
167 DEVICE_ATTR(link_power_management_policy, S_IRUGO | S_IWUSR,
168 ata_scsi_lpm_show, ata_scsi_lpm_store);
169 EXPORT_SYMBOL_GPL(dev_attr_link_power_management_policy);
171 static ssize_t ata_scsi_park_show(struct device *device,
172 struct device_attribute *attr, char *buf)
174 struct scsi_device *sdev = to_scsi_device(device);
175 struct ata_port *ap;
176 struct ata_link *link;
177 struct ata_device *dev;
178 unsigned long now;
179 unsigned int uninitialized_var(msecs);
180 int rc = 0;
182 ap = ata_shost_to_port(sdev->host);
184 spin_lock_irq(ap->lock);
185 dev = ata_scsi_find_dev(ap, sdev);
186 if (!dev) {
187 rc = -ENODEV;
188 goto unlock;
190 if (dev->flags & ATA_DFLAG_NO_UNLOAD) {
191 rc = -EOPNOTSUPP;
192 goto unlock;
195 link = dev->link;
196 now = jiffies;
197 if (ap->pflags & ATA_PFLAG_EH_IN_PROGRESS &&
198 link->eh_context.unloaded_mask & (1 << dev->devno) &&
199 time_after(dev->unpark_deadline, now))
200 msecs = jiffies_to_msecs(dev->unpark_deadline - now);
201 else
202 msecs = 0;
204 unlock:
205 spin_unlock_irq(ap->lock);
207 return rc ? rc : snprintf(buf, 20, "%u\n", msecs);
210 static ssize_t ata_scsi_park_store(struct device *device,
211 struct device_attribute *attr,
212 const char *buf, size_t len)
214 struct scsi_device *sdev = to_scsi_device(device);
215 struct ata_port *ap;
216 struct ata_device *dev;
217 long int input;
218 unsigned long flags;
219 int rc;
221 rc = kstrtol(buf, 10, &input);
222 if (rc)
223 return rc;
224 if (input < -2)
225 return -EINVAL;
226 if (input > ATA_TMOUT_MAX_PARK) {
227 rc = -EOVERFLOW;
228 input = ATA_TMOUT_MAX_PARK;
231 ap = ata_shost_to_port(sdev->host);
233 spin_lock_irqsave(ap->lock, flags);
234 dev = ata_scsi_find_dev(ap, sdev);
235 if (unlikely(!dev)) {
236 rc = -ENODEV;
237 goto unlock;
239 if (dev->class != ATA_DEV_ATA &&
240 dev->class != ATA_DEV_ZAC) {
241 rc = -EOPNOTSUPP;
242 goto unlock;
245 if (input >= 0) {
246 if (dev->flags & ATA_DFLAG_NO_UNLOAD) {
247 rc = -EOPNOTSUPP;
248 goto unlock;
251 dev->unpark_deadline = ata_deadline(jiffies, input);
252 dev->link->eh_info.dev_action[dev->devno] |= ATA_EH_PARK;
253 ata_port_schedule_eh(ap);
254 complete(&ap->park_req_pending);
255 } else {
256 switch (input) {
257 case -1:
258 dev->flags &= ~ATA_DFLAG_NO_UNLOAD;
259 break;
260 case -2:
261 dev->flags |= ATA_DFLAG_NO_UNLOAD;
262 break;
265 unlock:
266 spin_unlock_irqrestore(ap->lock, flags);
268 return rc ? rc : len;
270 DEVICE_ATTR(unload_heads, S_IRUGO | S_IWUSR,
271 ata_scsi_park_show, ata_scsi_park_store);
272 EXPORT_SYMBOL_GPL(dev_attr_unload_heads);
274 static ssize_t ata_ncq_prio_enable_show(struct device *device,
275 struct device_attribute *attr,
276 char *buf)
278 struct scsi_device *sdev = to_scsi_device(device);
279 struct ata_port *ap;
280 struct ata_device *dev;
281 bool ncq_prio_enable;
282 int rc = 0;
284 ap = ata_shost_to_port(sdev->host);
286 spin_lock_irq(ap->lock);
287 dev = ata_scsi_find_dev(ap, sdev);
288 if (!dev) {
289 rc = -ENODEV;
290 goto unlock;
293 ncq_prio_enable = dev->flags & ATA_DFLAG_NCQ_PRIO_ENABLE;
295 unlock:
296 spin_unlock_irq(ap->lock);
298 return rc ? rc : snprintf(buf, 20, "%u\n", ncq_prio_enable);
301 static ssize_t ata_ncq_prio_enable_store(struct device *device,
302 struct device_attribute *attr,
303 const char *buf, size_t len)
305 struct scsi_device *sdev = to_scsi_device(device);
306 struct ata_port *ap;
307 struct ata_device *dev;
308 long int input;
309 int rc;
311 rc = kstrtol(buf, 10, &input);
312 if (rc)
313 return rc;
314 if ((input < 0) || (input > 1))
315 return -EINVAL;
317 ap = ata_shost_to_port(sdev->host);
318 dev = ata_scsi_find_dev(ap, sdev);
319 if (unlikely(!dev))
320 return -ENODEV;
322 spin_lock_irq(ap->lock);
323 if (input)
324 dev->flags |= ATA_DFLAG_NCQ_PRIO_ENABLE;
325 else
326 dev->flags &= ~ATA_DFLAG_NCQ_PRIO_ENABLE;
328 dev->link->eh_info.action |= ATA_EH_REVALIDATE;
329 dev->link->eh_info.flags |= ATA_EHI_QUIET;
330 ata_port_schedule_eh(ap);
331 spin_unlock_irq(ap->lock);
333 ata_port_wait_eh(ap);
335 if (input) {
336 spin_lock_irq(ap->lock);
337 if (!(dev->flags & ATA_DFLAG_NCQ_PRIO)) {
338 dev->flags &= ~ATA_DFLAG_NCQ_PRIO_ENABLE;
339 rc = -EIO;
341 spin_unlock_irq(ap->lock);
344 return rc ? rc : len;
347 DEVICE_ATTR(ncq_prio_enable, S_IRUGO | S_IWUSR,
348 ata_ncq_prio_enable_show, ata_ncq_prio_enable_store);
349 EXPORT_SYMBOL_GPL(dev_attr_ncq_prio_enable);
351 void ata_scsi_set_sense(struct ata_device *dev, struct scsi_cmnd *cmd,
352 u8 sk, u8 asc, u8 ascq)
354 bool d_sense = (dev->flags & ATA_DFLAG_D_SENSE);
356 if (!cmd)
357 return;
359 cmd->result = (DRIVER_SENSE << 24) | SAM_STAT_CHECK_CONDITION;
361 scsi_build_sense_buffer(d_sense, cmd->sense_buffer, sk, asc, ascq);
364 void ata_scsi_set_sense_information(struct ata_device *dev,
365 struct scsi_cmnd *cmd,
366 const struct ata_taskfile *tf)
368 u64 information;
370 if (!cmd)
371 return;
373 information = ata_tf_read_block(tf, dev);
374 if (information == U64_MAX)
375 return;
377 scsi_set_sense_information(cmd->sense_buffer,
378 SCSI_SENSE_BUFFERSIZE, information);
381 static void ata_scsi_set_invalid_field(struct ata_device *dev,
382 struct scsi_cmnd *cmd, u16 field, u8 bit)
384 ata_scsi_set_sense(dev, cmd, ILLEGAL_REQUEST, 0x24, 0x0);
385 /* "Invalid field in CDB" */
386 scsi_set_sense_field_pointer(cmd->sense_buffer, SCSI_SENSE_BUFFERSIZE,
387 field, bit, 1);
390 static void ata_scsi_set_invalid_parameter(struct ata_device *dev,
391 struct scsi_cmnd *cmd, u16 field)
393 /* "Invalid field in parameter list" */
394 ata_scsi_set_sense(dev, cmd, ILLEGAL_REQUEST, 0x26, 0x0);
395 scsi_set_sense_field_pointer(cmd->sense_buffer, SCSI_SENSE_BUFFERSIZE,
396 field, 0xff, 0);
399 static ssize_t
400 ata_scsi_em_message_store(struct device *dev, struct device_attribute *attr,
401 const char *buf, size_t count)
403 struct Scsi_Host *shost = class_to_shost(dev);
404 struct ata_port *ap = ata_shost_to_port(shost);
405 if (ap->ops->em_store && (ap->flags & ATA_FLAG_EM))
406 return ap->ops->em_store(ap, buf, count);
407 return -EINVAL;
410 static ssize_t
411 ata_scsi_em_message_show(struct device *dev, struct device_attribute *attr,
412 char *buf)
414 struct Scsi_Host *shost = class_to_shost(dev);
415 struct ata_port *ap = ata_shost_to_port(shost);
417 if (ap->ops->em_show && (ap->flags & ATA_FLAG_EM))
418 return ap->ops->em_show(ap, buf);
419 return -EINVAL;
421 DEVICE_ATTR(em_message, S_IRUGO | S_IWUSR,
422 ata_scsi_em_message_show, ata_scsi_em_message_store);
423 EXPORT_SYMBOL_GPL(dev_attr_em_message);
425 static ssize_t
426 ata_scsi_em_message_type_show(struct device *dev, struct device_attribute *attr,
427 char *buf)
429 struct Scsi_Host *shost = class_to_shost(dev);
430 struct ata_port *ap = ata_shost_to_port(shost);
432 return snprintf(buf, 23, "%d\n", ap->em_message_type);
434 DEVICE_ATTR(em_message_type, S_IRUGO,
435 ata_scsi_em_message_type_show, NULL);
436 EXPORT_SYMBOL_GPL(dev_attr_em_message_type);
438 static ssize_t
439 ata_scsi_activity_show(struct device *dev, struct device_attribute *attr,
440 char *buf)
442 struct scsi_device *sdev = to_scsi_device(dev);
443 struct ata_port *ap = ata_shost_to_port(sdev->host);
444 struct ata_device *atadev = ata_scsi_find_dev(ap, sdev);
446 if (atadev && ap->ops->sw_activity_show &&
447 (ap->flags & ATA_FLAG_SW_ACTIVITY))
448 return ap->ops->sw_activity_show(atadev, buf);
449 return -EINVAL;
452 static ssize_t
453 ata_scsi_activity_store(struct device *dev, struct device_attribute *attr,
454 const char *buf, size_t count)
456 struct scsi_device *sdev = to_scsi_device(dev);
457 struct ata_port *ap = ata_shost_to_port(sdev->host);
458 struct ata_device *atadev = ata_scsi_find_dev(ap, sdev);
459 enum sw_activity val;
460 int rc;
462 if (atadev && ap->ops->sw_activity_store &&
463 (ap->flags & ATA_FLAG_SW_ACTIVITY)) {
464 val = simple_strtoul(buf, NULL, 0);
465 switch (val) {
466 case OFF: case BLINK_ON: case BLINK_OFF:
467 rc = ap->ops->sw_activity_store(atadev, val);
468 if (!rc)
469 return count;
470 else
471 return rc;
474 return -EINVAL;
476 DEVICE_ATTR(sw_activity, S_IWUSR | S_IRUGO, ata_scsi_activity_show,
477 ata_scsi_activity_store);
478 EXPORT_SYMBOL_GPL(dev_attr_sw_activity);
480 struct device_attribute *ata_common_sdev_attrs[] = {
481 &dev_attr_unload_heads,
482 &dev_attr_ncq_prio_enable,
483 NULL
485 EXPORT_SYMBOL_GPL(ata_common_sdev_attrs);
487 static void ata_scsi_invalid_field(struct ata_device *dev,
488 struct scsi_cmnd *cmd, u16 field)
490 ata_scsi_set_invalid_field(dev, cmd, field, 0xff);
491 cmd->scsi_done(cmd);
495 * ata_std_bios_param - generic bios head/sector/cylinder calculator used by sd.
496 * @sdev: SCSI device for which BIOS geometry is to be determined
497 * @bdev: block device associated with @sdev
498 * @capacity: capacity of SCSI device
499 * @geom: location to which geometry will be output
501 * Generic bios head/sector/cylinder calculator
502 * used by sd. Most BIOSes nowadays expect a XXX/255/16 (CHS)
503 * mapping. Some situations may arise where the disk is not
504 * bootable if this is not used.
506 * LOCKING:
507 * Defined by the SCSI layer. We don't really care.
509 * RETURNS:
510 * Zero.
512 int ata_std_bios_param(struct scsi_device *sdev, struct block_device *bdev,
513 sector_t capacity, int geom[])
515 geom[0] = 255;
516 geom[1] = 63;
517 sector_div(capacity, 255*63);
518 geom[2] = capacity;
520 return 0;
524 * ata_scsi_unlock_native_capacity - unlock native capacity
525 * @sdev: SCSI device to adjust device capacity for
527 * This function is called if a partition on @sdev extends beyond
528 * the end of the device. It requests EH to unlock HPA.
530 * LOCKING:
531 * Defined by the SCSI layer. Might sleep.
533 void ata_scsi_unlock_native_capacity(struct scsi_device *sdev)
535 struct ata_port *ap = ata_shost_to_port(sdev->host);
536 struct ata_device *dev;
537 unsigned long flags;
539 spin_lock_irqsave(ap->lock, flags);
541 dev = ata_scsi_find_dev(ap, sdev);
542 if (dev && dev->n_sectors < dev->n_native_sectors) {
543 dev->flags |= ATA_DFLAG_UNLOCK_HPA;
544 dev->link->eh_info.action |= ATA_EH_RESET;
545 ata_port_schedule_eh(ap);
548 spin_unlock_irqrestore(ap->lock, flags);
549 ata_port_wait_eh(ap);
553 * ata_get_identity - Handler for HDIO_GET_IDENTITY ioctl
554 * @ap: target port
555 * @sdev: SCSI device to get identify data for
556 * @arg: User buffer area for identify data
558 * LOCKING:
559 * Defined by the SCSI layer. We don't really care.
561 * RETURNS:
562 * Zero on success, negative errno on error.
564 static int ata_get_identity(struct ata_port *ap, struct scsi_device *sdev,
565 void __user *arg)
567 struct ata_device *dev = ata_scsi_find_dev(ap, sdev);
568 u16 __user *dst = arg;
569 char buf[40];
571 if (!dev)
572 return -ENOMSG;
574 if (copy_to_user(dst, dev->id, ATA_ID_WORDS * sizeof(u16)))
575 return -EFAULT;
577 ata_id_string(dev->id, buf, ATA_ID_PROD, ATA_ID_PROD_LEN);
578 if (copy_to_user(dst + ATA_ID_PROD, buf, ATA_ID_PROD_LEN))
579 return -EFAULT;
581 ata_id_string(dev->id, buf, ATA_ID_FW_REV, ATA_ID_FW_REV_LEN);
582 if (copy_to_user(dst + ATA_ID_FW_REV, buf, ATA_ID_FW_REV_LEN))
583 return -EFAULT;
585 ata_id_string(dev->id, buf, ATA_ID_SERNO, ATA_ID_SERNO_LEN);
586 if (copy_to_user(dst + ATA_ID_SERNO, buf, ATA_ID_SERNO_LEN))
587 return -EFAULT;
589 return 0;
593 * ata_cmd_ioctl - Handler for HDIO_DRIVE_CMD ioctl
594 * @scsidev: Device to which we are issuing command
595 * @arg: User provided data for issuing command
597 * LOCKING:
598 * Defined by the SCSI layer. We don't really care.
600 * RETURNS:
601 * Zero on success, negative errno on error.
603 int ata_cmd_ioctl(struct scsi_device *scsidev, void __user *arg)
605 int rc = 0;
606 u8 scsi_cmd[MAX_COMMAND_SIZE];
607 u8 args[4], *argbuf = NULL, *sensebuf = NULL;
608 int argsize = 0;
609 enum dma_data_direction data_dir;
610 int cmd_result;
612 if (arg == NULL)
613 return -EINVAL;
615 if (copy_from_user(args, arg, sizeof(args)))
616 return -EFAULT;
618 sensebuf = kzalloc(SCSI_SENSE_BUFFERSIZE, GFP_NOIO);
619 if (!sensebuf)
620 return -ENOMEM;
622 memset(scsi_cmd, 0, sizeof(scsi_cmd));
624 if (args[3]) {
625 argsize = ATA_SECT_SIZE * args[3];
626 argbuf = kmalloc(argsize, GFP_KERNEL);
627 if (argbuf == NULL) {
628 rc = -ENOMEM;
629 goto error;
632 scsi_cmd[1] = (4 << 1); /* PIO Data-in */
633 scsi_cmd[2] = 0x0e; /* no off.line or cc, read from dev,
634 block count in sector count field */
635 data_dir = DMA_FROM_DEVICE;
636 } else {
637 scsi_cmd[1] = (3 << 1); /* Non-data */
638 scsi_cmd[2] = 0x20; /* cc but no off.line or data xfer */
639 data_dir = DMA_NONE;
642 scsi_cmd[0] = ATA_16;
644 scsi_cmd[4] = args[2];
645 if (args[0] == ATA_CMD_SMART) { /* hack -- ide driver does this too */
646 scsi_cmd[6] = args[3];
647 scsi_cmd[8] = args[1];
648 scsi_cmd[10] = 0x4f;
649 scsi_cmd[12] = 0xc2;
650 } else {
651 scsi_cmd[6] = args[1];
653 scsi_cmd[14] = args[0];
655 /* Good values for timeout and retries? Values below
656 from scsi_ioctl_send_command() for default case... */
657 cmd_result = scsi_execute(scsidev, scsi_cmd, data_dir, argbuf, argsize,
658 sensebuf, (10*HZ), 5, 0, NULL);
660 if (driver_byte(cmd_result) == DRIVER_SENSE) {/* sense data available */
661 u8 *desc = sensebuf + 8;
662 cmd_result &= ~(0xFF<<24); /* DRIVER_SENSE is not an error */
664 /* If we set cc then ATA pass-through will cause a
665 * check condition even if no error. Filter that. */
666 if (cmd_result & SAM_STAT_CHECK_CONDITION) {
667 struct scsi_sense_hdr sshdr;
668 scsi_normalize_sense(sensebuf, SCSI_SENSE_BUFFERSIZE,
669 &sshdr);
670 if (sshdr.sense_key == RECOVERED_ERROR &&
671 sshdr.asc == 0 && sshdr.ascq == 0x1d)
672 cmd_result &= ~SAM_STAT_CHECK_CONDITION;
675 /* Send userspace a few ATA registers (same as drivers/ide) */
676 if (sensebuf[0] == 0x72 && /* format is "descriptor" */
677 desc[0] == 0x09) { /* code is "ATA Descriptor" */
678 args[0] = desc[13]; /* status */
679 args[1] = desc[3]; /* error */
680 args[2] = desc[5]; /* sector count (0:7) */
681 if (copy_to_user(arg, args, sizeof(args)))
682 rc = -EFAULT;
687 if (cmd_result) {
688 rc = -EIO;
689 goto error;
692 if ((argbuf)
693 && copy_to_user(arg + sizeof(args), argbuf, argsize))
694 rc = -EFAULT;
695 error:
696 kfree(sensebuf);
697 kfree(argbuf);
698 return rc;
702 * ata_task_ioctl - Handler for HDIO_DRIVE_TASK ioctl
703 * @scsidev: Device to which we are issuing command
704 * @arg: User provided data for issuing command
706 * LOCKING:
707 * Defined by the SCSI layer. We don't really care.
709 * RETURNS:
710 * Zero on success, negative errno on error.
712 int ata_task_ioctl(struct scsi_device *scsidev, void __user *arg)
714 int rc = 0;
715 u8 scsi_cmd[MAX_COMMAND_SIZE];
716 u8 args[7], *sensebuf = NULL;
717 int cmd_result;
719 if (arg == NULL)
720 return -EINVAL;
722 if (copy_from_user(args, arg, sizeof(args)))
723 return -EFAULT;
725 sensebuf = kzalloc(SCSI_SENSE_BUFFERSIZE, GFP_NOIO);
726 if (!sensebuf)
727 return -ENOMEM;
729 memset(scsi_cmd, 0, sizeof(scsi_cmd));
730 scsi_cmd[0] = ATA_16;
731 scsi_cmd[1] = (3 << 1); /* Non-data */
732 scsi_cmd[2] = 0x20; /* cc but no off.line or data xfer */
733 scsi_cmd[4] = args[1];
734 scsi_cmd[6] = args[2];
735 scsi_cmd[8] = args[3];
736 scsi_cmd[10] = args[4];
737 scsi_cmd[12] = args[5];
738 scsi_cmd[13] = args[6] & 0x4f;
739 scsi_cmd[14] = args[0];
741 /* Good values for timeout and retries? Values below
742 from scsi_ioctl_send_command() for default case... */
743 cmd_result = scsi_execute(scsidev, scsi_cmd, DMA_NONE, NULL, 0,
744 sensebuf, (10*HZ), 5, 0, NULL);
746 if (driver_byte(cmd_result) == DRIVER_SENSE) {/* sense data available */
747 u8 *desc = sensebuf + 8;
748 cmd_result &= ~(0xFF<<24); /* DRIVER_SENSE is not an error */
750 /* If we set cc then ATA pass-through will cause a
751 * check condition even if no error. Filter that. */
752 if (cmd_result & SAM_STAT_CHECK_CONDITION) {
753 struct scsi_sense_hdr sshdr;
754 scsi_normalize_sense(sensebuf, SCSI_SENSE_BUFFERSIZE,
755 &sshdr);
756 if (sshdr.sense_key == RECOVERED_ERROR &&
757 sshdr.asc == 0 && sshdr.ascq == 0x1d)
758 cmd_result &= ~SAM_STAT_CHECK_CONDITION;
761 /* Send userspace ATA registers */
762 if (sensebuf[0] == 0x72 && /* format is "descriptor" */
763 desc[0] == 0x09) {/* code is "ATA Descriptor" */
764 args[0] = desc[13]; /* status */
765 args[1] = desc[3]; /* error */
766 args[2] = desc[5]; /* sector count (0:7) */
767 args[3] = desc[7]; /* lbal */
768 args[4] = desc[9]; /* lbam */
769 args[5] = desc[11]; /* lbah */
770 args[6] = desc[12]; /* select */
771 if (copy_to_user(arg, args, sizeof(args)))
772 rc = -EFAULT;
776 if (cmd_result) {
777 rc = -EIO;
778 goto error;
781 error:
782 kfree(sensebuf);
783 return rc;
786 static int ata_ioc32(struct ata_port *ap)
788 if (ap->flags & ATA_FLAG_PIO_DMA)
789 return 1;
790 if (ap->pflags & ATA_PFLAG_PIO32)
791 return 1;
792 return 0;
795 int ata_sas_scsi_ioctl(struct ata_port *ap, struct scsi_device *scsidev,
796 int cmd, void __user *arg)
798 unsigned long val;
799 int rc = -EINVAL;
800 unsigned long flags;
802 switch (cmd) {
803 case HDIO_GET_32BIT:
804 spin_lock_irqsave(ap->lock, flags);
805 val = ata_ioc32(ap);
806 spin_unlock_irqrestore(ap->lock, flags);
807 return put_user(val, (unsigned long __user *)arg);
809 case HDIO_SET_32BIT:
810 val = (unsigned long) arg;
811 rc = 0;
812 spin_lock_irqsave(ap->lock, flags);
813 if (ap->pflags & ATA_PFLAG_PIO32CHANGE) {
814 if (val)
815 ap->pflags |= ATA_PFLAG_PIO32;
816 else
817 ap->pflags &= ~ATA_PFLAG_PIO32;
818 } else {
819 if (val != ata_ioc32(ap))
820 rc = -EINVAL;
822 spin_unlock_irqrestore(ap->lock, flags);
823 return rc;
825 case HDIO_GET_IDENTITY:
826 return ata_get_identity(ap, scsidev, arg);
828 case HDIO_DRIVE_CMD:
829 if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
830 return -EACCES;
831 return ata_cmd_ioctl(scsidev, arg);
833 case HDIO_DRIVE_TASK:
834 if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
835 return -EACCES;
836 return ata_task_ioctl(scsidev, arg);
838 default:
839 rc = -ENOTTY;
840 break;
843 return rc;
845 EXPORT_SYMBOL_GPL(ata_sas_scsi_ioctl);
847 int ata_scsi_ioctl(struct scsi_device *scsidev, int cmd, void __user *arg)
849 return ata_sas_scsi_ioctl(ata_shost_to_port(scsidev->host),
850 scsidev, cmd, arg);
852 EXPORT_SYMBOL_GPL(ata_scsi_ioctl);
855 * ata_scsi_qc_new - acquire new ata_queued_cmd reference
856 * @dev: ATA device to which the new command is attached
857 * @cmd: SCSI command that originated this ATA command
859 * Obtain a reference to an unused ata_queued_cmd structure,
860 * which is the basic libata structure representing a single
861 * ATA command sent to the hardware.
863 * If a command was available, fill in the SCSI-specific
864 * portions of the structure with information on the
865 * current command.
867 * LOCKING:
868 * spin_lock_irqsave(host lock)
870 * RETURNS:
871 * Command allocated, or %NULL if none available.
873 static struct ata_queued_cmd *ata_scsi_qc_new(struct ata_device *dev,
874 struct scsi_cmnd *cmd)
876 struct ata_queued_cmd *qc;
878 qc = ata_qc_new_init(dev, cmd->request->tag);
879 if (qc) {
880 qc->scsicmd = cmd;
881 qc->scsidone = cmd->scsi_done;
883 qc->sg = scsi_sglist(cmd);
884 qc->n_elem = scsi_sg_count(cmd);
885 } else {
886 cmd->result = (DID_OK << 16) | (QUEUE_FULL << 1);
887 cmd->scsi_done(cmd);
890 return qc;
893 static void ata_qc_set_pc_nbytes(struct ata_queued_cmd *qc)
895 struct scsi_cmnd *scmd = qc->scsicmd;
897 qc->extrabytes = scmd->request->extra_len;
898 qc->nbytes = scsi_bufflen(scmd) + qc->extrabytes;
902 * ata_dump_status - user friendly display of error info
903 * @id: id of the port in question
904 * @tf: ptr to filled out taskfile
906 * Decode and dump the ATA error/status registers for the user so
907 * that they have some idea what really happened at the non
908 * make-believe layer.
910 * LOCKING:
911 * inherited from caller
913 static void ata_dump_status(unsigned id, struct ata_taskfile *tf)
915 u8 stat = tf->command, err = tf->feature;
917 printk(KERN_WARNING "ata%u: status=0x%02x { ", id, stat);
918 if (stat & ATA_BUSY) {
919 printk("Busy }\n"); /* Data is not valid in this case */
920 } else {
921 if (stat & ATA_DRDY) printk("DriveReady ");
922 if (stat & ATA_DF) printk("DeviceFault ");
923 if (stat & ATA_DSC) printk("SeekComplete ");
924 if (stat & ATA_DRQ) printk("DataRequest ");
925 if (stat & ATA_CORR) printk("CorrectedError ");
926 if (stat & ATA_SENSE) printk("Sense ");
927 if (stat & ATA_ERR) printk("Error ");
928 printk("}\n");
930 if (err) {
931 printk(KERN_WARNING "ata%u: error=0x%02x { ", id, err);
932 if (err & ATA_ABORTED) printk("DriveStatusError ");
933 if (err & ATA_ICRC) {
934 if (err & ATA_ABORTED)
935 printk("BadCRC ");
936 else printk("Sector ");
938 if (err & ATA_UNC) printk("UncorrectableError ");
939 if (err & ATA_IDNF) printk("SectorIdNotFound ");
940 if (err & ATA_TRK0NF) printk("TrackZeroNotFound ");
941 if (err & ATA_AMNF) printk("AddrMarkNotFound ");
942 printk("}\n");
948 * ata_to_sense_error - convert ATA error to SCSI error
949 * @id: ATA device number
950 * @drv_stat: value contained in ATA status register
951 * @drv_err: value contained in ATA error register
952 * @sk: the sense key we'll fill out
953 * @asc: the additional sense code we'll fill out
954 * @ascq: the additional sense code qualifier we'll fill out
955 * @verbose: be verbose
957 * Converts an ATA error into a SCSI error. Fill out pointers to
958 * SK, ASC, and ASCQ bytes for later use in fixed or descriptor
959 * format sense blocks.
961 * LOCKING:
962 * spin_lock_irqsave(host lock)
964 static void ata_to_sense_error(unsigned id, u8 drv_stat, u8 drv_err, u8 *sk,
965 u8 *asc, u8 *ascq, int verbose)
967 int i;
969 /* Based on the 3ware driver translation table */
970 static const unsigned char sense_table[][4] = {
971 /* BBD|ECC|ID|MAR */
972 {0xd1, ABORTED_COMMAND, 0x00, 0x00},
973 // Device busy Aborted command
974 /* BBD|ECC|ID */
975 {0xd0, ABORTED_COMMAND, 0x00, 0x00},
976 // Device busy Aborted command
977 /* ECC|MC|MARK */
978 {0x61, HARDWARE_ERROR, 0x00, 0x00},
979 // Device fault Hardware error
980 /* ICRC|ABRT */ /* NB: ICRC & !ABRT is BBD */
981 {0x84, ABORTED_COMMAND, 0x47, 0x00},
982 // Data CRC error SCSI parity error
983 /* MC|ID|ABRT|TRK0|MARK */
984 {0x37, NOT_READY, 0x04, 0x00},
985 // Unit offline Not ready
986 /* MCR|MARK */
987 {0x09, NOT_READY, 0x04, 0x00},
988 // Unrecovered disk error Not ready
989 /* Bad address mark */
990 {0x01, MEDIUM_ERROR, 0x13, 0x00},
991 // Address mark not found for data field
992 /* TRK0 - Track 0 not found */
993 {0x02, HARDWARE_ERROR, 0x00, 0x00},
994 // Hardware error
995 /* Abort: 0x04 is not translated here, see below */
996 /* Media change request */
997 {0x08, NOT_READY, 0x04, 0x00},
998 // FIXME: faking offline
999 /* SRV/IDNF - ID not found */
1000 {0x10, ILLEGAL_REQUEST, 0x21, 0x00},
1001 // Logical address out of range
1002 /* MC - Media Changed */
1003 {0x20, UNIT_ATTENTION, 0x28, 0x00},
1004 // Not ready to ready change, medium may have changed
1005 /* ECC - Uncorrectable ECC error */
1006 {0x40, MEDIUM_ERROR, 0x11, 0x04},
1007 // Unrecovered read error
1008 /* BBD - block marked bad */
1009 {0x80, MEDIUM_ERROR, 0x11, 0x04},
1010 // Block marked bad Medium error, unrecovered read error
1011 {0xFF, 0xFF, 0xFF, 0xFF}, // END mark
1013 static const unsigned char stat_table[][4] = {
1014 /* Must be first because BUSY means no other bits valid */
1015 {0x80, ABORTED_COMMAND, 0x47, 0x00},
1016 // Busy, fake parity for now
1017 {0x40, ILLEGAL_REQUEST, 0x21, 0x04},
1018 // Device ready, unaligned write command
1019 {0x20, HARDWARE_ERROR, 0x44, 0x00},
1020 // Device fault, internal target failure
1021 {0x08, ABORTED_COMMAND, 0x47, 0x00},
1022 // Timed out in xfer, fake parity for now
1023 {0x04, RECOVERED_ERROR, 0x11, 0x00},
1024 // Recovered ECC error Medium error, recovered
1025 {0xFF, 0xFF, 0xFF, 0xFF}, // END mark
1029 * Is this an error we can process/parse
1031 if (drv_stat & ATA_BUSY) {
1032 drv_err = 0; /* Ignore the err bits, they're invalid */
1035 if (drv_err) {
1036 /* Look for drv_err */
1037 for (i = 0; sense_table[i][0] != 0xFF; i++) {
1038 /* Look for best matches first */
1039 if ((sense_table[i][0] & drv_err) ==
1040 sense_table[i][0]) {
1041 *sk = sense_table[i][1];
1042 *asc = sense_table[i][2];
1043 *ascq = sense_table[i][3];
1044 goto translate_done;
1050 * Fall back to interpreting status bits. Note that if the drv_err
1051 * has only the ABRT bit set, we decode drv_stat. ABRT by itself
1052 * is not descriptive enough.
1054 for (i = 0; stat_table[i][0] != 0xFF; i++) {
1055 if (stat_table[i][0] & drv_stat) {
1056 *sk = stat_table[i][1];
1057 *asc = stat_table[i][2];
1058 *ascq = stat_table[i][3];
1059 goto translate_done;
1064 * We need a sensible error return here, which is tricky, and one
1065 * that won't cause people to do things like return a disk wrongly.
1067 *sk = ABORTED_COMMAND;
1068 *asc = 0x00;
1069 *ascq = 0x00;
1071 translate_done:
1072 if (verbose)
1073 printk(KERN_ERR "ata%u: translated ATA stat/err 0x%02x/%02x "
1074 "to SCSI SK/ASC/ASCQ 0x%x/%02x/%02x\n",
1075 id, drv_stat, drv_err, *sk, *asc, *ascq);
1076 return;
1080 * ata_gen_passthru_sense - Generate check condition sense block.
1081 * @qc: Command that completed.
1083 * This function is specific to the ATA descriptor format sense
1084 * block specified for the ATA pass through commands. Regardless
1085 * of whether the command errored or not, return a sense
1086 * block. Copy all controller registers into the sense
1087 * block. If there was no error, we get the request from an ATA
1088 * passthrough command, so we use the following sense data:
1089 * sk = RECOVERED ERROR
1090 * asc,ascq = ATA PASS-THROUGH INFORMATION AVAILABLE
1093 * LOCKING:
1094 * None.
1096 static void ata_gen_passthru_sense(struct ata_queued_cmd *qc)
1098 struct scsi_cmnd *cmd = qc->scsicmd;
1099 struct ata_taskfile *tf = &qc->result_tf;
1100 unsigned char *sb = cmd->sense_buffer;
1101 unsigned char *desc = sb + 8;
1102 int verbose = qc->ap->ops->error_handler == NULL;
1103 u8 sense_key, asc, ascq;
1105 memset(sb, 0, SCSI_SENSE_BUFFERSIZE);
1107 cmd->result = (DRIVER_SENSE << 24) | SAM_STAT_CHECK_CONDITION;
1110 * Use ata_to_sense_error() to map status register bits
1111 * onto sense key, asc & ascq.
1113 if (qc->err_mask ||
1114 tf->command & (ATA_BUSY | ATA_DF | ATA_ERR | ATA_DRQ)) {
1115 ata_to_sense_error(qc->ap->print_id, tf->command, tf->feature,
1116 &sense_key, &asc, &ascq, verbose);
1117 ata_scsi_set_sense(qc->dev, cmd, sense_key, asc, ascq);
1118 } else {
1120 * ATA PASS-THROUGH INFORMATION AVAILABLE
1121 * Always in descriptor format sense.
1123 scsi_build_sense_buffer(1, cmd->sense_buffer,
1124 RECOVERED_ERROR, 0, 0x1D);
1127 if ((cmd->sense_buffer[0] & 0x7f) >= 0x72) {
1128 u8 len;
1130 /* descriptor format */
1131 len = sb[7];
1132 desc = (char *)scsi_sense_desc_find(sb, len + 8, 9);
1133 if (!desc) {
1134 if (SCSI_SENSE_BUFFERSIZE < len + 14)
1135 return;
1136 sb[7] = len + 14;
1137 desc = sb + 8 + len;
1139 desc[0] = 9;
1140 desc[1] = 12;
1142 * Copy registers into sense buffer.
1144 desc[2] = 0x00;
1145 desc[3] = tf->feature; /* == error reg */
1146 desc[5] = tf->nsect;
1147 desc[7] = tf->lbal;
1148 desc[9] = tf->lbam;
1149 desc[11] = tf->lbah;
1150 desc[12] = tf->device;
1151 desc[13] = tf->command; /* == status reg */
1154 * Fill in Extend bit, and the high order bytes
1155 * if applicable.
1157 if (tf->flags & ATA_TFLAG_LBA48) {
1158 desc[2] |= 0x01;
1159 desc[4] = tf->hob_nsect;
1160 desc[6] = tf->hob_lbal;
1161 desc[8] = tf->hob_lbam;
1162 desc[10] = tf->hob_lbah;
1164 } else {
1165 /* Fixed sense format */
1166 desc[0] = tf->feature;
1167 desc[1] = tf->command; /* status */
1168 desc[2] = tf->device;
1169 desc[3] = tf->nsect;
1170 desc[7] = 0;
1171 if (tf->flags & ATA_TFLAG_LBA48) {
1172 desc[8] |= 0x80;
1173 if (tf->hob_nsect)
1174 desc[8] |= 0x40;
1175 if (tf->hob_lbal || tf->hob_lbam || tf->hob_lbah)
1176 desc[8] |= 0x20;
1178 desc[9] = tf->lbal;
1179 desc[10] = tf->lbam;
1180 desc[11] = tf->lbah;
1185 * ata_gen_ata_sense - generate a SCSI fixed sense block
1186 * @qc: Command that we are erroring out
1188 * Generate sense block for a failed ATA command @qc. Descriptor
1189 * format is used to accommodate LBA48 block address.
1191 * LOCKING:
1192 * None.
1194 static void ata_gen_ata_sense(struct ata_queued_cmd *qc)
1196 struct ata_device *dev = qc->dev;
1197 struct scsi_cmnd *cmd = qc->scsicmd;
1198 struct ata_taskfile *tf = &qc->result_tf;
1199 unsigned char *sb = cmd->sense_buffer;
1200 int verbose = qc->ap->ops->error_handler == NULL;
1201 u64 block;
1202 u8 sense_key, asc, ascq;
1204 memset(sb, 0, SCSI_SENSE_BUFFERSIZE);
1206 cmd->result = (DRIVER_SENSE << 24) | SAM_STAT_CHECK_CONDITION;
1208 if (ata_dev_disabled(dev)) {
1209 /* Device disabled after error recovery */
1210 /* LOGICAL UNIT NOT READY, HARD RESET REQUIRED */
1211 ata_scsi_set_sense(dev, cmd, NOT_READY, 0x04, 0x21);
1212 return;
1214 /* Use ata_to_sense_error() to map status register bits
1215 * onto sense key, asc & ascq.
1217 if (qc->err_mask ||
1218 tf->command & (ATA_BUSY | ATA_DF | ATA_ERR | ATA_DRQ)) {
1219 ata_to_sense_error(qc->ap->print_id, tf->command, tf->feature,
1220 &sense_key, &asc, &ascq, verbose);
1221 ata_scsi_set_sense(dev, cmd, sense_key, asc, ascq);
1222 } else {
1223 /* Could not decode error */
1224 ata_dev_warn(dev, "could not decode error status 0x%x err_mask 0x%x\n",
1225 tf->command, qc->err_mask);
1226 ata_scsi_set_sense(dev, cmd, ABORTED_COMMAND, 0, 0);
1227 return;
1230 block = ata_tf_read_block(&qc->result_tf, dev);
1231 if (block == U64_MAX)
1232 return;
1234 scsi_set_sense_information(sb, SCSI_SENSE_BUFFERSIZE, block);
1237 static void ata_scsi_sdev_config(struct scsi_device *sdev)
1239 sdev->use_10_for_rw = 1;
1240 sdev->use_10_for_ms = 1;
1241 sdev->no_write_same = 1;
1243 /* Schedule policy is determined by ->qc_defer() callback and
1244 * it needs to see every deferred qc. Set dev_blocked to 1 to
1245 * prevent SCSI midlayer from automatically deferring
1246 * requests.
1248 sdev->max_device_blocked = 1;
1252 * atapi_drain_needed - Check whether data transfer may overflow
1253 * @rq: request to be checked
1255 * ATAPI commands which transfer variable length data to host
1256 * might overflow due to application error or hardware bug. This
1257 * function checks whether overflow should be drained and ignored
1258 * for @request.
1260 * LOCKING:
1261 * None.
1263 * RETURNS:
1264 * 1 if ; otherwise, 0.
1266 static int atapi_drain_needed(struct request *rq)
1268 if (likely(rq->cmd_type != REQ_TYPE_BLOCK_PC))
1269 return 0;
1271 if (!blk_rq_bytes(rq) || op_is_write(req_op(rq)))
1272 return 0;
1274 return atapi_cmd_type(rq->cmd[0]) == ATAPI_MISC;
1277 static int ata_scsi_dev_config(struct scsi_device *sdev,
1278 struct ata_device *dev)
1280 struct request_queue *q = sdev->request_queue;
1282 if (!ata_id_has_unload(dev->id))
1283 dev->flags |= ATA_DFLAG_NO_UNLOAD;
1285 /* configure max sectors */
1286 blk_queue_max_hw_sectors(q, dev->max_sectors);
1288 if (dev->class == ATA_DEV_ATAPI) {
1289 void *buf;
1291 sdev->sector_size = ATA_SECT_SIZE;
1293 /* set DMA padding */
1294 blk_queue_update_dma_pad(q, ATA_DMA_PAD_SZ - 1);
1296 /* configure draining */
1297 buf = kmalloc(ATAPI_MAX_DRAIN, q->bounce_gfp | GFP_KERNEL);
1298 if (!buf) {
1299 ata_dev_err(dev, "drain buffer allocation failed\n");
1300 return -ENOMEM;
1303 blk_queue_dma_drain(q, atapi_drain_needed, buf, ATAPI_MAX_DRAIN);
1304 } else {
1305 sdev->sector_size = ata_id_logical_sector_size(dev->id);
1306 sdev->manage_start_stop = 1;
1310 * ata_pio_sectors() expects buffer for each sector to not cross
1311 * page boundary. Enforce it by requiring buffers to be sector
1312 * aligned, which works iff sector_size is not larger than
1313 * PAGE_SIZE. ATAPI devices also need the alignment as
1314 * IDENTIFY_PACKET is executed as ATA_PROT_PIO.
1316 if (sdev->sector_size > PAGE_SIZE)
1317 ata_dev_warn(dev,
1318 "sector_size=%u > PAGE_SIZE, PIO may malfunction\n",
1319 sdev->sector_size);
1321 blk_queue_update_dma_alignment(q, sdev->sector_size - 1);
1323 if (dev->flags & ATA_DFLAG_AN)
1324 set_bit(SDEV_EVT_MEDIA_CHANGE, sdev->supported_events);
1326 if (dev->flags & ATA_DFLAG_NCQ) {
1327 int depth;
1329 depth = min(sdev->host->can_queue, ata_id_queue_depth(dev->id));
1330 depth = min(ATA_MAX_QUEUE - 1, depth);
1331 scsi_change_queue_depth(sdev, depth);
1334 blk_queue_flush_queueable(q, false);
1336 dev->sdev = sdev;
1337 return 0;
1341 * ata_scsi_slave_config - Set SCSI device attributes
1342 * @sdev: SCSI device to examine
1344 * This is called before we actually start reading
1345 * and writing to the device, to configure certain
1346 * SCSI mid-layer behaviors.
1348 * LOCKING:
1349 * Defined by SCSI layer. We don't really care.
1352 int ata_scsi_slave_config(struct scsi_device *sdev)
1354 struct ata_port *ap = ata_shost_to_port(sdev->host);
1355 struct ata_device *dev = __ata_scsi_find_dev(ap, sdev);
1356 int rc = 0;
1358 ata_scsi_sdev_config(sdev);
1360 if (dev)
1361 rc = ata_scsi_dev_config(sdev, dev);
1363 return rc;
1367 * ata_scsi_slave_destroy - SCSI device is about to be destroyed
1368 * @sdev: SCSI device to be destroyed
1370 * @sdev is about to be destroyed for hot/warm unplugging. If
1371 * this unplugging was initiated by libata as indicated by NULL
1372 * dev->sdev, this function doesn't have to do anything.
1373 * Otherwise, SCSI layer initiated warm-unplug is in progress.
1374 * Clear dev->sdev, schedule the device for ATA detach and invoke
1375 * EH.
1377 * LOCKING:
1378 * Defined by SCSI layer. We don't really care.
1380 void ata_scsi_slave_destroy(struct scsi_device *sdev)
1382 struct ata_port *ap = ata_shost_to_port(sdev->host);
1383 struct request_queue *q = sdev->request_queue;
1384 unsigned long flags;
1385 struct ata_device *dev;
1387 if (!ap->ops->error_handler)
1388 return;
1390 spin_lock_irqsave(ap->lock, flags);
1391 dev = __ata_scsi_find_dev(ap, sdev);
1392 if (dev && dev->sdev) {
1393 /* SCSI device already in CANCEL state, no need to offline it */
1394 dev->sdev = NULL;
1395 dev->flags |= ATA_DFLAG_DETACH;
1396 ata_port_schedule_eh(ap);
1398 spin_unlock_irqrestore(ap->lock, flags);
1400 kfree(q->dma_drain_buffer);
1401 q->dma_drain_buffer = NULL;
1402 q->dma_drain_size = 0;
1406 * __ata_change_queue_depth - helper for ata_scsi_change_queue_depth
1407 * @ap: ATA port to which the device change the queue depth
1408 * @sdev: SCSI device to configure queue depth for
1409 * @queue_depth: new queue depth
1411 * libsas and libata have different approaches for associating a sdev to
1412 * its ata_port.
1415 int __ata_change_queue_depth(struct ata_port *ap, struct scsi_device *sdev,
1416 int queue_depth)
1418 struct ata_device *dev;
1419 unsigned long flags;
1421 if (queue_depth < 1 || queue_depth == sdev->queue_depth)
1422 return sdev->queue_depth;
1424 dev = ata_scsi_find_dev(ap, sdev);
1425 if (!dev || !ata_dev_enabled(dev))
1426 return sdev->queue_depth;
1428 /* NCQ enabled? */
1429 spin_lock_irqsave(ap->lock, flags);
1430 dev->flags &= ~ATA_DFLAG_NCQ_OFF;
1431 if (queue_depth == 1 || !ata_ncq_enabled(dev)) {
1432 dev->flags |= ATA_DFLAG_NCQ_OFF;
1433 queue_depth = 1;
1435 spin_unlock_irqrestore(ap->lock, flags);
1437 /* limit and apply queue depth */
1438 queue_depth = min(queue_depth, sdev->host->can_queue);
1439 queue_depth = min(queue_depth, ata_id_queue_depth(dev->id));
1440 queue_depth = min(queue_depth, ATA_MAX_QUEUE - 1);
1442 if (sdev->queue_depth == queue_depth)
1443 return -EINVAL;
1445 return scsi_change_queue_depth(sdev, queue_depth);
1449 * ata_scsi_change_queue_depth - SCSI callback for queue depth config
1450 * @sdev: SCSI device to configure queue depth for
1451 * @queue_depth: new queue depth
1453 * This is libata standard hostt->change_queue_depth callback.
1454 * SCSI will call into this callback when user tries to set queue
1455 * depth via sysfs.
1457 * LOCKING:
1458 * SCSI layer (we don't care)
1460 * RETURNS:
1461 * Newly configured queue depth.
1463 int ata_scsi_change_queue_depth(struct scsi_device *sdev, int queue_depth)
1465 struct ata_port *ap = ata_shost_to_port(sdev->host);
1467 return __ata_change_queue_depth(ap, sdev, queue_depth);
1471 * ata_scsi_start_stop_xlat - Translate SCSI START STOP UNIT command
1472 * @qc: Storage for translated ATA taskfile
1474 * Sets up an ATA taskfile to issue STANDBY (to stop) or READ VERIFY
1475 * (to start). Perhaps these commands should be preceded by
1476 * CHECK POWER MODE to see what power mode the device is already in.
1477 * [See SAT revision 5 at www.t10.org]
1479 * LOCKING:
1480 * spin_lock_irqsave(host lock)
1482 * RETURNS:
1483 * Zero on success, non-zero on error.
1485 static unsigned int ata_scsi_start_stop_xlat(struct ata_queued_cmd *qc)
1487 struct scsi_cmnd *scmd = qc->scsicmd;
1488 struct ata_taskfile *tf = &qc->tf;
1489 const u8 *cdb = scmd->cmnd;
1490 u16 fp;
1491 u8 bp = 0xff;
1493 if (scmd->cmd_len < 5) {
1494 fp = 4;
1495 goto invalid_fld;
1498 tf->flags |= ATA_TFLAG_DEVICE | ATA_TFLAG_ISADDR;
1499 tf->protocol = ATA_PROT_NODATA;
1500 if (cdb[1] & 0x1) {
1501 ; /* ignore IMMED bit, violates sat-r05 */
1503 if (cdb[4] & 0x2) {
1504 fp = 4;
1505 bp = 1;
1506 goto invalid_fld; /* LOEJ bit set not supported */
1508 if (((cdb[4] >> 4) & 0xf) != 0) {
1509 fp = 4;
1510 bp = 3;
1511 goto invalid_fld; /* power conditions not supported */
1514 if (cdb[4] & 0x1) {
1515 tf->nsect = 1; /* 1 sector, lba=0 */
1517 if (qc->dev->flags & ATA_DFLAG_LBA) {
1518 tf->flags |= ATA_TFLAG_LBA;
1520 tf->lbah = 0x0;
1521 tf->lbam = 0x0;
1522 tf->lbal = 0x0;
1523 tf->device |= ATA_LBA;
1524 } else {
1525 /* CHS */
1526 tf->lbal = 0x1; /* sect */
1527 tf->lbam = 0x0; /* cyl low */
1528 tf->lbah = 0x0; /* cyl high */
1531 tf->command = ATA_CMD_VERIFY; /* READ VERIFY */
1532 } else {
1533 /* Some odd clown BIOSen issue spindown on power off (ACPI S4
1534 * or S5) causing some drives to spin up and down again.
1536 if ((qc->ap->flags & ATA_FLAG_NO_POWEROFF_SPINDOWN) &&
1537 system_state == SYSTEM_POWER_OFF)
1538 goto skip;
1540 if ((qc->ap->flags & ATA_FLAG_NO_HIBERNATE_SPINDOWN) &&
1541 system_entering_hibernation())
1542 goto skip;
1544 /* Issue ATA STANDBY IMMEDIATE command */
1545 tf->command = ATA_CMD_STANDBYNOW1;
1549 * Standby and Idle condition timers could be implemented but that
1550 * would require libata to implement the Power condition mode page
1551 * and allow the user to change it. Changing mode pages requires
1552 * MODE SELECT to be implemented.
1555 return 0;
1557 invalid_fld:
1558 ata_scsi_set_invalid_field(qc->dev, scmd, fp, bp);
1559 return 1;
1560 skip:
1561 scmd->result = SAM_STAT_GOOD;
1562 return 1;
1567 * ata_scsi_flush_xlat - Translate SCSI SYNCHRONIZE CACHE command
1568 * @qc: Storage for translated ATA taskfile
1570 * Sets up an ATA taskfile to issue FLUSH CACHE or
1571 * FLUSH CACHE EXT.
1573 * LOCKING:
1574 * spin_lock_irqsave(host lock)
1576 * RETURNS:
1577 * Zero on success, non-zero on error.
1579 static unsigned int ata_scsi_flush_xlat(struct ata_queued_cmd *qc)
1581 struct ata_taskfile *tf = &qc->tf;
1583 tf->flags |= ATA_TFLAG_DEVICE;
1584 tf->protocol = ATA_PROT_NODATA;
1586 if (qc->dev->flags & ATA_DFLAG_FLUSH_EXT)
1587 tf->command = ATA_CMD_FLUSH_EXT;
1588 else
1589 tf->command = ATA_CMD_FLUSH;
1591 /* flush is critical for IO integrity, consider it an IO command */
1592 qc->flags |= ATA_QCFLAG_IO;
1594 return 0;
1598 * scsi_6_lba_len - Get LBA and transfer length
1599 * @cdb: SCSI command to translate
1601 * Calculate LBA and transfer length for 6-byte commands.
1603 * RETURNS:
1604 * @plba: the LBA
1605 * @plen: the transfer length
1607 static void scsi_6_lba_len(const u8 *cdb, u64 *plba, u32 *plen)
1609 u64 lba = 0;
1610 u32 len;
1612 VPRINTK("six-byte command\n");
1614 lba |= ((u64)(cdb[1] & 0x1f)) << 16;
1615 lba |= ((u64)cdb[2]) << 8;
1616 lba |= ((u64)cdb[3]);
1618 len = cdb[4];
1620 *plba = lba;
1621 *plen = len;
1625 * scsi_10_lba_len - Get LBA and transfer length
1626 * @cdb: SCSI command to translate
1628 * Calculate LBA and transfer length for 10-byte commands.
1630 * RETURNS:
1631 * @plba: the LBA
1632 * @plen: the transfer length
1634 static void scsi_10_lba_len(const u8 *cdb, u64 *plba, u32 *plen)
1636 u64 lba = 0;
1637 u32 len = 0;
1639 VPRINTK("ten-byte command\n");
1641 lba |= ((u64)cdb[2]) << 24;
1642 lba |= ((u64)cdb[3]) << 16;
1643 lba |= ((u64)cdb[4]) << 8;
1644 lba |= ((u64)cdb[5]);
1646 len |= ((u32)cdb[7]) << 8;
1647 len |= ((u32)cdb[8]);
1649 *plba = lba;
1650 *plen = len;
1654 * scsi_16_lba_len - Get LBA and transfer length
1655 * @cdb: SCSI command to translate
1657 * Calculate LBA and transfer length for 16-byte commands.
1659 * RETURNS:
1660 * @plba: the LBA
1661 * @plen: the transfer length
1663 static void scsi_16_lba_len(const u8 *cdb, u64 *plba, u32 *plen)
1665 u64 lba = 0;
1666 u32 len = 0;
1668 VPRINTK("sixteen-byte command\n");
1670 lba |= ((u64)cdb[2]) << 56;
1671 lba |= ((u64)cdb[3]) << 48;
1672 lba |= ((u64)cdb[4]) << 40;
1673 lba |= ((u64)cdb[5]) << 32;
1674 lba |= ((u64)cdb[6]) << 24;
1675 lba |= ((u64)cdb[7]) << 16;
1676 lba |= ((u64)cdb[8]) << 8;
1677 lba |= ((u64)cdb[9]);
1679 len |= ((u32)cdb[10]) << 24;
1680 len |= ((u32)cdb[11]) << 16;
1681 len |= ((u32)cdb[12]) << 8;
1682 len |= ((u32)cdb[13]);
1684 *plba = lba;
1685 *plen = len;
1689 * ata_scsi_verify_xlat - Translate SCSI VERIFY command into an ATA one
1690 * @qc: Storage for translated ATA taskfile
1692 * Converts SCSI VERIFY command to an ATA READ VERIFY command.
1694 * LOCKING:
1695 * spin_lock_irqsave(host lock)
1697 * RETURNS:
1698 * Zero on success, non-zero on error.
1700 static unsigned int ata_scsi_verify_xlat(struct ata_queued_cmd *qc)
1702 struct scsi_cmnd *scmd = qc->scsicmd;
1703 struct ata_taskfile *tf = &qc->tf;
1704 struct ata_device *dev = qc->dev;
1705 u64 dev_sectors = qc->dev->n_sectors;
1706 const u8 *cdb = scmd->cmnd;
1707 u64 block;
1708 u32 n_block;
1709 u16 fp;
1711 tf->flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
1712 tf->protocol = ATA_PROT_NODATA;
1714 if (cdb[0] == VERIFY) {
1715 if (scmd->cmd_len < 10) {
1716 fp = 9;
1717 goto invalid_fld;
1719 scsi_10_lba_len(cdb, &block, &n_block);
1720 } else if (cdb[0] == VERIFY_16) {
1721 if (scmd->cmd_len < 16) {
1722 fp = 15;
1723 goto invalid_fld;
1725 scsi_16_lba_len(cdb, &block, &n_block);
1726 } else {
1727 fp = 0;
1728 goto invalid_fld;
1731 if (!n_block)
1732 goto nothing_to_do;
1733 if (block >= dev_sectors)
1734 goto out_of_range;
1735 if ((block + n_block) > dev_sectors)
1736 goto out_of_range;
1738 if (dev->flags & ATA_DFLAG_LBA) {
1739 tf->flags |= ATA_TFLAG_LBA;
1741 if (lba_28_ok(block, n_block)) {
1742 /* use LBA28 */
1743 tf->command = ATA_CMD_VERIFY;
1744 tf->device |= (block >> 24) & 0xf;
1745 } else if (lba_48_ok(block, n_block)) {
1746 if (!(dev->flags & ATA_DFLAG_LBA48))
1747 goto out_of_range;
1749 /* use LBA48 */
1750 tf->flags |= ATA_TFLAG_LBA48;
1751 tf->command = ATA_CMD_VERIFY_EXT;
1753 tf->hob_nsect = (n_block >> 8) & 0xff;
1755 tf->hob_lbah = (block >> 40) & 0xff;
1756 tf->hob_lbam = (block >> 32) & 0xff;
1757 tf->hob_lbal = (block >> 24) & 0xff;
1758 } else
1759 /* request too large even for LBA48 */
1760 goto out_of_range;
1762 tf->nsect = n_block & 0xff;
1764 tf->lbah = (block >> 16) & 0xff;
1765 tf->lbam = (block >> 8) & 0xff;
1766 tf->lbal = block & 0xff;
1768 tf->device |= ATA_LBA;
1769 } else {
1770 /* CHS */
1771 u32 sect, head, cyl, track;
1773 if (!lba_28_ok(block, n_block))
1774 goto out_of_range;
1776 /* Convert LBA to CHS */
1777 track = (u32)block / dev->sectors;
1778 cyl = track / dev->heads;
1779 head = track % dev->heads;
1780 sect = (u32)block % dev->sectors + 1;
1782 DPRINTK("block %u track %u cyl %u head %u sect %u\n",
1783 (u32)block, track, cyl, head, sect);
1785 /* Check whether the converted CHS can fit.
1786 Cylinder: 0-65535
1787 Head: 0-15
1788 Sector: 1-255*/
1789 if ((cyl >> 16) || (head >> 4) || (sect >> 8) || (!sect))
1790 goto out_of_range;
1792 tf->command = ATA_CMD_VERIFY;
1793 tf->nsect = n_block & 0xff; /* Sector count 0 means 256 sectors */
1794 tf->lbal = sect;
1795 tf->lbam = cyl;
1796 tf->lbah = cyl >> 8;
1797 tf->device |= head;
1800 return 0;
1802 invalid_fld:
1803 ata_scsi_set_invalid_field(qc->dev, scmd, fp, 0xff);
1804 return 1;
1806 out_of_range:
1807 ata_scsi_set_sense(qc->dev, scmd, ILLEGAL_REQUEST, 0x21, 0x0);
1808 /* "Logical Block Address out of range" */
1809 return 1;
1811 nothing_to_do:
1812 scmd->result = SAM_STAT_GOOD;
1813 return 1;
1817 * ata_scsi_rw_xlat - Translate SCSI r/w command into an ATA one
1818 * @qc: Storage for translated ATA taskfile
1820 * Converts any of six SCSI read/write commands into the
1821 * ATA counterpart, including starting sector (LBA),
1822 * sector count, and taking into account the device's LBA48
1823 * support.
1825 * Commands %READ_6, %READ_10, %READ_16, %WRITE_6, %WRITE_10, and
1826 * %WRITE_16 are currently supported.
1828 * LOCKING:
1829 * spin_lock_irqsave(host lock)
1831 * RETURNS:
1832 * Zero on success, non-zero on error.
1834 static unsigned int ata_scsi_rw_xlat(struct ata_queued_cmd *qc)
1836 struct scsi_cmnd *scmd = qc->scsicmd;
1837 const u8 *cdb = scmd->cmnd;
1838 struct request *rq = scmd->request;
1839 int class = IOPRIO_PRIO_CLASS(req_get_ioprio(rq));
1840 unsigned int tf_flags = 0;
1841 u64 block;
1842 u32 n_block;
1843 int rc;
1844 u16 fp = 0;
1846 if (cdb[0] == WRITE_10 || cdb[0] == WRITE_6 || cdb[0] == WRITE_16)
1847 tf_flags |= ATA_TFLAG_WRITE;
1849 /* Calculate the SCSI LBA, transfer length and FUA. */
1850 switch (cdb[0]) {
1851 case READ_10:
1852 case WRITE_10:
1853 if (unlikely(scmd->cmd_len < 10)) {
1854 fp = 9;
1855 goto invalid_fld;
1857 scsi_10_lba_len(cdb, &block, &n_block);
1858 if (cdb[1] & (1 << 3))
1859 tf_flags |= ATA_TFLAG_FUA;
1860 break;
1861 case READ_6:
1862 case WRITE_6:
1863 if (unlikely(scmd->cmd_len < 6)) {
1864 fp = 5;
1865 goto invalid_fld;
1867 scsi_6_lba_len(cdb, &block, &n_block);
1869 /* for 6-byte r/w commands, transfer length 0
1870 * means 256 blocks of data, not 0 block.
1872 if (!n_block)
1873 n_block = 256;
1874 break;
1875 case READ_16:
1876 case WRITE_16:
1877 if (unlikely(scmd->cmd_len < 16)) {
1878 fp = 15;
1879 goto invalid_fld;
1881 scsi_16_lba_len(cdb, &block, &n_block);
1882 if (cdb[1] & (1 << 3))
1883 tf_flags |= ATA_TFLAG_FUA;
1884 break;
1885 default:
1886 DPRINTK("no-byte command\n");
1887 fp = 0;
1888 goto invalid_fld;
1891 /* Check and compose ATA command */
1892 if (!n_block)
1893 /* For 10-byte and 16-byte SCSI R/W commands, transfer
1894 * length 0 means transfer 0 block of data.
1895 * However, for ATA R/W commands, sector count 0 means
1896 * 256 or 65536 sectors, not 0 sectors as in SCSI.
1898 * WARNING: one or two older ATA drives treat 0 as 0...
1900 goto nothing_to_do;
1902 qc->flags |= ATA_QCFLAG_IO;
1903 qc->nbytes = n_block * scmd->device->sector_size;
1905 rc = ata_build_rw_tf(&qc->tf, qc->dev, block, n_block, tf_flags,
1906 qc->tag, class);
1908 if (likely(rc == 0))
1909 return 0;
1911 if (rc == -ERANGE)
1912 goto out_of_range;
1913 /* treat all other errors as -EINVAL, fall through */
1914 invalid_fld:
1915 ata_scsi_set_invalid_field(qc->dev, scmd, fp, 0xff);
1916 return 1;
1918 out_of_range:
1919 ata_scsi_set_sense(qc->dev, scmd, ILLEGAL_REQUEST, 0x21, 0x0);
1920 /* "Logical Block Address out of range" */
1921 return 1;
1923 nothing_to_do:
1924 scmd->result = SAM_STAT_GOOD;
1925 return 1;
1928 static void ata_qc_done(struct ata_queued_cmd *qc)
1930 struct scsi_cmnd *cmd = qc->scsicmd;
1931 void (*done)(struct scsi_cmnd *) = qc->scsidone;
1933 ata_qc_free(qc);
1934 done(cmd);
1937 static void ata_scsi_qc_complete(struct ata_queued_cmd *qc)
1939 struct ata_port *ap = qc->ap;
1940 struct scsi_cmnd *cmd = qc->scsicmd;
1941 u8 *cdb = cmd->cmnd;
1942 int need_sense = (qc->err_mask != 0);
1944 /* For ATA pass thru (SAT) commands, generate a sense block if
1945 * user mandated it or if there's an error. Note that if we
1946 * generate because the user forced us to [CK_COND =1], a check
1947 * condition is generated and the ATA register values are returned
1948 * whether the command completed successfully or not. If there
1949 * was no error, we use the following sense data:
1950 * sk = RECOVERED ERROR
1951 * asc,ascq = ATA PASS-THROUGH INFORMATION AVAILABLE
1953 if (((cdb[0] == ATA_16) || (cdb[0] == ATA_12)) &&
1954 ((cdb[2] & 0x20) || need_sense))
1955 ata_gen_passthru_sense(qc);
1956 else if (qc->flags & ATA_QCFLAG_SENSE_VALID)
1957 cmd->result = SAM_STAT_CHECK_CONDITION;
1958 else if (need_sense)
1959 ata_gen_ata_sense(qc);
1960 else
1961 cmd->result = SAM_STAT_GOOD;
1963 if (need_sense && !ap->ops->error_handler)
1964 ata_dump_status(ap->print_id, &qc->result_tf);
1966 ata_qc_done(qc);
1970 * ata_scsi_translate - Translate then issue SCSI command to ATA device
1971 * @dev: ATA device to which the command is addressed
1972 * @cmd: SCSI command to execute
1973 * @xlat_func: Actor which translates @cmd to an ATA taskfile
1975 * Our ->queuecommand() function has decided that the SCSI
1976 * command issued can be directly translated into an ATA
1977 * command, rather than handled internally.
1979 * This function sets up an ata_queued_cmd structure for the
1980 * SCSI command, and sends that ata_queued_cmd to the hardware.
1982 * The xlat_func argument (actor) returns 0 if ready to execute
1983 * ATA command, else 1 to finish translation. If 1 is returned
1984 * then cmd->result (and possibly cmd->sense_buffer) are assumed
1985 * to be set reflecting an error condition or clean (early)
1986 * termination.
1988 * LOCKING:
1989 * spin_lock_irqsave(host lock)
1991 * RETURNS:
1992 * 0 on success, SCSI_ML_QUEUE_DEVICE_BUSY if the command
1993 * needs to be deferred.
1995 static int ata_scsi_translate(struct ata_device *dev, struct scsi_cmnd *cmd,
1996 ata_xlat_func_t xlat_func)
1998 struct ata_port *ap = dev->link->ap;
1999 struct ata_queued_cmd *qc;
2000 int rc;
2002 VPRINTK("ENTER\n");
2004 qc = ata_scsi_qc_new(dev, cmd);
2005 if (!qc)
2006 goto err_mem;
2008 /* data is present; dma-map it */
2009 if (cmd->sc_data_direction == DMA_FROM_DEVICE ||
2010 cmd->sc_data_direction == DMA_TO_DEVICE) {
2011 if (unlikely(scsi_bufflen(cmd) < 1)) {
2012 ata_dev_warn(dev, "WARNING: zero len r/w req\n");
2013 goto err_did;
2016 ata_sg_init(qc, scsi_sglist(cmd), scsi_sg_count(cmd));
2018 qc->dma_dir = cmd->sc_data_direction;
2021 qc->complete_fn = ata_scsi_qc_complete;
2023 if (xlat_func(qc))
2024 goto early_finish;
2026 if (ap->ops->qc_defer) {
2027 if ((rc = ap->ops->qc_defer(qc)))
2028 goto defer;
2031 /* select device, send command to hardware */
2032 ata_qc_issue(qc);
2034 VPRINTK("EXIT\n");
2035 return 0;
2037 early_finish:
2038 ata_qc_free(qc);
2039 cmd->scsi_done(cmd);
2040 DPRINTK("EXIT - early finish (good or error)\n");
2041 return 0;
2043 err_did:
2044 ata_qc_free(qc);
2045 cmd->result = (DID_ERROR << 16);
2046 cmd->scsi_done(cmd);
2047 err_mem:
2048 DPRINTK("EXIT - internal\n");
2049 return 0;
2051 defer:
2052 ata_qc_free(qc);
2053 DPRINTK("EXIT - defer\n");
2054 if (rc == ATA_DEFER_LINK)
2055 return SCSI_MLQUEUE_DEVICE_BUSY;
2056 else
2057 return SCSI_MLQUEUE_HOST_BUSY;
2061 * ata_scsi_rbuf_get - Map response buffer.
2062 * @cmd: SCSI command containing buffer to be mapped.
2063 * @flags: unsigned long variable to store irq enable status
2064 * @copy_in: copy in from user buffer
2066 * Prepare buffer for simulated SCSI commands.
2068 * LOCKING:
2069 * spin_lock_irqsave(ata_scsi_rbuf_lock) on success
2071 * RETURNS:
2072 * Pointer to response buffer.
2074 static void *ata_scsi_rbuf_get(struct scsi_cmnd *cmd, bool copy_in,
2075 unsigned long *flags)
2077 spin_lock_irqsave(&ata_scsi_rbuf_lock, *flags);
2079 memset(ata_scsi_rbuf, 0, ATA_SCSI_RBUF_SIZE);
2080 if (copy_in)
2081 sg_copy_to_buffer(scsi_sglist(cmd), scsi_sg_count(cmd),
2082 ata_scsi_rbuf, ATA_SCSI_RBUF_SIZE);
2083 return ata_scsi_rbuf;
2087 * ata_scsi_rbuf_put - Unmap response buffer.
2088 * @cmd: SCSI command containing buffer to be unmapped.
2089 * @copy_out: copy out result
2090 * @flags: @flags passed to ata_scsi_rbuf_get()
2092 * Returns rbuf buffer. The result is copied to @cmd's buffer if
2093 * @copy_back is true.
2095 * LOCKING:
2096 * Unlocks ata_scsi_rbuf_lock.
2098 static inline void ata_scsi_rbuf_put(struct scsi_cmnd *cmd, bool copy_out,
2099 unsigned long *flags)
2101 if (copy_out)
2102 sg_copy_from_buffer(scsi_sglist(cmd), scsi_sg_count(cmd),
2103 ata_scsi_rbuf, ATA_SCSI_RBUF_SIZE);
2104 spin_unlock_irqrestore(&ata_scsi_rbuf_lock, *flags);
2108 * ata_scsi_rbuf_fill - wrapper for SCSI command simulators
2109 * @args: device IDENTIFY data / SCSI command of interest.
2110 * @actor: Callback hook for desired SCSI command simulator
2112 * Takes care of the hard work of simulating a SCSI command...
2113 * Mapping the response buffer, calling the command's handler,
2114 * and handling the handler's return value. This return value
2115 * indicates whether the handler wishes the SCSI command to be
2116 * completed successfully (0), or not (in which case cmd->result
2117 * and sense buffer are assumed to be set).
2119 * LOCKING:
2120 * spin_lock_irqsave(host lock)
2122 static void ata_scsi_rbuf_fill(struct ata_scsi_args *args,
2123 unsigned int (*actor)(struct ata_scsi_args *args, u8 *rbuf))
2125 u8 *rbuf;
2126 unsigned int rc;
2127 struct scsi_cmnd *cmd = args->cmd;
2128 unsigned long flags;
2130 rbuf = ata_scsi_rbuf_get(cmd, false, &flags);
2131 rc = actor(args, rbuf);
2132 ata_scsi_rbuf_put(cmd, rc == 0, &flags);
2134 if (rc == 0)
2135 cmd->result = SAM_STAT_GOOD;
2136 args->done(cmd);
2140 * ata_scsiop_inq_std - Simulate INQUIRY command
2141 * @args: device IDENTIFY data / SCSI command of interest.
2142 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2144 * Returns standard device identification data associated
2145 * with non-VPD INQUIRY command output.
2147 * LOCKING:
2148 * spin_lock_irqsave(host lock)
2150 static unsigned int ata_scsiop_inq_std(struct ata_scsi_args *args, u8 *rbuf)
2152 const u8 versions[] = {
2153 0x00,
2154 0x60, /* SAM-3 (no version claimed) */
2156 0x03,
2157 0x20, /* SBC-2 (no version claimed) */
2159 0x03,
2160 0x00 /* SPC-3 (no version claimed) */
2162 const u8 versions_zbc[] = {
2163 0x00,
2164 0xA0, /* SAM-5 (no version claimed) */
2166 0x06,
2167 0x00, /* SBC-4 (no version claimed) */
2169 0x05,
2170 0xC0, /* SPC-5 (no version claimed) */
2172 0x60,
2173 0x24, /* ZBC r05 */
2176 u8 hdr[] = {
2177 TYPE_DISK,
2179 0x5, /* claim SPC-3 version compatibility */
2181 95 - 4,
2187 VPRINTK("ENTER\n");
2189 /* set scsi removable (RMB) bit per ata bit, or if the
2190 * AHCI port says it's external (Hotplug-capable, eSATA).
2192 if (ata_id_removable(args->id) ||
2193 (args->dev->link->ap->pflags & ATA_PFLAG_EXTERNAL))
2194 hdr[1] |= (1 << 7);
2196 if (args->dev->class == ATA_DEV_ZAC) {
2197 hdr[0] = TYPE_ZBC;
2198 hdr[2] = 0x7; /* claim SPC-5 version compatibility */
2201 memcpy(rbuf, hdr, sizeof(hdr));
2202 memcpy(&rbuf[8], "ATA ", 8);
2203 ata_id_string(args->id, &rbuf[16], ATA_ID_PROD, 16);
2205 /* From SAT, use last 2 words from fw rev unless they are spaces */
2206 ata_id_string(args->id, &rbuf[32], ATA_ID_FW_REV + 2, 4);
2207 if (strncmp(&rbuf[32], " ", 4) == 0)
2208 ata_id_string(args->id, &rbuf[32], ATA_ID_FW_REV, 4);
2210 if (rbuf[32] == 0 || rbuf[32] == ' ')
2211 memcpy(&rbuf[32], "n/a ", 4);
2213 if (ata_id_zoned_cap(args->id) || args->dev->class == ATA_DEV_ZAC)
2214 memcpy(rbuf + 58, versions_zbc, sizeof(versions_zbc));
2215 else
2216 memcpy(rbuf + 58, versions, sizeof(versions));
2218 return 0;
2222 * ata_scsiop_inq_00 - Simulate INQUIRY VPD page 0, list of pages
2223 * @args: device IDENTIFY data / SCSI command of interest.
2224 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2226 * Returns list of inquiry VPD pages available.
2228 * LOCKING:
2229 * spin_lock_irqsave(host lock)
2231 static unsigned int ata_scsiop_inq_00(struct ata_scsi_args *args, u8 *rbuf)
2233 int num_pages;
2234 const u8 pages[] = {
2235 0x00, /* page 0x00, this page */
2236 0x80, /* page 0x80, unit serial no page */
2237 0x83, /* page 0x83, device ident page */
2238 0x89, /* page 0x89, ata info page */
2239 0xb0, /* page 0xb0, block limits page */
2240 0xb1, /* page 0xb1, block device characteristics page */
2241 0xb2, /* page 0xb2, thin provisioning page */
2242 0xb6, /* page 0xb6, zoned block device characteristics */
2245 num_pages = sizeof(pages);
2246 if (!(args->dev->flags & ATA_DFLAG_ZAC))
2247 num_pages--;
2248 rbuf[3] = num_pages; /* number of supported VPD pages */
2249 memcpy(rbuf + 4, pages, num_pages);
2250 return 0;
2254 * ata_scsiop_inq_80 - Simulate INQUIRY VPD page 80, device serial number
2255 * @args: device IDENTIFY data / SCSI command of interest.
2256 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2258 * Returns ATA device serial number.
2260 * LOCKING:
2261 * spin_lock_irqsave(host lock)
2263 static unsigned int ata_scsiop_inq_80(struct ata_scsi_args *args, u8 *rbuf)
2265 const u8 hdr[] = {
2267 0x80, /* this page code */
2269 ATA_ID_SERNO_LEN, /* page len */
2272 memcpy(rbuf, hdr, sizeof(hdr));
2273 ata_id_string(args->id, (unsigned char *) &rbuf[4],
2274 ATA_ID_SERNO, ATA_ID_SERNO_LEN);
2275 return 0;
2279 * ata_scsiop_inq_83 - Simulate INQUIRY VPD page 83, device identity
2280 * @args: device IDENTIFY data / SCSI command of interest.
2281 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2283 * Yields two logical unit device identification designators:
2284 * - vendor specific ASCII containing the ATA serial number
2285 * - SAT defined "t10 vendor id based" containing ASCII vendor
2286 * name ("ATA "), model and serial numbers.
2288 * LOCKING:
2289 * spin_lock_irqsave(host lock)
2291 static unsigned int ata_scsiop_inq_83(struct ata_scsi_args *args, u8 *rbuf)
2293 const int sat_model_serial_desc_len = 68;
2294 int num;
2296 rbuf[1] = 0x83; /* this page code */
2297 num = 4;
2299 /* piv=0, assoc=lu, code_set=ACSII, designator=vendor */
2300 rbuf[num + 0] = 2;
2301 rbuf[num + 3] = ATA_ID_SERNO_LEN;
2302 num += 4;
2303 ata_id_string(args->id, (unsigned char *) rbuf + num,
2304 ATA_ID_SERNO, ATA_ID_SERNO_LEN);
2305 num += ATA_ID_SERNO_LEN;
2307 /* SAT defined lu model and serial numbers descriptor */
2308 /* piv=0, assoc=lu, code_set=ACSII, designator=t10 vendor id */
2309 rbuf[num + 0] = 2;
2310 rbuf[num + 1] = 1;
2311 rbuf[num + 3] = sat_model_serial_desc_len;
2312 num += 4;
2313 memcpy(rbuf + num, "ATA ", 8);
2314 num += 8;
2315 ata_id_string(args->id, (unsigned char *) rbuf + num, ATA_ID_PROD,
2316 ATA_ID_PROD_LEN);
2317 num += ATA_ID_PROD_LEN;
2318 ata_id_string(args->id, (unsigned char *) rbuf + num, ATA_ID_SERNO,
2319 ATA_ID_SERNO_LEN);
2320 num += ATA_ID_SERNO_LEN;
2322 if (ata_id_has_wwn(args->id)) {
2323 /* SAT defined lu world wide name */
2324 /* piv=0, assoc=lu, code_set=binary, designator=NAA */
2325 rbuf[num + 0] = 1;
2326 rbuf[num + 1] = 3;
2327 rbuf[num + 3] = ATA_ID_WWN_LEN;
2328 num += 4;
2329 ata_id_string(args->id, (unsigned char *) rbuf + num,
2330 ATA_ID_WWN, ATA_ID_WWN_LEN);
2331 num += ATA_ID_WWN_LEN;
2333 rbuf[3] = num - 4; /* page len (assume less than 256 bytes) */
2334 return 0;
2338 * ata_scsiop_inq_89 - Simulate INQUIRY VPD page 89, ATA info
2339 * @args: device IDENTIFY data / SCSI command of interest.
2340 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2342 * Yields SAT-specified ATA VPD page.
2344 * LOCKING:
2345 * spin_lock_irqsave(host lock)
2347 static unsigned int ata_scsiop_inq_89(struct ata_scsi_args *args, u8 *rbuf)
2349 struct ata_taskfile tf;
2351 memset(&tf, 0, sizeof(tf));
2353 rbuf[1] = 0x89; /* our page code */
2354 rbuf[2] = (0x238 >> 8); /* page size fixed at 238h */
2355 rbuf[3] = (0x238 & 0xff);
2357 memcpy(&rbuf[8], "linux ", 8);
2358 memcpy(&rbuf[16], "libata ", 16);
2359 memcpy(&rbuf[32], DRV_VERSION, 4);
2361 /* we don't store the ATA device signature, so we fake it */
2363 tf.command = ATA_DRDY; /* really, this is Status reg */
2364 tf.lbal = 0x1;
2365 tf.nsect = 0x1;
2367 ata_tf_to_fis(&tf, 0, 1, &rbuf[36]); /* TODO: PMP? */
2368 rbuf[36] = 0x34; /* force D2H Reg FIS (34h) */
2370 rbuf[56] = ATA_CMD_ID_ATA;
2372 memcpy(&rbuf[60], &args->id[0], 512);
2373 return 0;
2376 static unsigned int ata_scsiop_inq_b0(struct ata_scsi_args *args, u8 *rbuf)
2378 u16 min_io_sectors;
2380 rbuf[1] = 0xb0;
2381 rbuf[3] = 0x3c; /* required VPD size with unmap support */
2384 * Optimal transfer length granularity.
2386 * This is always one physical block, but for disks with a smaller
2387 * logical than physical sector size we need to figure out what the
2388 * latter is.
2390 min_io_sectors = 1 << ata_id_log2_per_physical_sector(args->id);
2391 put_unaligned_be16(min_io_sectors, &rbuf[6]);
2394 * Optimal unmap granularity.
2396 * The ATA spec doesn't even know about a granularity or alignment
2397 * for the TRIM command. We can leave away most of the unmap related
2398 * VPD page entries, but we have specifify a granularity to signal
2399 * that we support some form of unmap - in thise case via WRITE SAME
2400 * with the unmap bit set.
2402 if (ata_id_has_trim(args->id)) {
2403 put_unaligned_be64(65535 * ATA_MAX_TRIM_RNUM, &rbuf[36]);
2404 put_unaligned_be32(1, &rbuf[28]);
2407 return 0;
2410 static unsigned int ata_scsiop_inq_b1(struct ata_scsi_args *args, u8 *rbuf)
2412 int form_factor = ata_id_form_factor(args->id);
2413 int media_rotation_rate = ata_id_rotation_rate(args->id);
2414 u8 zoned = ata_id_zoned_cap(args->id);
2416 rbuf[1] = 0xb1;
2417 rbuf[3] = 0x3c;
2418 rbuf[4] = media_rotation_rate >> 8;
2419 rbuf[5] = media_rotation_rate;
2420 rbuf[7] = form_factor;
2421 if (zoned)
2422 rbuf[8] = (zoned << 4);
2424 return 0;
2427 static unsigned int ata_scsiop_inq_b2(struct ata_scsi_args *args, u8 *rbuf)
2429 /* SCSI Thin Provisioning VPD page: SBC-3 rev 22 or later */
2430 rbuf[1] = 0xb2;
2431 rbuf[3] = 0x4;
2432 rbuf[5] = 1 << 6; /* TPWS */
2434 return 0;
2437 static unsigned int ata_scsiop_inq_b6(struct ata_scsi_args *args, u8 *rbuf)
2440 * zbc-r05 SCSI Zoned Block device characteristics VPD page
2442 rbuf[1] = 0xb6;
2443 rbuf[3] = 0x3C;
2446 * URSWRZ bit is only meaningful for host-managed ZAC drives
2448 if (args->dev->zac_zoned_cap & 1)
2449 rbuf[4] |= 1;
2450 put_unaligned_be32(args->dev->zac_zones_optimal_open, &rbuf[8]);
2451 put_unaligned_be32(args->dev->zac_zones_optimal_nonseq, &rbuf[12]);
2452 put_unaligned_be32(args->dev->zac_zones_max_open, &rbuf[16]);
2454 return 0;
2458 * ata_scsiop_noop - Command handler that simply returns success.
2459 * @args: device IDENTIFY data / SCSI command of interest.
2460 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2462 * No operation. Simply returns success to caller, to indicate
2463 * that the caller should successfully complete this SCSI command.
2465 * LOCKING:
2466 * spin_lock_irqsave(host lock)
2468 static unsigned int ata_scsiop_noop(struct ata_scsi_args *args, u8 *rbuf)
2470 VPRINTK("ENTER\n");
2471 return 0;
2475 * modecpy - Prepare response for MODE SENSE
2476 * @dest: output buffer
2477 * @src: data being copied
2478 * @n: length of mode page
2479 * @changeable: whether changeable parameters are requested
2481 * Generate a generic MODE SENSE page for either current or changeable
2482 * parameters.
2484 * LOCKING:
2485 * None.
2487 static void modecpy(u8 *dest, const u8 *src, int n, bool changeable)
2489 if (changeable) {
2490 memcpy(dest, src, 2);
2491 memset(dest + 2, 0, n - 2);
2492 } else {
2493 memcpy(dest, src, n);
2498 * ata_msense_caching - Simulate MODE SENSE caching info page
2499 * @id: device IDENTIFY data
2500 * @buf: output buffer
2501 * @changeable: whether changeable parameters are requested
2503 * Generate a caching info page, which conditionally indicates
2504 * write caching to the SCSI layer, depending on device
2505 * capabilities.
2507 * LOCKING:
2508 * None.
2510 static unsigned int ata_msense_caching(u16 *id, u8 *buf, bool changeable)
2512 modecpy(buf, def_cache_mpage, sizeof(def_cache_mpage), changeable);
2513 if (changeable) {
2514 buf[2] |= (1 << 2); /* ata_mselect_caching() */
2515 } else {
2516 buf[2] |= (ata_id_wcache_enabled(id) << 2); /* write cache enable */
2517 buf[12] |= (!ata_id_rahead_enabled(id) << 5); /* disable read ahead */
2519 return sizeof(def_cache_mpage);
2523 * ata_msense_control - Simulate MODE SENSE control mode page
2524 * @dev: ATA device of interest
2525 * @buf: output buffer
2526 * @changeable: whether changeable parameters are requested
2528 * Generate a generic MODE SENSE control mode page.
2530 * LOCKING:
2531 * None.
2533 static unsigned int ata_msense_control(struct ata_device *dev, u8 *buf,
2534 bool changeable)
2536 modecpy(buf, def_control_mpage, sizeof(def_control_mpage), changeable);
2537 if (changeable) {
2538 buf[2] |= (1 << 2); /* ata_mselect_control() */
2539 } else {
2540 bool d_sense = (dev->flags & ATA_DFLAG_D_SENSE);
2542 buf[2] |= (d_sense << 2); /* descriptor format sense data */
2544 return sizeof(def_control_mpage);
2548 * ata_msense_rw_recovery - Simulate MODE SENSE r/w error recovery page
2549 * @buf: output buffer
2550 * @changeable: whether changeable parameters are requested
2552 * Generate a generic MODE SENSE r/w error recovery page.
2554 * LOCKING:
2555 * None.
2557 static unsigned int ata_msense_rw_recovery(u8 *buf, bool changeable)
2559 modecpy(buf, def_rw_recovery_mpage, sizeof(def_rw_recovery_mpage),
2560 changeable);
2561 return sizeof(def_rw_recovery_mpage);
2565 * We can turn this into a real blacklist if it's needed, for now just
2566 * blacklist any Maxtor BANC1G10 revision firmware
2568 static int ata_dev_supports_fua(u16 *id)
2570 unsigned char model[ATA_ID_PROD_LEN + 1], fw[ATA_ID_FW_REV_LEN + 1];
2572 if (!libata_fua)
2573 return 0;
2574 if (!ata_id_has_fua(id))
2575 return 0;
2577 ata_id_c_string(id, model, ATA_ID_PROD, sizeof(model));
2578 ata_id_c_string(id, fw, ATA_ID_FW_REV, sizeof(fw));
2580 if (strcmp(model, "Maxtor"))
2581 return 1;
2582 if (strcmp(fw, "BANC1G10"))
2583 return 1;
2585 return 0; /* blacklisted */
2589 * ata_scsiop_mode_sense - Simulate MODE SENSE 6, 10 commands
2590 * @args: device IDENTIFY data / SCSI command of interest.
2591 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2593 * Simulate MODE SENSE commands. Assume this is invoked for direct
2594 * access devices (e.g. disks) only. There should be no block
2595 * descriptor for other device types.
2597 * LOCKING:
2598 * spin_lock_irqsave(host lock)
2600 static unsigned int ata_scsiop_mode_sense(struct ata_scsi_args *args, u8 *rbuf)
2602 struct ata_device *dev = args->dev;
2603 u8 *scsicmd = args->cmd->cmnd, *p = rbuf;
2604 const u8 sat_blk_desc[] = {
2605 0, 0, 0, 0, /* number of blocks: sat unspecified */
2607 0, 0x2, 0x0 /* block length: 512 bytes */
2609 u8 pg, spg;
2610 unsigned int ebd, page_control, six_byte;
2611 u8 dpofua, bp = 0xff;
2612 u16 fp;
2614 VPRINTK("ENTER\n");
2616 six_byte = (scsicmd[0] == MODE_SENSE);
2617 ebd = !(scsicmd[1] & 0x8); /* dbd bit inverted == edb */
2619 * LLBA bit in msense(10) ignored (compliant)
2622 page_control = scsicmd[2] >> 6;
2623 switch (page_control) {
2624 case 0: /* current */
2625 case 1: /* changeable */
2626 case 2: /* defaults */
2627 break; /* supported */
2628 case 3: /* saved */
2629 goto saving_not_supp;
2630 default:
2631 fp = 2;
2632 bp = 6;
2633 goto invalid_fld;
2636 if (six_byte)
2637 p += 4 + (ebd ? 8 : 0);
2638 else
2639 p += 8 + (ebd ? 8 : 0);
2641 pg = scsicmd[2] & 0x3f;
2642 spg = scsicmd[3];
2644 * No mode subpages supported (yet) but asking for _all_
2645 * subpages may be valid
2647 if (spg && (spg != ALL_SUB_MPAGES)) {
2648 fp = 3;
2649 goto invalid_fld;
2652 switch(pg) {
2653 case RW_RECOVERY_MPAGE:
2654 p += ata_msense_rw_recovery(p, page_control == 1);
2655 break;
2657 case CACHE_MPAGE:
2658 p += ata_msense_caching(args->id, p, page_control == 1);
2659 break;
2661 case CONTROL_MPAGE:
2662 p += ata_msense_control(args->dev, p, page_control == 1);
2663 break;
2665 case ALL_MPAGES:
2666 p += ata_msense_rw_recovery(p, page_control == 1);
2667 p += ata_msense_caching(args->id, p, page_control == 1);
2668 p += ata_msense_control(args->dev, p, page_control == 1);
2669 break;
2671 default: /* invalid page code */
2672 fp = 2;
2673 goto invalid_fld;
2676 dpofua = 0;
2677 if (ata_dev_supports_fua(args->id) && (dev->flags & ATA_DFLAG_LBA48) &&
2678 (!(dev->flags & ATA_DFLAG_PIO) || dev->multi_count))
2679 dpofua = 1 << 4;
2681 if (six_byte) {
2682 rbuf[0] = p - rbuf - 1;
2683 rbuf[2] |= dpofua;
2684 if (ebd) {
2685 rbuf[3] = sizeof(sat_blk_desc);
2686 memcpy(rbuf + 4, sat_blk_desc, sizeof(sat_blk_desc));
2688 } else {
2689 unsigned int output_len = p - rbuf - 2;
2691 rbuf[0] = output_len >> 8;
2692 rbuf[1] = output_len;
2693 rbuf[3] |= dpofua;
2694 if (ebd) {
2695 rbuf[7] = sizeof(sat_blk_desc);
2696 memcpy(rbuf + 8, sat_blk_desc, sizeof(sat_blk_desc));
2699 return 0;
2701 invalid_fld:
2702 ata_scsi_set_invalid_field(dev, args->cmd, fp, bp);
2703 return 1;
2705 saving_not_supp:
2706 ata_scsi_set_sense(dev, args->cmd, ILLEGAL_REQUEST, 0x39, 0x0);
2707 /* "Saving parameters not supported" */
2708 return 1;
2712 * ata_scsiop_read_cap - Simulate READ CAPACITY[ 16] commands
2713 * @args: device IDENTIFY data / SCSI command of interest.
2714 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2716 * Simulate READ CAPACITY commands.
2718 * LOCKING:
2719 * None.
2721 static unsigned int ata_scsiop_read_cap(struct ata_scsi_args *args, u8 *rbuf)
2723 struct ata_device *dev = args->dev;
2724 u64 last_lba = dev->n_sectors - 1; /* LBA of the last block */
2725 u32 sector_size; /* physical sector size in bytes */
2726 u8 log2_per_phys;
2727 u16 lowest_aligned;
2729 sector_size = ata_id_logical_sector_size(dev->id);
2730 log2_per_phys = ata_id_log2_per_physical_sector(dev->id);
2731 lowest_aligned = ata_id_logical_sector_offset(dev->id, log2_per_phys);
2733 VPRINTK("ENTER\n");
2735 if (args->cmd->cmnd[0] == READ_CAPACITY) {
2736 if (last_lba >= 0xffffffffULL)
2737 last_lba = 0xffffffff;
2739 /* sector count, 32-bit */
2740 rbuf[0] = last_lba >> (8 * 3);
2741 rbuf[1] = last_lba >> (8 * 2);
2742 rbuf[2] = last_lba >> (8 * 1);
2743 rbuf[3] = last_lba;
2745 /* sector size */
2746 rbuf[4] = sector_size >> (8 * 3);
2747 rbuf[5] = sector_size >> (8 * 2);
2748 rbuf[6] = sector_size >> (8 * 1);
2749 rbuf[7] = sector_size;
2750 } else {
2751 /* sector count, 64-bit */
2752 rbuf[0] = last_lba >> (8 * 7);
2753 rbuf[1] = last_lba >> (8 * 6);
2754 rbuf[2] = last_lba >> (8 * 5);
2755 rbuf[3] = last_lba >> (8 * 4);
2756 rbuf[4] = last_lba >> (8 * 3);
2757 rbuf[5] = last_lba >> (8 * 2);
2758 rbuf[6] = last_lba >> (8 * 1);
2759 rbuf[7] = last_lba;
2761 /* sector size */
2762 rbuf[ 8] = sector_size >> (8 * 3);
2763 rbuf[ 9] = sector_size >> (8 * 2);
2764 rbuf[10] = sector_size >> (8 * 1);
2765 rbuf[11] = sector_size;
2767 rbuf[12] = 0;
2768 rbuf[13] = log2_per_phys;
2769 rbuf[14] = (lowest_aligned >> 8) & 0x3f;
2770 rbuf[15] = lowest_aligned;
2772 if (ata_id_has_trim(args->id) &&
2773 !(dev->horkage & ATA_HORKAGE_NOTRIM)) {
2774 rbuf[14] |= 0x80; /* LBPME */
2776 if (ata_id_has_zero_after_trim(args->id) &&
2777 dev->horkage & ATA_HORKAGE_ZERO_AFTER_TRIM) {
2778 ata_dev_info(dev, "Enabling discard_zeroes_data\n");
2779 rbuf[14] |= 0x40; /* LBPRZ */
2782 if (ata_id_zoned_cap(args->id) ||
2783 args->dev->class == ATA_DEV_ZAC)
2784 rbuf[12] = (1 << 4); /* RC_BASIS */
2786 return 0;
2790 * ata_scsiop_report_luns - Simulate REPORT LUNS command
2791 * @args: device IDENTIFY data / SCSI command of interest.
2792 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2794 * Simulate REPORT LUNS command.
2796 * LOCKING:
2797 * spin_lock_irqsave(host lock)
2799 static unsigned int ata_scsiop_report_luns(struct ata_scsi_args *args, u8 *rbuf)
2801 VPRINTK("ENTER\n");
2802 rbuf[3] = 8; /* just one lun, LUN 0, size 8 bytes */
2804 return 0;
2807 static void atapi_sense_complete(struct ata_queued_cmd *qc)
2809 if (qc->err_mask && ((qc->err_mask & AC_ERR_DEV) == 0)) {
2810 /* FIXME: not quite right; we don't want the
2811 * translation of taskfile registers into
2812 * a sense descriptors, since that's only
2813 * correct for ATA, not ATAPI
2815 ata_gen_passthru_sense(qc);
2818 ata_qc_done(qc);
2821 /* is it pointless to prefer PIO for "safety reasons"? */
2822 static inline int ata_pio_use_silly(struct ata_port *ap)
2824 return (ap->flags & ATA_FLAG_PIO_DMA);
2827 static void atapi_request_sense(struct ata_queued_cmd *qc)
2829 struct ata_port *ap = qc->ap;
2830 struct scsi_cmnd *cmd = qc->scsicmd;
2832 DPRINTK("ATAPI request sense\n");
2834 memset(cmd->sense_buffer, 0, SCSI_SENSE_BUFFERSIZE);
2836 #ifdef CONFIG_ATA_SFF
2837 if (ap->ops->sff_tf_read)
2838 ap->ops->sff_tf_read(ap, &qc->tf);
2839 #endif
2841 /* fill these in, for the case where they are -not- overwritten */
2842 cmd->sense_buffer[0] = 0x70;
2843 cmd->sense_buffer[2] = qc->tf.feature >> 4;
2845 ata_qc_reinit(qc);
2847 /* setup sg table and init transfer direction */
2848 sg_init_one(&qc->sgent, cmd->sense_buffer, SCSI_SENSE_BUFFERSIZE);
2849 ata_sg_init(qc, &qc->sgent, 1);
2850 qc->dma_dir = DMA_FROM_DEVICE;
2852 memset(&qc->cdb, 0, qc->dev->cdb_len);
2853 qc->cdb[0] = REQUEST_SENSE;
2854 qc->cdb[4] = SCSI_SENSE_BUFFERSIZE;
2856 qc->tf.flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
2857 qc->tf.command = ATA_CMD_PACKET;
2859 if (ata_pio_use_silly(ap)) {
2860 qc->tf.protocol = ATAPI_PROT_DMA;
2861 qc->tf.feature |= ATAPI_PKT_DMA;
2862 } else {
2863 qc->tf.protocol = ATAPI_PROT_PIO;
2864 qc->tf.lbam = SCSI_SENSE_BUFFERSIZE;
2865 qc->tf.lbah = 0;
2867 qc->nbytes = SCSI_SENSE_BUFFERSIZE;
2869 qc->complete_fn = atapi_sense_complete;
2871 ata_qc_issue(qc);
2873 DPRINTK("EXIT\n");
2876 static void atapi_qc_complete(struct ata_queued_cmd *qc)
2878 struct scsi_cmnd *cmd = qc->scsicmd;
2879 unsigned int err_mask = qc->err_mask;
2881 VPRINTK("ENTER, err_mask 0x%X\n", err_mask);
2883 /* handle completion from new EH */
2884 if (unlikely(qc->ap->ops->error_handler &&
2885 (err_mask || qc->flags & ATA_QCFLAG_SENSE_VALID))) {
2887 if (!(qc->flags & ATA_QCFLAG_SENSE_VALID)) {
2888 /* FIXME: not quite right; we don't want the
2889 * translation of taskfile registers into a
2890 * sense descriptors, since that's only
2891 * correct for ATA, not ATAPI
2893 ata_gen_passthru_sense(qc);
2896 /* SCSI EH automatically locks door if sdev->locked is
2897 * set. Sometimes door lock request continues to
2898 * fail, for example, when no media is present. This
2899 * creates a loop - SCSI EH issues door lock which
2900 * fails and gets invoked again to acquire sense data
2901 * for the failed command.
2903 * If door lock fails, always clear sdev->locked to
2904 * avoid this infinite loop.
2906 * This may happen before SCSI scan is complete. Make
2907 * sure qc->dev->sdev isn't NULL before dereferencing.
2909 if (qc->cdb[0] == ALLOW_MEDIUM_REMOVAL && qc->dev->sdev)
2910 qc->dev->sdev->locked = 0;
2912 qc->scsicmd->result = SAM_STAT_CHECK_CONDITION;
2913 ata_qc_done(qc);
2914 return;
2917 /* successful completion or old EH failure path */
2918 if (unlikely(err_mask & AC_ERR_DEV)) {
2919 cmd->result = SAM_STAT_CHECK_CONDITION;
2920 atapi_request_sense(qc);
2921 return;
2922 } else if (unlikely(err_mask)) {
2923 /* FIXME: not quite right; we don't want the
2924 * translation of taskfile registers into
2925 * a sense descriptors, since that's only
2926 * correct for ATA, not ATAPI
2928 ata_gen_passthru_sense(qc);
2929 } else {
2930 u8 *scsicmd = cmd->cmnd;
2932 if ((scsicmd[0] == INQUIRY) && ((scsicmd[1] & 0x03) == 0)) {
2933 unsigned long flags;
2934 u8 *buf;
2936 buf = ata_scsi_rbuf_get(cmd, true, &flags);
2938 /* ATAPI devices typically report zero for their SCSI version,
2939 * and sometimes deviate from the spec WRT response data
2940 * format. If SCSI version is reported as zero like normal,
2941 * then we make the following fixups: 1) Fake MMC-5 version,
2942 * to indicate to the Linux scsi midlayer this is a modern
2943 * device. 2) Ensure response data format / ATAPI information
2944 * are always correct.
2946 if (buf[2] == 0) {
2947 buf[2] = 0x5;
2948 buf[3] = 0x32;
2951 ata_scsi_rbuf_put(cmd, true, &flags);
2954 cmd->result = SAM_STAT_GOOD;
2957 ata_qc_done(qc);
2960 * atapi_xlat - Initialize PACKET taskfile
2961 * @qc: command structure to be initialized
2963 * LOCKING:
2964 * spin_lock_irqsave(host lock)
2966 * RETURNS:
2967 * Zero on success, non-zero on failure.
2969 static unsigned int atapi_xlat(struct ata_queued_cmd *qc)
2971 struct scsi_cmnd *scmd = qc->scsicmd;
2972 struct ata_device *dev = qc->dev;
2973 int nodata = (scmd->sc_data_direction == DMA_NONE);
2974 int using_pio = !nodata && (dev->flags & ATA_DFLAG_PIO);
2975 unsigned int nbytes;
2977 memset(qc->cdb, 0, dev->cdb_len);
2978 memcpy(qc->cdb, scmd->cmnd, scmd->cmd_len);
2980 qc->complete_fn = atapi_qc_complete;
2982 qc->tf.flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
2983 if (scmd->sc_data_direction == DMA_TO_DEVICE) {
2984 qc->tf.flags |= ATA_TFLAG_WRITE;
2985 DPRINTK("direction: write\n");
2988 qc->tf.command = ATA_CMD_PACKET;
2989 ata_qc_set_pc_nbytes(qc);
2991 /* check whether ATAPI DMA is safe */
2992 if (!nodata && !using_pio && atapi_check_dma(qc))
2993 using_pio = 1;
2995 /* Some controller variants snoop this value for Packet
2996 * transfers to do state machine and FIFO management. Thus we
2997 * want to set it properly, and for DMA where it is
2998 * effectively meaningless.
3000 nbytes = min(ata_qc_raw_nbytes(qc), (unsigned int)63 * 1024);
3002 /* Most ATAPI devices which honor transfer chunk size don't
3003 * behave according to the spec when odd chunk size which
3004 * matches the transfer length is specified. If the number of
3005 * bytes to transfer is 2n+1. According to the spec, what
3006 * should happen is to indicate that 2n+1 is going to be
3007 * transferred and transfer 2n+2 bytes where the last byte is
3008 * padding.
3010 * In practice, this doesn't happen. ATAPI devices first
3011 * indicate and transfer 2n bytes and then indicate and
3012 * transfer 2 bytes where the last byte is padding.
3014 * This inconsistency confuses several controllers which
3015 * perform PIO using DMA such as Intel AHCIs and sil3124/32.
3016 * These controllers use actual number of transferred bytes to
3017 * update DMA poitner and transfer of 4n+2 bytes make those
3018 * controller push DMA pointer by 4n+4 bytes because SATA data
3019 * FISes are aligned to 4 bytes. This causes data corruption
3020 * and buffer overrun.
3022 * Always setting nbytes to even number solves this problem
3023 * because then ATAPI devices don't have to split data at 2n
3024 * boundaries.
3026 if (nbytes & 0x1)
3027 nbytes++;
3029 qc->tf.lbam = (nbytes & 0xFF);
3030 qc->tf.lbah = (nbytes >> 8);
3032 if (nodata)
3033 qc->tf.protocol = ATAPI_PROT_NODATA;
3034 else if (using_pio)
3035 qc->tf.protocol = ATAPI_PROT_PIO;
3036 else {
3037 /* DMA data xfer */
3038 qc->tf.protocol = ATAPI_PROT_DMA;
3039 qc->tf.feature |= ATAPI_PKT_DMA;
3041 if ((dev->flags & ATA_DFLAG_DMADIR) &&
3042 (scmd->sc_data_direction != DMA_TO_DEVICE))
3043 /* some SATA bridges need us to indicate data xfer direction */
3044 qc->tf.feature |= ATAPI_DMADIR;
3048 /* FIXME: We need to translate 0x05 READ_BLOCK_LIMITS to a MODE_SENSE
3049 as ATAPI tape drives don't get this right otherwise */
3050 return 0;
3053 static struct ata_device *ata_find_dev(struct ata_port *ap, int devno)
3055 if (!sata_pmp_attached(ap)) {
3056 if (likely(devno < ata_link_max_devices(&ap->link)))
3057 return &ap->link.device[devno];
3058 } else {
3059 if (likely(devno < ap->nr_pmp_links))
3060 return &ap->pmp_link[devno].device[0];
3063 return NULL;
3066 static struct ata_device *__ata_scsi_find_dev(struct ata_port *ap,
3067 const struct scsi_device *scsidev)
3069 int devno;
3071 /* skip commands not addressed to targets we simulate */
3072 if (!sata_pmp_attached(ap)) {
3073 if (unlikely(scsidev->channel || scsidev->lun))
3074 return NULL;
3075 devno = scsidev->id;
3076 } else {
3077 if (unlikely(scsidev->id || scsidev->lun))
3078 return NULL;
3079 devno = scsidev->channel;
3082 return ata_find_dev(ap, devno);
3086 * ata_scsi_find_dev - lookup ata_device from scsi_cmnd
3087 * @ap: ATA port to which the device is attached
3088 * @scsidev: SCSI device from which we derive the ATA device
3090 * Given various information provided in struct scsi_cmnd,
3091 * map that onto an ATA bus, and using that mapping
3092 * determine which ata_device is associated with the
3093 * SCSI command to be sent.
3095 * LOCKING:
3096 * spin_lock_irqsave(host lock)
3098 * RETURNS:
3099 * Associated ATA device, or %NULL if not found.
3101 static struct ata_device *
3102 ata_scsi_find_dev(struct ata_port *ap, const struct scsi_device *scsidev)
3104 struct ata_device *dev = __ata_scsi_find_dev(ap, scsidev);
3106 if (unlikely(!dev || !ata_dev_enabled(dev)))
3107 return NULL;
3109 return dev;
3113 * ata_scsi_map_proto - Map pass-thru protocol value to taskfile value.
3114 * @byte1: Byte 1 from pass-thru CDB.
3116 * RETURNS:
3117 * ATA_PROT_UNKNOWN if mapping failed/unimplemented, protocol otherwise.
3119 static u8
3120 ata_scsi_map_proto(u8 byte1)
3122 switch((byte1 & 0x1e) >> 1) {
3123 case 3: /* Non-data */
3124 return ATA_PROT_NODATA;
3126 case 6: /* DMA */
3127 case 10: /* UDMA Data-in */
3128 case 11: /* UDMA Data-Out */
3129 return ATA_PROT_DMA;
3131 case 4: /* PIO Data-in */
3132 case 5: /* PIO Data-out */
3133 return ATA_PROT_PIO;
3135 case 12: /* FPDMA */
3136 return ATA_PROT_NCQ;
3138 case 0: /* Hard Reset */
3139 case 1: /* SRST */
3140 case 8: /* Device Diagnostic */
3141 case 9: /* Device Reset */
3142 case 7: /* DMA Queued */
3143 case 15: /* Return Response Info */
3144 default: /* Reserved */
3145 break;
3148 return ATA_PROT_UNKNOWN;
3152 * ata_scsi_pass_thru - convert ATA pass-thru CDB to taskfile
3153 * @qc: command structure to be initialized
3155 * Handles either 12 or 16-byte versions of the CDB.
3157 * RETURNS:
3158 * Zero on success, non-zero on failure.
3160 static unsigned int ata_scsi_pass_thru(struct ata_queued_cmd *qc)
3162 struct ata_taskfile *tf = &(qc->tf);
3163 struct scsi_cmnd *scmd = qc->scsicmd;
3164 struct ata_device *dev = qc->dev;
3165 const u8 *cdb = scmd->cmnd;
3166 u16 fp;
3168 if ((tf->protocol = ata_scsi_map_proto(cdb[1])) == ATA_PROT_UNKNOWN) {
3169 fp = 1;
3170 goto invalid_fld;
3173 if (ata_is_ncq(tf->protocol) && (cdb[2] & 0x3) == 0)
3174 tf->protocol = ATA_PROT_NCQ_NODATA;
3176 /* enable LBA */
3177 tf->flags |= ATA_TFLAG_LBA;
3180 * 12 and 16 byte CDBs use different offsets to
3181 * provide the various register values.
3183 if (cdb[0] == ATA_16) {
3185 * 16-byte CDB - may contain extended commands.
3187 * If that is the case, copy the upper byte register values.
3189 if (cdb[1] & 0x01) {
3190 tf->hob_feature = cdb[3];
3191 tf->hob_nsect = cdb[5];
3192 tf->hob_lbal = cdb[7];
3193 tf->hob_lbam = cdb[9];
3194 tf->hob_lbah = cdb[11];
3195 tf->flags |= ATA_TFLAG_LBA48;
3196 } else
3197 tf->flags &= ~ATA_TFLAG_LBA48;
3200 * Always copy low byte, device and command registers.
3202 tf->feature = cdb[4];
3203 tf->nsect = cdb[6];
3204 tf->lbal = cdb[8];
3205 tf->lbam = cdb[10];
3206 tf->lbah = cdb[12];
3207 tf->device = cdb[13];
3208 tf->command = cdb[14];
3209 } else {
3211 * 12-byte CDB - incapable of extended commands.
3213 tf->flags &= ~ATA_TFLAG_LBA48;
3215 tf->feature = cdb[3];
3216 tf->nsect = cdb[4];
3217 tf->lbal = cdb[5];
3218 tf->lbam = cdb[6];
3219 tf->lbah = cdb[7];
3220 tf->device = cdb[8];
3221 tf->command = cdb[9];
3224 /* For NCQ commands copy the tag value */
3225 if (ata_is_ncq(tf->protocol))
3226 tf->nsect = qc->tag << 3;
3228 /* enforce correct master/slave bit */
3229 tf->device = dev->devno ?
3230 tf->device | ATA_DEV1 : tf->device & ~ATA_DEV1;
3232 switch (tf->command) {
3233 /* READ/WRITE LONG use a non-standard sect_size */
3234 case ATA_CMD_READ_LONG:
3235 case ATA_CMD_READ_LONG_ONCE:
3236 case ATA_CMD_WRITE_LONG:
3237 case ATA_CMD_WRITE_LONG_ONCE:
3238 if (tf->protocol != ATA_PROT_PIO || tf->nsect != 1) {
3239 fp = 1;
3240 goto invalid_fld;
3242 qc->sect_size = scsi_bufflen(scmd);
3243 break;
3245 /* commands using reported Logical Block size (e.g. 512 or 4K) */
3246 case ATA_CMD_CFA_WRITE_NE:
3247 case ATA_CMD_CFA_TRANS_SECT:
3248 case ATA_CMD_CFA_WRITE_MULT_NE:
3249 /* XXX: case ATA_CMD_CFA_WRITE_SECTORS_WITHOUT_ERASE: */
3250 case ATA_CMD_READ:
3251 case ATA_CMD_READ_EXT:
3252 case ATA_CMD_READ_QUEUED:
3253 /* XXX: case ATA_CMD_READ_QUEUED_EXT: */
3254 case ATA_CMD_FPDMA_READ:
3255 case ATA_CMD_READ_MULTI:
3256 case ATA_CMD_READ_MULTI_EXT:
3257 case ATA_CMD_PIO_READ:
3258 case ATA_CMD_PIO_READ_EXT:
3259 case ATA_CMD_READ_STREAM_DMA_EXT:
3260 case ATA_CMD_READ_STREAM_EXT:
3261 case ATA_CMD_VERIFY:
3262 case ATA_CMD_VERIFY_EXT:
3263 case ATA_CMD_WRITE:
3264 case ATA_CMD_WRITE_EXT:
3265 case ATA_CMD_WRITE_FUA_EXT:
3266 case ATA_CMD_WRITE_QUEUED:
3267 case ATA_CMD_WRITE_QUEUED_FUA_EXT:
3268 case ATA_CMD_FPDMA_WRITE:
3269 case ATA_CMD_WRITE_MULTI:
3270 case ATA_CMD_WRITE_MULTI_EXT:
3271 case ATA_CMD_WRITE_MULTI_FUA_EXT:
3272 case ATA_CMD_PIO_WRITE:
3273 case ATA_CMD_PIO_WRITE_EXT:
3274 case ATA_CMD_WRITE_STREAM_DMA_EXT:
3275 case ATA_CMD_WRITE_STREAM_EXT:
3276 qc->sect_size = scmd->device->sector_size;
3277 break;
3279 /* Everything else uses 512 byte "sectors" */
3280 default:
3281 qc->sect_size = ATA_SECT_SIZE;
3285 * Set flags so that all registers will be written, pass on
3286 * write indication (used for PIO/DMA setup), result TF is
3287 * copied back and we don't whine too much about its failure.
3289 tf->flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
3290 if (scmd->sc_data_direction == DMA_TO_DEVICE)
3291 tf->flags |= ATA_TFLAG_WRITE;
3293 qc->flags |= ATA_QCFLAG_RESULT_TF | ATA_QCFLAG_QUIET;
3296 * Set transfer length.
3298 * TODO: find out if we need to do more here to
3299 * cover scatter/gather case.
3301 ata_qc_set_pc_nbytes(qc);
3303 /* We may not issue DMA commands if no DMA mode is set */
3304 if (tf->protocol == ATA_PROT_DMA && dev->dma_mode == 0) {
3305 fp = 1;
3306 goto invalid_fld;
3309 /* sanity check for pio multi commands */
3310 if ((cdb[1] & 0xe0) && !is_multi_taskfile(tf)) {
3311 fp = 1;
3312 goto invalid_fld;
3315 if (is_multi_taskfile(tf)) {
3316 unsigned int multi_count = 1 << (cdb[1] >> 5);
3318 /* compare the passed through multi_count
3319 * with the cached multi_count of libata
3321 if (multi_count != dev->multi_count)
3322 ata_dev_warn(dev, "invalid multi_count %u ignored\n",
3323 multi_count);
3327 * Filter SET_FEATURES - XFER MODE command -- otherwise,
3328 * SET_FEATURES - XFER MODE must be preceded/succeeded
3329 * by an update to hardware-specific registers for each
3330 * controller (i.e. the reason for ->set_piomode(),
3331 * ->set_dmamode(), and ->post_set_mode() hooks).
3333 if (tf->command == ATA_CMD_SET_FEATURES &&
3334 tf->feature == SETFEATURES_XFER) {
3335 fp = (cdb[0] == ATA_16) ? 4 : 3;
3336 goto invalid_fld;
3340 * Filter TPM commands by default. These provide an
3341 * essentially uncontrolled encrypted "back door" between
3342 * applications and the disk. Set libata.allow_tpm=1 if you
3343 * have a real reason for wanting to use them. This ensures
3344 * that installed software cannot easily mess stuff up without
3345 * user intent. DVR type users will probably ship with this enabled
3346 * for movie content management.
3348 * Note that for ATA8 we can issue a DCS change and DCS freeze lock
3349 * for this and should do in future but that it is not sufficient as
3350 * DCS is an optional feature set. Thus we also do the software filter
3351 * so that we comply with the TC consortium stated goal that the user
3352 * can turn off TC features of their system.
3354 if (tf->command >= 0x5C && tf->command <= 0x5F && !libata_allow_tpm) {
3355 fp = (cdb[0] == ATA_16) ? 14 : 9;
3356 goto invalid_fld;
3359 return 0;
3361 invalid_fld:
3362 ata_scsi_set_invalid_field(dev, scmd, fp, 0xff);
3363 return 1;
3367 * ata_format_dsm_trim_descr() - SATL Write Same to DSM Trim
3368 * @cmd: SCSI command being translated
3369 * @trmax: Maximum number of entries that will fit in sector_size bytes.
3370 * @sector: Starting sector
3371 * @count: Total Range of request in logical sectors
3373 * Rewrite the WRITE SAME descriptor to be a DSM TRIM little-endian formatted
3374 * descriptor.
3376 * Upto 64 entries of the format:
3377 * 63:48 Range Length
3378 * 47:0 LBA
3380 * Range Length of 0 is ignored.
3381 * LBA's should be sorted order and not overlap.
3383 * NOTE: this is the same format as ADD LBA(S) TO NV CACHE PINNED SET
3385 * Return: Number of bytes copied into sglist.
3387 static size_t ata_format_dsm_trim_descr(struct scsi_cmnd *cmd, u32 trmax,
3388 u64 sector, u32 count)
3390 struct scsi_device *sdp = cmd->device;
3391 size_t len = sdp->sector_size;
3392 size_t r;
3393 __le64 *buf;
3394 u32 i = 0;
3395 unsigned long flags;
3397 WARN_ON(len > ATA_SCSI_RBUF_SIZE);
3399 if (len > ATA_SCSI_RBUF_SIZE)
3400 len = ATA_SCSI_RBUF_SIZE;
3402 spin_lock_irqsave(&ata_scsi_rbuf_lock, flags);
3403 buf = ((void *)ata_scsi_rbuf);
3404 memset(buf, 0, len);
3405 while (i < trmax) {
3406 u64 entry = sector |
3407 ((u64)(count > 0xffff ? 0xffff : count) << 48);
3408 buf[i++] = __cpu_to_le64(entry);
3409 if (count <= 0xffff)
3410 break;
3411 count -= 0xffff;
3412 sector += 0xffff;
3414 r = sg_copy_from_buffer(scsi_sglist(cmd), scsi_sg_count(cmd), buf, len);
3415 spin_unlock_irqrestore(&ata_scsi_rbuf_lock, flags);
3417 return r;
3421 * ata_format_dsm_trim_descr() - SATL Write Same to ATA SCT Write Same
3422 * @cmd: SCSI command being translated
3423 * @lba: Starting sector
3424 * @num: Number of sectors to be zero'd.
3426 * Rewrite the WRITE SAME payload to be an SCT Write Same formatted
3427 * descriptor.
3428 * NOTE: Writes a pattern (0's) in the foreground.
3430 * Return: Number of bytes copied into sglist.
3432 static size_t ata_format_sct_write_same(struct scsi_cmnd *cmd, u64 lba, u64 num)
3434 struct scsi_device *sdp = cmd->device;
3435 size_t len = sdp->sector_size;
3436 size_t r;
3437 u16 *buf;
3438 unsigned long flags;
3440 spin_lock_irqsave(&ata_scsi_rbuf_lock, flags);
3441 buf = ((void *)ata_scsi_rbuf);
3443 put_unaligned_le16(0x0002, &buf[0]); /* SCT_ACT_WRITE_SAME */
3444 put_unaligned_le16(0x0101, &buf[1]); /* WRITE PTRN FG */
3445 put_unaligned_le64(lba, &buf[2]);
3446 put_unaligned_le64(num, &buf[6]);
3447 put_unaligned_le32(0u, &buf[10]); /* pattern */
3449 WARN_ON(len > ATA_SCSI_RBUF_SIZE);
3451 if (len > ATA_SCSI_RBUF_SIZE)
3452 len = ATA_SCSI_RBUF_SIZE;
3454 r = sg_copy_from_buffer(scsi_sglist(cmd), scsi_sg_count(cmd), buf, len);
3455 spin_unlock_irqrestore(&ata_scsi_rbuf_lock, flags);
3457 return r;
3461 * ata_scsi_write_same_xlat() - SATL Write Same to ATA SCT Write Same
3462 * @qc: Command to be translated
3464 * Translate a SCSI WRITE SAME command to be either a DSM TRIM command or
3465 * an SCT Write Same command.
3466 * Based on WRITE SAME has the UNMAP flag
3467 * When set translate to DSM TRIM
3468 * When clear translate to SCT Write Same
3470 static unsigned int ata_scsi_write_same_xlat(struct ata_queued_cmd *qc)
3472 struct ata_taskfile *tf = &qc->tf;
3473 struct scsi_cmnd *scmd = qc->scsicmd;
3474 struct scsi_device *sdp = scmd->device;
3475 size_t len = sdp->sector_size;
3476 struct ata_device *dev = qc->dev;
3477 const u8 *cdb = scmd->cmnd;
3478 u64 block;
3479 u32 n_block;
3480 const u32 trmax = len >> 3;
3481 u32 size;
3482 u16 fp;
3483 u8 bp = 0xff;
3484 u8 unmap = cdb[1] & 0x8;
3486 /* we may not issue DMA commands if no DMA mode is set */
3487 if (unlikely(!dev->dma_mode))
3488 goto invalid_opcode;
3490 if (unlikely(scmd->cmd_len < 16)) {
3491 fp = 15;
3492 goto invalid_fld;
3494 scsi_16_lba_len(cdb, &block, &n_block);
3496 if (unmap) {
3497 /* If trim is not enabled the cmd is invalid. */
3498 if ((dev->horkage & ATA_HORKAGE_NOTRIM) ||
3499 !ata_id_has_trim(dev->id)) {
3500 fp = 1;
3501 bp = 3;
3502 goto invalid_fld;
3504 /* If the request is too large the cmd is invalid */
3505 if (n_block > 0xffff * trmax) {
3506 fp = 2;
3507 goto invalid_fld;
3509 } else {
3510 /* If write same is not available the cmd is invalid */
3511 if (!ata_id_sct_write_same(dev->id)) {
3512 fp = 1;
3513 bp = 3;
3514 goto invalid_fld;
3519 * WRITE SAME always has a sector sized buffer as payload, this
3520 * should never be a multiple entry S/G list.
3522 if (!scsi_sg_count(scmd))
3523 goto invalid_param_len;
3526 * size must match sector size in bytes
3527 * For DATA SET MANAGEMENT TRIM in ACS-2 nsect (aka count)
3528 * is defined as number of 512 byte blocks to be transferred.
3530 if (unmap) {
3531 size = ata_format_dsm_trim_descr(scmd, trmax, block, n_block);
3532 if (size != len)
3533 goto invalid_param_len;
3535 if (ata_ncq_enabled(dev) && ata_fpdma_dsm_supported(dev)) {
3536 /* Newer devices support queued TRIM commands */
3537 tf->protocol = ATA_PROT_NCQ;
3538 tf->command = ATA_CMD_FPDMA_SEND;
3539 tf->hob_nsect = ATA_SUBCMD_FPDMA_SEND_DSM & 0x1f;
3540 tf->nsect = qc->tag << 3;
3541 tf->hob_feature = (size / 512) >> 8;
3542 tf->feature = size / 512;
3544 tf->auxiliary = 1;
3545 } else {
3546 tf->protocol = ATA_PROT_DMA;
3547 tf->hob_feature = 0;
3548 tf->feature = ATA_DSM_TRIM;
3549 tf->hob_nsect = (size / 512) >> 8;
3550 tf->nsect = size / 512;
3551 tf->command = ATA_CMD_DSM;
3553 } else {
3554 size = ata_format_sct_write_same(scmd, block, n_block);
3555 if (size != len)
3556 goto invalid_param_len;
3558 tf->hob_feature = 0;
3559 tf->feature = 0;
3560 tf->hob_nsect = 0;
3561 tf->nsect = 1;
3562 tf->lbah = 0;
3563 tf->lbam = 0;
3564 tf->lbal = ATA_CMD_STANDBYNOW1;
3565 tf->hob_lbah = 0;
3566 tf->hob_lbam = 0;
3567 tf->hob_lbal = 0;
3568 tf->device = ATA_CMD_STANDBYNOW1;
3569 tf->protocol = ATA_PROT_DMA;
3570 tf->command = ATA_CMD_WRITE_LOG_DMA_EXT;
3571 if (unlikely(dev->flags & ATA_DFLAG_PIO))
3572 tf->command = ATA_CMD_WRITE_LOG_EXT;
3575 tf->flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE | ATA_TFLAG_LBA48 |
3576 ATA_TFLAG_WRITE;
3578 ata_qc_set_pc_nbytes(qc);
3580 return 0;
3582 invalid_fld:
3583 ata_scsi_set_invalid_field(dev, scmd, fp, bp);
3584 return 1;
3585 invalid_param_len:
3586 /* "Parameter list length error" */
3587 ata_scsi_set_sense(dev, scmd, ILLEGAL_REQUEST, 0x1a, 0x0);
3588 return 1;
3589 invalid_opcode:
3590 /* "Invalid command operation code" */
3591 ata_scsi_set_sense(dev, scmd, ILLEGAL_REQUEST, 0x20, 0x0);
3592 return 1;
3596 * ata_scsiop_maint_in - Simulate a subset of MAINTENANCE_IN
3597 * @args: device MAINTENANCE_IN data / SCSI command of interest.
3598 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
3600 * Yields a subset to satisfy scsi_report_opcode()
3602 * LOCKING:
3603 * spin_lock_irqsave(host lock)
3605 static unsigned int ata_scsiop_maint_in(struct ata_scsi_args *args, u8 *rbuf)
3607 struct ata_device *dev = args->dev;
3608 u8 *cdb = args->cmd->cmnd;
3609 u8 supported = 0;
3610 unsigned int err = 0;
3612 if (cdb[2] != 1) {
3613 ata_dev_warn(dev, "invalid command format %d\n", cdb[2]);
3614 err = 2;
3615 goto out;
3617 switch (cdb[3]) {
3618 case INQUIRY:
3619 case MODE_SENSE:
3620 case MODE_SENSE_10:
3621 case READ_CAPACITY:
3622 case SERVICE_ACTION_IN_16:
3623 case REPORT_LUNS:
3624 case REQUEST_SENSE:
3625 case SYNCHRONIZE_CACHE:
3626 case REZERO_UNIT:
3627 case SEEK_6:
3628 case SEEK_10:
3629 case TEST_UNIT_READY:
3630 case SEND_DIAGNOSTIC:
3631 case MAINTENANCE_IN:
3632 case READ_6:
3633 case READ_10:
3634 case READ_16:
3635 case WRITE_6:
3636 case WRITE_10:
3637 case WRITE_16:
3638 case ATA_12:
3639 case ATA_16:
3640 case VERIFY:
3641 case VERIFY_16:
3642 case MODE_SELECT:
3643 case MODE_SELECT_10:
3644 case START_STOP:
3645 supported = 3;
3646 break;
3647 case WRITE_SAME_16:
3648 if (!ata_id_sct_write_same(dev->id))
3649 break;
3650 /* fallthrough: if SCT ... only enable for ZBC */
3651 case ZBC_IN:
3652 case ZBC_OUT:
3653 if (ata_id_zoned_cap(dev->id) ||
3654 dev->class == ATA_DEV_ZAC)
3655 supported = 3;
3656 break;
3657 default:
3658 break;
3660 out:
3661 rbuf[1] = supported; /* supported */
3662 return err;
3666 * ata_scsi_report_zones_complete - convert ATA output
3667 * @qc: command structure returning the data
3669 * Convert T-13 little-endian field representation into
3670 * T-10 big-endian field representation.
3671 * What a mess.
3673 static void ata_scsi_report_zones_complete(struct ata_queued_cmd *qc)
3675 struct scsi_cmnd *scmd = qc->scsicmd;
3676 struct sg_mapping_iter miter;
3677 unsigned long flags;
3678 unsigned int bytes = 0;
3680 sg_miter_start(&miter, scsi_sglist(scmd), scsi_sg_count(scmd),
3681 SG_MITER_TO_SG | SG_MITER_ATOMIC);
3683 local_irq_save(flags);
3684 while (sg_miter_next(&miter)) {
3685 unsigned int offset = 0;
3687 if (bytes == 0) {
3688 char *hdr;
3689 u32 list_length;
3690 u64 max_lba, opt_lba;
3691 u16 same;
3693 /* Swizzle header */
3694 hdr = miter.addr;
3695 list_length = get_unaligned_le32(&hdr[0]);
3696 same = get_unaligned_le16(&hdr[4]);
3697 max_lba = get_unaligned_le64(&hdr[8]);
3698 opt_lba = get_unaligned_le64(&hdr[16]);
3699 put_unaligned_be32(list_length, &hdr[0]);
3700 hdr[4] = same & 0xf;
3701 put_unaligned_be64(max_lba, &hdr[8]);
3702 put_unaligned_be64(opt_lba, &hdr[16]);
3703 offset += 64;
3704 bytes += 64;
3706 while (offset < miter.length) {
3707 char *rec;
3708 u8 cond, type, non_seq, reset;
3709 u64 size, start, wp;
3711 /* Swizzle zone descriptor */
3712 rec = miter.addr + offset;
3713 type = rec[0] & 0xf;
3714 cond = (rec[1] >> 4) & 0xf;
3715 non_seq = (rec[1] & 2);
3716 reset = (rec[1] & 1);
3717 size = get_unaligned_le64(&rec[8]);
3718 start = get_unaligned_le64(&rec[16]);
3719 wp = get_unaligned_le64(&rec[24]);
3720 rec[0] = type;
3721 rec[1] = (cond << 4) | non_seq | reset;
3722 put_unaligned_be64(size, &rec[8]);
3723 put_unaligned_be64(start, &rec[16]);
3724 put_unaligned_be64(wp, &rec[24]);
3725 WARN_ON(offset + 64 > miter.length);
3726 offset += 64;
3727 bytes += 64;
3730 sg_miter_stop(&miter);
3731 local_irq_restore(flags);
3733 ata_scsi_qc_complete(qc);
3736 static unsigned int ata_scsi_zbc_in_xlat(struct ata_queued_cmd *qc)
3738 struct ata_taskfile *tf = &qc->tf;
3739 struct scsi_cmnd *scmd = qc->scsicmd;
3740 const u8 *cdb = scmd->cmnd;
3741 u16 sect, fp = (u16)-1;
3742 u8 sa, options, bp = 0xff;
3743 u64 block;
3744 u32 n_block;
3746 if (unlikely(scmd->cmd_len < 16)) {
3747 ata_dev_warn(qc->dev, "invalid cdb length %d\n",
3748 scmd->cmd_len);
3749 fp = 15;
3750 goto invalid_fld;
3752 scsi_16_lba_len(cdb, &block, &n_block);
3753 if (n_block != scsi_bufflen(scmd)) {
3754 ata_dev_warn(qc->dev, "non-matching transfer count (%d/%d)\n",
3755 n_block, scsi_bufflen(scmd));
3756 goto invalid_param_len;
3758 sa = cdb[1] & 0x1f;
3759 if (sa != ZI_REPORT_ZONES) {
3760 ata_dev_warn(qc->dev, "invalid service action %d\n", sa);
3761 fp = 1;
3762 goto invalid_fld;
3765 * ZAC allows only for transfers in 512 byte blocks,
3766 * and uses a 16 bit value for the transfer count.
3768 if ((n_block / 512) > 0xffff || n_block < 512 || (n_block % 512)) {
3769 ata_dev_warn(qc->dev, "invalid transfer count %d\n", n_block);
3770 goto invalid_param_len;
3772 sect = n_block / 512;
3773 options = cdb[14] & 0xbf;
3775 if (ata_ncq_enabled(qc->dev) &&
3776 ata_fpdma_zac_mgmt_in_supported(qc->dev)) {
3777 tf->protocol = ATA_PROT_NCQ;
3778 tf->command = ATA_CMD_FPDMA_RECV;
3779 tf->hob_nsect = ATA_SUBCMD_FPDMA_RECV_ZAC_MGMT_IN & 0x1f;
3780 tf->nsect = qc->tag << 3;
3781 tf->feature = sect & 0xff;
3782 tf->hob_feature = (sect >> 8) & 0xff;
3783 tf->auxiliary = ATA_SUBCMD_ZAC_MGMT_IN_REPORT_ZONES | (options << 8);
3784 } else {
3785 tf->command = ATA_CMD_ZAC_MGMT_IN;
3786 tf->feature = ATA_SUBCMD_ZAC_MGMT_IN_REPORT_ZONES;
3787 tf->protocol = ATA_PROT_DMA;
3788 tf->hob_feature = options;
3789 tf->hob_nsect = (sect >> 8) & 0xff;
3790 tf->nsect = sect & 0xff;
3792 tf->device = ATA_LBA;
3793 tf->lbah = (block >> 16) & 0xff;
3794 tf->lbam = (block >> 8) & 0xff;
3795 tf->lbal = block & 0xff;
3796 tf->hob_lbah = (block >> 40) & 0xff;
3797 tf->hob_lbam = (block >> 32) & 0xff;
3798 tf->hob_lbal = (block >> 24) & 0xff;
3800 tf->flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE | ATA_TFLAG_LBA48;
3801 qc->flags |= ATA_QCFLAG_RESULT_TF;
3803 ata_qc_set_pc_nbytes(qc);
3805 qc->complete_fn = ata_scsi_report_zones_complete;
3807 return 0;
3809 invalid_fld:
3810 ata_scsi_set_invalid_field(qc->dev, scmd, fp, bp);
3811 return 1;
3813 invalid_param_len:
3814 /* "Parameter list length error" */
3815 ata_scsi_set_sense(qc->dev, scmd, ILLEGAL_REQUEST, 0x1a, 0x0);
3816 return 1;
3819 static unsigned int ata_scsi_zbc_out_xlat(struct ata_queued_cmd *qc)
3821 struct ata_taskfile *tf = &qc->tf;
3822 struct scsi_cmnd *scmd = qc->scsicmd;
3823 struct ata_device *dev = qc->dev;
3824 const u8 *cdb = scmd->cmnd;
3825 u8 all, sa;
3826 u64 block;
3827 u32 n_block;
3828 u16 fp = (u16)-1;
3830 if (unlikely(scmd->cmd_len < 16)) {
3831 fp = 15;
3832 goto invalid_fld;
3835 sa = cdb[1] & 0x1f;
3836 if ((sa != ZO_CLOSE_ZONE) && (sa != ZO_FINISH_ZONE) &&
3837 (sa != ZO_OPEN_ZONE) && (sa != ZO_RESET_WRITE_POINTER)) {
3838 fp = 1;
3839 goto invalid_fld;
3842 scsi_16_lba_len(cdb, &block, &n_block);
3843 if (n_block) {
3845 * ZAC MANAGEMENT OUT doesn't define any length
3847 goto invalid_param_len;
3849 if (block > dev->n_sectors)
3850 goto out_of_range;
3852 all = cdb[14] & 0x1;
3854 if (ata_ncq_enabled(qc->dev) &&
3855 ata_fpdma_zac_mgmt_out_supported(qc->dev)) {
3856 tf->protocol = ATA_PROT_NCQ_NODATA;
3857 tf->command = ATA_CMD_NCQ_NON_DATA;
3858 tf->feature = ATA_SUBCMD_NCQ_NON_DATA_ZAC_MGMT_OUT;
3859 tf->nsect = qc->tag << 3;
3860 tf->auxiliary = sa | ((u16)all << 8);
3861 } else {
3862 tf->protocol = ATA_PROT_NODATA;
3863 tf->command = ATA_CMD_ZAC_MGMT_OUT;
3864 tf->feature = sa;
3865 tf->hob_feature = all;
3867 tf->lbah = (block >> 16) & 0xff;
3868 tf->lbam = (block >> 8) & 0xff;
3869 tf->lbal = block & 0xff;
3870 tf->hob_lbah = (block >> 40) & 0xff;
3871 tf->hob_lbam = (block >> 32) & 0xff;
3872 tf->hob_lbal = (block >> 24) & 0xff;
3873 tf->device = ATA_LBA;
3874 tf->flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE | ATA_TFLAG_LBA48;
3876 return 0;
3878 invalid_fld:
3879 ata_scsi_set_invalid_field(qc->dev, scmd, fp, 0xff);
3880 return 1;
3881 out_of_range:
3882 /* "Logical Block Address out of range" */
3883 ata_scsi_set_sense(qc->dev, scmd, ILLEGAL_REQUEST, 0x21, 0x00);
3884 return 1;
3885 invalid_param_len:
3886 /* "Parameter list length error" */
3887 ata_scsi_set_sense(qc->dev, scmd, ILLEGAL_REQUEST, 0x1a, 0x0);
3888 return 1;
3892 * ata_mselect_caching - Simulate MODE SELECT for caching info page
3893 * @qc: Storage for translated ATA taskfile
3894 * @buf: input buffer
3895 * @len: number of valid bytes in the input buffer
3896 * @fp: out parameter for the failed field on error
3898 * Prepare a taskfile to modify caching information for the device.
3900 * LOCKING:
3901 * None.
3903 static int ata_mselect_caching(struct ata_queued_cmd *qc,
3904 const u8 *buf, int len, u16 *fp)
3906 struct ata_taskfile *tf = &qc->tf;
3907 struct ata_device *dev = qc->dev;
3908 u8 mpage[CACHE_MPAGE_LEN];
3909 u8 wce;
3910 int i;
3913 * The first two bytes of def_cache_mpage are a header, so offsets
3914 * in mpage are off by 2 compared to buf. Same for len.
3917 if (len != CACHE_MPAGE_LEN - 2) {
3918 if (len < CACHE_MPAGE_LEN - 2)
3919 *fp = len;
3920 else
3921 *fp = CACHE_MPAGE_LEN - 2;
3922 return -EINVAL;
3925 wce = buf[0] & (1 << 2);
3928 * Check that read-only bits are not modified.
3930 ata_msense_caching(dev->id, mpage, false);
3931 for (i = 0; i < CACHE_MPAGE_LEN - 2; i++) {
3932 if (i == 0)
3933 continue;
3934 if (mpage[i + 2] != buf[i]) {
3935 *fp = i;
3936 return -EINVAL;
3940 tf->flags |= ATA_TFLAG_DEVICE | ATA_TFLAG_ISADDR;
3941 tf->protocol = ATA_PROT_NODATA;
3942 tf->nsect = 0;
3943 tf->command = ATA_CMD_SET_FEATURES;
3944 tf->feature = wce ? SETFEATURES_WC_ON : SETFEATURES_WC_OFF;
3945 return 0;
3949 * ata_mselect_control - Simulate MODE SELECT for control page
3950 * @qc: Storage for translated ATA taskfile
3951 * @buf: input buffer
3952 * @len: number of valid bytes in the input buffer
3953 * @fp: out parameter for the failed field on error
3955 * Prepare a taskfile to modify caching information for the device.
3957 * LOCKING:
3958 * None.
3960 static int ata_mselect_control(struct ata_queued_cmd *qc,
3961 const u8 *buf, int len, u16 *fp)
3963 struct ata_device *dev = qc->dev;
3964 u8 mpage[CONTROL_MPAGE_LEN];
3965 u8 d_sense;
3966 int i;
3969 * The first two bytes of def_control_mpage are a header, so offsets
3970 * in mpage are off by 2 compared to buf. Same for len.
3973 if (len != CONTROL_MPAGE_LEN - 2) {
3974 if (len < CONTROL_MPAGE_LEN - 2)
3975 *fp = len;
3976 else
3977 *fp = CONTROL_MPAGE_LEN - 2;
3978 return -EINVAL;
3981 d_sense = buf[0] & (1 << 2);
3984 * Check that read-only bits are not modified.
3986 ata_msense_control(dev, mpage, false);
3987 for (i = 0; i < CONTROL_MPAGE_LEN - 2; i++) {
3988 if (i == 0)
3989 continue;
3990 if (mpage[2 + i] != buf[i]) {
3991 *fp = i;
3992 return -EINVAL;
3995 if (d_sense & (1 << 2))
3996 dev->flags |= ATA_DFLAG_D_SENSE;
3997 else
3998 dev->flags &= ~ATA_DFLAG_D_SENSE;
3999 return 0;
4003 * ata_scsiop_mode_select - Simulate MODE SELECT 6, 10 commands
4004 * @qc: Storage for translated ATA taskfile
4006 * Converts a MODE SELECT command to an ATA SET FEATURES taskfile.
4007 * Assume this is invoked for direct access devices (e.g. disks) only.
4008 * There should be no block descriptor for other device types.
4010 * LOCKING:
4011 * spin_lock_irqsave(host lock)
4013 static unsigned int ata_scsi_mode_select_xlat(struct ata_queued_cmd *qc)
4015 struct scsi_cmnd *scmd = qc->scsicmd;
4016 const u8 *cdb = scmd->cmnd;
4017 const u8 *p;
4018 u8 pg, spg;
4019 unsigned six_byte, pg_len, hdr_len, bd_len;
4020 int len;
4021 u16 fp = (u16)-1;
4022 u8 bp = 0xff;
4024 VPRINTK("ENTER\n");
4026 six_byte = (cdb[0] == MODE_SELECT);
4027 if (six_byte) {
4028 if (scmd->cmd_len < 5) {
4029 fp = 4;
4030 goto invalid_fld;
4033 len = cdb[4];
4034 hdr_len = 4;
4035 } else {
4036 if (scmd->cmd_len < 9) {
4037 fp = 8;
4038 goto invalid_fld;
4041 len = (cdb[7] << 8) + cdb[8];
4042 hdr_len = 8;
4045 /* We only support PF=1, SP=0. */
4046 if ((cdb[1] & 0x11) != 0x10) {
4047 fp = 1;
4048 bp = (cdb[1] & 0x01) ? 1 : 5;
4049 goto invalid_fld;
4052 /* Test early for possible overrun. */
4053 if (!scsi_sg_count(scmd) || scsi_sglist(scmd)->length < len)
4054 goto invalid_param_len;
4056 p = page_address(sg_page(scsi_sglist(scmd)));
4058 /* Move past header and block descriptors. */
4059 if (len < hdr_len)
4060 goto invalid_param_len;
4062 if (six_byte)
4063 bd_len = p[3];
4064 else
4065 bd_len = (p[6] << 8) + p[7];
4067 len -= hdr_len;
4068 p += hdr_len;
4069 if (len < bd_len)
4070 goto invalid_param_len;
4071 if (bd_len != 0 && bd_len != 8) {
4072 fp = (six_byte) ? 3 : 6;
4073 fp += bd_len + hdr_len;
4074 goto invalid_param;
4077 len -= bd_len;
4078 p += bd_len;
4079 if (len == 0)
4080 goto skip;
4082 /* Parse both possible formats for the mode page headers. */
4083 pg = p[0] & 0x3f;
4084 if (p[0] & 0x40) {
4085 if (len < 4)
4086 goto invalid_param_len;
4088 spg = p[1];
4089 pg_len = (p[2] << 8) | p[3];
4090 p += 4;
4091 len -= 4;
4092 } else {
4093 if (len < 2)
4094 goto invalid_param_len;
4096 spg = 0;
4097 pg_len = p[1];
4098 p += 2;
4099 len -= 2;
4103 * No mode subpages supported (yet) but asking for _all_
4104 * subpages may be valid
4106 if (spg && (spg != ALL_SUB_MPAGES)) {
4107 fp = (p[0] & 0x40) ? 1 : 0;
4108 fp += hdr_len + bd_len;
4109 goto invalid_param;
4111 if (pg_len > len)
4112 goto invalid_param_len;
4114 switch (pg) {
4115 case CACHE_MPAGE:
4116 if (ata_mselect_caching(qc, p, pg_len, &fp) < 0) {
4117 fp += hdr_len + bd_len;
4118 goto invalid_param;
4120 break;
4121 case CONTROL_MPAGE:
4122 if (ata_mselect_control(qc, p, pg_len, &fp) < 0) {
4123 fp += hdr_len + bd_len;
4124 goto invalid_param;
4125 } else {
4126 goto skip; /* No ATA command to send */
4128 break;
4129 default: /* invalid page code */
4130 fp = bd_len + hdr_len;
4131 goto invalid_param;
4135 * Only one page has changeable data, so we only support setting one
4136 * page at a time.
4138 if (len > pg_len)
4139 goto invalid_param;
4141 return 0;
4143 invalid_fld:
4144 ata_scsi_set_invalid_field(qc->dev, scmd, fp, bp);
4145 return 1;
4147 invalid_param:
4148 ata_scsi_set_invalid_parameter(qc->dev, scmd, fp);
4149 return 1;
4151 invalid_param_len:
4152 /* "Parameter list length error" */
4153 ata_scsi_set_sense(qc->dev, scmd, ILLEGAL_REQUEST, 0x1a, 0x0);
4154 return 1;
4156 skip:
4157 scmd->result = SAM_STAT_GOOD;
4158 return 1;
4162 * ata_get_xlat_func - check if SCSI to ATA translation is possible
4163 * @dev: ATA device
4164 * @cmd: SCSI command opcode to consider
4166 * Look up the SCSI command given, and determine whether the
4167 * SCSI command is to be translated or simulated.
4169 * RETURNS:
4170 * Pointer to translation function if possible, %NULL if not.
4173 static inline ata_xlat_func_t ata_get_xlat_func(struct ata_device *dev, u8 cmd)
4175 switch (cmd) {
4176 case READ_6:
4177 case READ_10:
4178 case READ_16:
4180 case WRITE_6:
4181 case WRITE_10:
4182 case WRITE_16:
4183 return ata_scsi_rw_xlat;
4185 case WRITE_SAME_16:
4186 return ata_scsi_write_same_xlat;
4188 case SYNCHRONIZE_CACHE:
4189 if (ata_try_flush_cache(dev))
4190 return ata_scsi_flush_xlat;
4191 break;
4193 case VERIFY:
4194 case VERIFY_16:
4195 return ata_scsi_verify_xlat;
4197 case ATA_12:
4198 case ATA_16:
4199 return ata_scsi_pass_thru;
4201 case MODE_SELECT:
4202 case MODE_SELECT_10:
4203 return ata_scsi_mode_select_xlat;
4204 break;
4206 case ZBC_IN:
4207 return ata_scsi_zbc_in_xlat;
4209 case ZBC_OUT:
4210 return ata_scsi_zbc_out_xlat;
4212 case START_STOP:
4213 return ata_scsi_start_stop_xlat;
4216 return NULL;
4220 * ata_scsi_dump_cdb - dump SCSI command contents to dmesg
4221 * @ap: ATA port to which the command was being sent
4222 * @cmd: SCSI command to dump
4224 * Prints the contents of a SCSI command via printk().
4227 static inline void ata_scsi_dump_cdb(struct ata_port *ap,
4228 struct scsi_cmnd *cmd)
4230 #ifdef ATA_DEBUG
4231 struct scsi_device *scsidev = cmd->device;
4233 DPRINTK("CDB (%u:%d,%d,%d) %9ph\n",
4234 ap->print_id,
4235 scsidev->channel, scsidev->id, scsidev->lun,
4236 cmd->cmnd);
4237 #endif
4240 static inline int __ata_scsi_queuecmd(struct scsi_cmnd *scmd,
4241 struct ata_device *dev)
4243 u8 scsi_op = scmd->cmnd[0];
4244 ata_xlat_func_t xlat_func;
4245 int rc = 0;
4247 if (dev->class == ATA_DEV_ATA || dev->class == ATA_DEV_ZAC) {
4248 if (unlikely(!scmd->cmd_len || scmd->cmd_len > dev->cdb_len))
4249 goto bad_cdb_len;
4251 xlat_func = ata_get_xlat_func(dev, scsi_op);
4252 } else {
4253 if (unlikely(!scmd->cmd_len))
4254 goto bad_cdb_len;
4256 xlat_func = NULL;
4257 if (likely((scsi_op != ATA_16) || !atapi_passthru16)) {
4258 /* relay SCSI command to ATAPI device */
4259 int len = COMMAND_SIZE(scsi_op);
4260 if (unlikely(len > scmd->cmd_len || len > dev->cdb_len))
4261 goto bad_cdb_len;
4263 xlat_func = atapi_xlat;
4264 } else {
4265 /* ATA_16 passthru, treat as an ATA command */
4266 if (unlikely(scmd->cmd_len > 16))
4267 goto bad_cdb_len;
4269 xlat_func = ata_get_xlat_func(dev, scsi_op);
4273 if (xlat_func)
4274 rc = ata_scsi_translate(dev, scmd, xlat_func);
4275 else
4276 ata_scsi_simulate(dev, scmd);
4278 return rc;
4280 bad_cdb_len:
4281 DPRINTK("bad CDB len=%u, scsi_op=0x%02x, max=%u\n",
4282 scmd->cmd_len, scsi_op, dev->cdb_len);
4283 scmd->result = DID_ERROR << 16;
4284 scmd->scsi_done(scmd);
4285 return 0;
4289 * ata_scsi_queuecmd - Issue SCSI cdb to libata-managed device
4290 * @shost: SCSI host of command to be sent
4291 * @cmd: SCSI command to be sent
4293 * In some cases, this function translates SCSI commands into
4294 * ATA taskfiles, and queues the taskfiles to be sent to
4295 * hardware. In other cases, this function simulates a
4296 * SCSI device by evaluating and responding to certain
4297 * SCSI commands. This creates the overall effect of
4298 * ATA and ATAPI devices appearing as SCSI devices.
4300 * LOCKING:
4301 * ATA host lock
4303 * RETURNS:
4304 * Return value from __ata_scsi_queuecmd() if @cmd can be queued,
4305 * 0 otherwise.
4307 int ata_scsi_queuecmd(struct Scsi_Host *shost, struct scsi_cmnd *cmd)
4309 struct ata_port *ap;
4310 struct ata_device *dev;
4311 struct scsi_device *scsidev = cmd->device;
4312 int rc = 0;
4313 unsigned long irq_flags;
4315 ap = ata_shost_to_port(shost);
4317 spin_lock_irqsave(ap->lock, irq_flags);
4319 ata_scsi_dump_cdb(ap, cmd);
4321 dev = ata_scsi_find_dev(ap, scsidev);
4322 if (likely(dev))
4323 rc = __ata_scsi_queuecmd(cmd, dev);
4324 else {
4325 cmd->result = (DID_BAD_TARGET << 16);
4326 cmd->scsi_done(cmd);
4329 spin_unlock_irqrestore(ap->lock, irq_flags);
4331 return rc;
4335 * ata_scsi_simulate - simulate SCSI command on ATA device
4336 * @dev: the target device
4337 * @cmd: SCSI command being sent to device.
4339 * Interprets and directly executes a select list of SCSI commands
4340 * that can be handled internally.
4342 * LOCKING:
4343 * spin_lock_irqsave(host lock)
4346 void ata_scsi_simulate(struct ata_device *dev, struct scsi_cmnd *cmd)
4348 struct ata_scsi_args args;
4349 const u8 *scsicmd = cmd->cmnd;
4350 u8 tmp8;
4352 args.dev = dev;
4353 args.id = dev->id;
4354 args.cmd = cmd;
4355 args.done = cmd->scsi_done;
4357 switch(scsicmd[0]) {
4358 case INQUIRY:
4359 if (scsicmd[1] & 2) /* is CmdDt set? */
4360 ata_scsi_invalid_field(dev, cmd, 1);
4361 else if ((scsicmd[1] & 1) == 0) /* is EVPD clear? */
4362 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_std);
4363 else switch (scsicmd[2]) {
4364 case 0x00:
4365 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_00);
4366 break;
4367 case 0x80:
4368 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_80);
4369 break;
4370 case 0x83:
4371 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_83);
4372 break;
4373 case 0x89:
4374 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_89);
4375 break;
4376 case 0xb0:
4377 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_b0);
4378 break;
4379 case 0xb1:
4380 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_b1);
4381 break;
4382 case 0xb2:
4383 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_b2);
4384 break;
4385 case 0xb6:
4386 if (dev->flags & ATA_DFLAG_ZAC) {
4387 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_b6);
4388 break;
4390 /* Fallthrough */
4391 default:
4392 ata_scsi_invalid_field(dev, cmd, 2);
4393 break;
4395 break;
4397 case MODE_SENSE:
4398 case MODE_SENSE_10:
4399 ata_scsi_rbuf_fill(&args, ata_scsiop_mode_sense);
4400 break;
4402 case READ_CAPACITY:
4403 ata_scsi_rbuf_fill(&args, ata_scsiop_read_cap);
4404 break;
4406 case SERVICE_ACTION_IN_16:
4407 if ((scsicmd[1] & 0x1f) == SAI_READ_CAPACITY_16)
4408 ata_scsi_rbuf_fill(&args, ata_scsiop_read_cap);
4409 else
4410 ata_scsi_invalid_field(dev, cmd, 1);
4411 break;
4413 case REPORT_LUNS:
4414 ata_scsi_rbuf_fill(&args, ata_scsiop_report_luns);
4415 break;
4417 case REQUEST_SENSE:
4418 ata_scsi_set_sense(dev, cmd, 0, 0, 0);
4419 cmd->result = (DRIVER_SENSE << 24);
4420 cmd->scsi_done(cmd);
4421 break;
4423 /* if we reach this, then writeback caching is disabled,
4424 * turning this into a no-op.
4426 case SYNCHRONIZE_CACHE:
4427 /* fall through */
4429 /* no-op's, complete with success */
4430 case REZERO_UNIT:
4431 case SEEK_6:
4432 case SEEK_10:
4433 case TEST_UNIT_READY:
4434 ata_scsi_rbuf_fill(&args, ata_scsiop_noop);
4435 break;
4437 case SEND_DIAGNOSTIC:
4438 tmp8 = scsicmd[1] & ~(1 << 3);
4439 if ((tmp8 == 0x4) && (!scsicmd[3]) && (!scsicmd[4]))
4440 ata_scsi_rbuf_fill(&args, ata_scsiop_noop);
4441 else
4442 ata_scsi_invalid_field(dev, cmd, 1);
4443 break;
4445 case MAINTENANCE_IN:
4446 if (scsicmd[1] == MI_REPORT_SUPPORTED_OPERATION_CODES)
4447 ata_scsi_rbuf_fill(&args, ata_scsiop_maint_in);
4448 else
4449 ata_scsi_invalid_field(dev, cmd, 1);
4450 break;
4452 /* all other commands */
4453 default:
4454 ata_scsi_set_sense(dev, cmd, ILLEGAL_REQUEST, 0x20, 0x0);
4455 /* "Invalid command operation code" */
4456 cmd->scsi_done(cmd);
4457 break;
4461 int ata_scsi_add_hosts(struct ata_host *host, struct scsi_host_template *sht)
4463 int i, rc;
4465 for (i = 0; i < host->n_ports; i++) {
4466 struct ata_port *ap = host->ports[i];
4467 struct Scsi_Host *shost;
4469 rc = -ENOMEM;
4470 shost = scsi_host_alloc(sht, sizeof(struct ata_port *));
4471 if (!shost)
4472 goto err_alloc;
4474 shost->eh_noresume = 1;
4475 *(struct ata_port **)&shost->hostdata[0] = ap;
4476 ap->scsi_host = shost;
4478 shost->transportt = ata_scsi_transport_template;
4479 shost->unique_id = ap->print_id;
4480 shost->max_id = 16;
4481 shost->max_lun = 1;
4482 shost->max_channel = 1;
4483 shost->max_cmd_len = 16;
4485 /* Schedule policy is determined by ->qc_defer()
4486 * callback and it needs to see every deferred qc.
4487 * Set host_blocked to 1 to prevent SCSI midlayer from
4488 * automatically deferring requests.
4490 shost->max_host_blocked = 1;
4492 rc = scsi_add_host_with_dma(ap->scsi_host,
4493 &ap->tdev, ap->host->dev);
4494 if (rc)
4495 goto err_add;
4498 return 0;
4500 err_add:
4501 scsi_host_put(host->ports[i]->scsi_host);
4502 err_alloc:
4503 while (--i >= 0) {
4504 struct Scsi_Host *shost = host->ports[i]->scsi_host;
4506 scsi_remove_host(shost);
4507 scsi_host_put(shost);
4509 return rc;
4512 void ata_scsi_scan_host(struct ata_port *ap, int sync)
4514 int tries = 5;
4515 struct ata_device *last_failed_dev = NULL;
4516 struct ata_link *link;
4517 struct ata_device *dev;
4519 repeat:
4520 ata_for_each_link(link, ap, EDGE) {
4521 ata_for_each_dev(dev, link, ENABLED) {
4522 struct scsi_device *sdev;
4523 int channel = 0, id = 0;
4525 if (dev->sdev)
4526 continue;
4528 if (ata_is_host_link(link))
4529 id = dev->devno;
4530 else
4531 channel = link->pmp;
4533 sdev = __scsi_add_device(ap->scsi_host, channel, id, 0,
4534 NULL);
4535 if (!IS_ERR(sdev)) {
4536 dev->sdev = sdev;
4537 scsi_device_put(sdev);
4538 } else {
4539 dev->sdev = NULL;
4544 /* If we scanned while EH was in progress or allocation
4545 * failure occurred, scan would have failed silently. Check
4546 * whether all devices are attached.
4548 ata_for_each_link(link, ap, EDGE) {
4549 ata_for_each_dev(dev, link, ENABLED) {
4550 if (!dev->sdev)
4551 goto exit_loop;
4554 exit_loop:
4555 if (!link)
4556 return;
4558 /* we're missing some SCSI devices */
4559 if (sync) {
4560 /* If caller requested synchrnous scan && we've made
4561 * any progress, sleep briefly and repeat.
4563 if (dev != last_failed_dev) {
4564 msleep(100);
4565 last_failed_dev = dev;
4566 goto repeat;
4569 /* We might be failing to detect boot device, give it
4570 * a few more chances.
4572 if (--tries) {
4573 msleep(100);
4574 goto repeat;
4577 ata_port_err(ap,
4578 "WARNING: synchronous SCSI scan failed without making any progress, switching to async\n");
4581 queue_delayed_work(system_long_wq, &ap->hotplug_task,
4582 round_jiffies_relative(HZ));
4586 * ata_scsi_offline_dev - offline attached SCSI device
4587 * @dev: ATA device to offline attached SCSI device for
4589 * This function is called from ata_eh_hotplug() and responsible
4590 * for taking the SCSI device attached to @dev offline. This
4591 * function is called with host lock which protects dev->sdev
4592 * against clearing.
4594 * LOCKING:
4595 * spin_lock_irqsave(host lock)
4597 * RETURNS:
4598 * 1 if attached SCSI device exists, 0 otherwise.
4600 int ata_scsi_offline_dev(struct ata_device *dev)
4602 if (dev->sdev) {
4603 scsi_device_set_state(dev->sdev, SDEV_OFFLINE);
4604 return 1;
4606 return 0;
4610 * ata_scsi_remove_dev - remove attached SCSI device
4611 * @dev: ATA device to remove attached SCSI device for
4613 * This function is called from ata_eh_scsi_hotplug() and
4614 * responsible for removing the SCSI device attached to @dev.
4616 * LOCKING:
4617 * Kernel thread context (may sleep).
4619 static void ata_scsi_remove_dev(struct ata_device *dev)
4621 struct ata_port *ap = dev->link->ap;
4622 struct scsi_device *sdev;
4623 unsigned long flags;
4625 /* Alas, we need to grab scan_mutex to ensure SCSI device
4626 * state doesn't change underneath us and thus
4627 * scsi_device_get() always succeeds. The mutex locking can
4628 * be removed if there is __scsi_device_get() interface which
4629 * increments reference counts regardless of device state.
4631 mutex_lock(&ap->scsi_host->scan_mutex);
4632 spin_lock_irqsave(ap->lock, flags);
4634 /* clearing dev->sdev is protected by host lock */
4635 sdev = dev->sdev;
4636 dev->sdev = NULL;
4638 if (sdev) {
4639 /* If user initiated unplug races with us, sdev can go
4640 * away underneath us after the host lock and
4641 * scan_mutex are released. Hold onto it.
4643 if (scsi_device_get(sdev) == 0) {
4644 /* The following ensures the attached sdev is
4645 * offline on return from ata_scsi_offline_dev()
4646 * regardless it wins or loses the race
4647 * against this function.
4649 scsi_device_set_state(sdev, SDEV_OFFLINE);
4650 } else {
4651 WARN_ON(1);
4652 sdev = NULL;
4656 spin_unlock_irqrestore(ap->lock, flags);
4657 mutex_unlock(&ap->scsi_host->scan_mutex);
4659 if (sdev) {
4660 ata_dev_info(dev, "detaching (SCSI %s)\n",
4661 dev_name(&sdev->sdev_gendev));
4663 scsi_remove_device(sdev);
4664 scsi_device_put(sdev);
4668 static void ata_scsi_handle_link_detach(struct ata_link *link)
4670 struct ata_port *ap = link->ap;
4671 struct ata_device *dev;
4673 ata_for_each_dev(dev, link, ALL) {
4674 unsigned long flags;
4676 if (!(dev->flags & ATA_DFLAG_DETACHED))
4677 continue;
4679 spin_lock_irqsave(ap->lock, flags);
4680 dev->flags &= ~ATA_DFLAG_DETACHED;
4681 spin_unlock_irqrestore(ap->lock, flags);
4683 if (zpodd_dev_enabled(dev))
4684 zpodd_exit(dev);
4686 ata_scsi_remove_dev(dev);
4691 * ata_scsi_media_change_notify - send media change event
4692 * @dev: Pointer to the disk device with media change event
4694 * Tell the block layer to send a media change notification
4695 * event.
4697 * LOCKING:
4698 * spin_lock_irqsave(host lock)
4700 void ata_scsi_media_change_notify(struct ata_device *dev)
4702 if (dev->sdev)
4703 sdev_evt_send_simple(dev->sdev, SDEV_EVT_MEDIA_CHANGE,
4704 GFP_ATOMIC);
4708 * ata_scsi_hotplug - SCSI part of hotplug
4709 * @work: Pointer to ATA port to perform SCSI hotplug on
4711 * Perform SCSI part of hotplug. It's executed from a separate
4712 * workqueue after EH completes. This is necessary because SCSI
4713 * hot plugging requires working EH and hot unplugging is
4714 * synchronized with hot plugging with a mutex.
4716 * LOCKING:
4717 * Kernel thread context (may sleep).
4719 void ata_scsi_hotplug(struct work_struct *work)
4721 struct ata_port *ap =
4722 container_of(work, struct ata_port, hotplug_task.work);
4723 int i;
4725 if (ap->pflags & ATA_PFLAG_UNLOADING) {
4726 DPRINTK("ENTER/EXIT - unloading\n");
4727 return;
4731 * XXX - UGLY HACK
4733 * The block layer suspend/resume path is fundamentally broken due
4734 * to freezable kthreads and workqueue and may deadlock if a block
4735 * device gets removed while resume is in progress. I don't know
4736 * what the solution is short of removing freezable kthreads and
4737 * workqueues altogether.
4739 * The following is an ugly hack to avoid kicking off device
4740 * removal while freezer is active. This is a joke but does avoid
4741 * this particular deadlock scenario.
4743 * https://bugzilla.kernel.org/show_bug.cgi?id=62801
4744 * http://marc.info/?l=linux-kernel&m=138695698516487
4746 #ifdef CONFIG_FREEZER
4747 while (pm_freezing)
4748 msleep(10);
4749 #endif
4751 DPRINTK("ENTER\n");
4752 mutex_lock(&ap->scsi_scan_mutex);
4754 /* Unplug detached devices. We cannot use link iterator here
4755 * because PMP links have to be scanned even if PMP is
4756 * currently not attached. Iterate manually.
4758 ata_scsi_handle_link_detach(&ap->link);
4759 if (ap->pmp_link)
4760 for (i = 0; i < SATA_PMP_MAX_PORTS; i++)
4761 ata_scsi_handle_link_detach(&ap->pmp_link[i]);
4763 /* scan for new ones */
4764 ata_scsi_scan_host(ap, 0);
4766 mutex_unlock(&ap->scsi_scan_mutex);
4767 DPRINTK("EXIT\n");
4771 * ata_scsi_user_scan - indication for user-initiated bus scan
4772 * @shost: SCSI host to scan
4773 * @channel: Channel to scan
4774 * @id: ID to scan
4775 * @lun: LUN to scan
4777 * This function is called when user explicitly requests bus
4778 * scan. Set probe pending flag and invoke EH.
4780 * LOCKING:
4781 * SCSI layer (we don't care)
4783 * RETURNS:
4784 * Zero.
4786 int ata_scsi_user_scan(struct Scsi_Host *shost, unsigned int channel,
4787 unsigned int id, u64 lun)
4789 struct ata_port *ap = ata_shost_to_port(shost);
4790 unsigned long flags;
4791 int devno, rc = 0;
4793 if (!ap->ops->error_handler)
4794 return -EOPNOTSUPP;
4796 if (lun != SCAN_WILD_CARD && lun)
4797 return -EINVAL;
4799 if (!sata_pmp_attached(ap)) {
4800 if (channel != SCAN_WILD_CARD && channel)
4801 return -EINVAL;
4802 devno = id;
4803 } else {
4804 if (id != SCAN_WILD_CARD && id)
4805 return -EINVAL;
4806 devno = channel;
4809 spin_lock_irqsave(ap->lock, flags);
4811 if (devno == SCAN_WILD_CARD) {
4812 struct ata_link *link;
4814 ata_for_each_link(link, ap, EDGE) {
4815 struct ata_eh_info *ehi = &link->eh_info;
4816 ehi->probe_mask |= ATA_ALL_DEVICES;
4817 ehi->action |= ATA_EH_RESET;
4819 } else {
4820 struct ata_device *dev = ata_find_dev(ap, devno);
4822 if (dev) {
4823 struct ata_eh_info *ehi = &dev->link->eh_info;
4824 ehi->probe_mask |= 1 << dev->devno;
4825 ehi->action |= ATA_EH_RESET;
4826 } else
4827 rc = -EINVAL;
4830 if (rc == 0) {
4831 ata_port_schedule_eh(ap);
4832 spin_unlock_irqrestore(ap->lock, flags);
4833 ata_port_wait_eh(ap);
4834 } else
4835 spin_unlock_irqrestore(ap->lock, flags);
4837 return rc;
4841 * ata_scsi_dev_rescan - initiate scsi_rescan_device()
4842 * @work: Pointer to ATA port to perform scsi_rescan_device()
4844 * After ATA pass thru (SAT) commands are executed successfully,
4845 * libata need to propagate the changes to SCSI layer.
4847 * LOCKING:
4848 * Kernel thread context (may sleep).
4850 void ata_scsi_dev_rescan(struct work_struct *work)
4852 struct ata_port *ap =
4853 container_of(work, struct ata_port, scsi_rescan_task);
4854 struct ata_link *link;
4855 struct ata_device *dev;
4856 unsigned long flags;
4858 mutex_lock(&ap->scsi_scan_mutex);
4859 spin_lock_irqsave(ap->lock, flags);
4861 ata_for_each_link(link, ap, EDGE) {
4862 ata_for_each_dev(dev, link, ENABLED) {
4863 struct scsi_device *sdev = dev->sdev;
4865 if (!sdev)
4866 continue;
4867 if (scsi_device_get(sdev))
4868 continue;
4870 spin_unlock_irqrestore(ap->lock, flags);
4871 scsi_rescan_device(&(sdev->sdev_gendev));
4872 scsi_device_put(sdev);
4873 spin_lock_irqsave(ap->lock, flags);
4877 spin_unlock_irqrestore(ap->lock, flags);
4878 mutex_unlock(&ap->scsi_scan_mutex);
4882 * ata_sas_port_alloc - Allocate port for a SAS attached SATA device
4883 * @host: ATA host container for all SAS ports
4884 * @port_info: Information from low-level host driver
4885 * @shost: SCSI host that the scsi device is attached to
4887 * LOCKING:
4888 * PCI/etc. bus probe sem.
4890 * RETURNS:
4891 * ata_port pointer on success / NULL on failure.
4894 struct ata_port *ata_sas_port_alloc(struct ata_host *host,
4895 struct ata_port_info *port_info,
4896 struct Scsi_Host *shost)
4898 struct ata_port *ap;
4900 ap = ata_port_alloc(host);
4901 if (!ap)
4902 return NULL;
4904 ap->port_no = 0;
4905 ap->lock = &host->lock;
4906 ap->pio_mask = port_info->pio_mask;
4907 ap->mwdma_mask = port_info->mwdma_mask;
4908 ap->udma_mask = port_info->udma_mask;
4909 ap->flags |= port_info->flags;
4910 ap->ops = port_info->port_ops;
4911 ap->cbl = ATA_CBL_SATA;
4913 return ap;
4915 EXPORT_SYMBOL_GPL(ata_sas_port_alloc);
4918 * ata_sas_port_start - Set port up for dma.
4919 * @ap: Port to initialize
4921 * Called just after data structures for each port are
4922 * initialized.
4924 * May be used as the port_start() entry in ata_port_operations.
4926 * LOCKING:
4927 * Inherited from caller.
4929 int ata_sas_port_start(struct ata_port *ap)
4932 * the port is marked as frozen at allocation time, but if we don't
4933 * have new eh, we won't thaw it
4935 if (!ap->ops->error_handler)
4936 ap->pflags &= ~ATA_PFLAG_FROZEN;
4937 return 0;
4939 EXPORT_SYMBOL_GPL(ata_sas_port_start);
4942 * ata_port_stop - Undo ata_sas_port_start()
4943 * @ap: Port to shut down
4945 * May be used as the port_stop() entry in ata_port_operations.
4947 * LOCKING:
4948 * Inherited from caller.
4951 void ata_sas_port_stop(struct ata_port *ap)
4954 EXPORT_SYMBOL_GPL(ata_sas_port_stop);
4957 * ata_sas_async_probe - simply schedule probing and return
4958 * @ap: Port to probe
4960 * For batch scheduling of probe for sas attached ata devices, assumes
4961 * the port has already been through ata_sas_port_init()
4963 void ata_sas_async_probe(struct ata_port *ap)
4965 __ata_port_probe(ap);
4967 EXPORT_SYMBOL_GPL(ata_sas_async_probe);
4969 int ata_sas_sync_probe(struct ata_port *ap)
4971 return ata_port_probe(ap);
4973 EXPORT_SYMBOL_GPL(ata_sas_sync_probe);
4977 * ata_sas_port_init - Initialize a SATA device
4978 * @ap: SATA port to initialize
4980 * LOCKING:
4981 * PCI/etc. bus probe sem.
4983 * RETURNS:
4984 * Zero on success, non-zero on error.
4987 int ata_sas_port_init(struct ata_port *ap)
4989 int rc = ap->ops->port_start(ap);
4991 if (rc)
4992 return rc;
4993 ap->print_id = atomic_inc_return(&ata_print_id);
4994 return 0;
4996 EXPORT_SYMBOL_GPL(ata_sas_port_init);
4999 * ata_sas_port_destroy - Destroy a SATA port allocated by ata_sas_port_alloc
5000 * @ap: SATA port to destroy
5004 void ata_sas_port_destroy(struct ata_port *ap)
5006 if (ap->ops->port_stop)
5007 ap->ops->port_stop(ap);
5008 kfree(ap);
5010 EXPORT_SYMBOL_GPL(ata_sas_port_destroy);
5013 * ata_sas_slave_configure - Default slave_config routine for libata devices
5014 * @sdev: SCSI device to configure
5015 * @ap: ATA port to which SCSI device is attached
5017 * RETURNS:
5018 * Zero.
5021 int ata_sas_slave_configure(struct scsi_device *sdev, struct ata_port *ap)
5023 ata_scsi_sdev_config(sdev);
5024 ata_scsi_dev_config(sdev, ap->link.device);
5025 return 0;
5027 EXPORT_SYMBOL_GPL(ata_sas_slave_configure);
5030 * ata_sas_queuecmd - Issue SCSI cdb to libata-managed device
5031 * @cmd: SCSI command to be sent
5032 * @ap: ATA port to which the command is being sent
5034 * RETURNS:
5035 * Return value from __ata_scsi_queuecmd() if @cmd can be queued,
5036 * 0 otherwise.
5039 int ata_sas_queuecmd(struct scsi_cmnd *cmd, struct ata_port *ap)
5041 int rc = 0;
5043 ata_scsi_dump_cdb(ap, cmd);
5045 if (likely(ata_dev_enabled(ap->link.device)))
5046 rc = __ata_scsi_queuecmd(cmd, ap->link.device);
5047 else {
5048 cmd->result = (DID_BAD_TARGET << 16);
5049 cmd->scsi_done(cmd);
5051 return rc;
5053 EXPORT_SYMBOL_GPL(ata_sas_queuecmd);
5055 int ata_sas_allocate_tag(struct ata_port *ap)
5057 unsigned int max_queue = ap->host->n_tags;
5058 unsigned int i, tag;
5060 for (i = 0, tag = ap->sas_last_tag + 1; i < max_queue; i++, tag++) {
5061 tag = tag < max_queue ? tag : 0;
5063 /* the last tag is reserved for internal command. */
5064 if (tag == ATA_TAG_INTERNAL)
5065 continue;
5067 if (!test_and_set_bit(tag, &ap->sas_tag_allocated)) {
5068 ap->sas_last_tag = tag;
5069 return tag;
5072 return -1;
5075 void ata_sas_free_tag(unsigned int tag, struct ata_port *ap)
5077 clear_bit(tag, &ap->sas_tag_allocated);