1 // SPDX-License-Identifier: GPL-2.0-or-later
3 * libata-scsi.c - helper library for ATA
5 * Copyright 2003-2004 Red Hat, Inc. All rights reserved.
6 * Copyright 2003-2004 Jeff Garzik
8 * libata documentation is available via 'make {ps|pdf}docs',
9 * as Documentation/driver-api/libata.rst
11 * Hardware documentation available from
12 * - http://www.t10.org/
13 * - http://www.t13.org/
16 #include <linux/compat.h>
17 #include <linux/slab.h>
18 #include <linux/kernel.h>
19 #include <linux/blkdev.h>
20 #include <linux/spinlock.h>
21 #include <linux/export.h>
22 #include <scsi/scsi.h>
23 #include <scsi/scsi_host.h>
24 #include <scsi/scsi_cmnd.h>
25 #include <scsi/scsi_eh.h>
26 #include <scsi/scsi_device.h>
27 #include <scsi/scsi_tcq.h>
28 #include <scsi/scsi_transport.h>
29 #include <linux/libata.h>
30 #include <linux/hdreg.h>
31 #include <linux/uaccess.h>
32 #include <linux/suspend.h>
33 #include <asm/unaligned.h>
34 #include <linux/ioprio.h>
38 #include "libata-transport.h"
40 #define ATA_SCSI_RBUF_SIZE 2048
42 static DEFINE_SPINLOCK(ata_scsi_rbuf_lock);
43 static u8 ata_scsi_rbuf[ATA_SCSI_RBUF_SIZE];
45 typedef unsigned int (*ata_xlat_func_t)(struct ata_queued_cmd *qc);
47 static struct ata_device *__ata_scsi_find_dev(struct ata_port *ap,
48 const struct scsi_device *scsidev);
50 #define RW_RECOVERY_MPAGE 0x1
51 #define RW_RECOVERY_MPAGE_LEN 12
52 #define CACHE_MPAGE 0x8
53 #define CACHE_MPAGE_LEN 20
54 #define CONTROL_MPAGE 0xa
55 #define CONTROL_MPAGE_LEN 12
56 #define ALL_MPAGES 0x3f
57 #define ALL_SUB_MPAGES 0xff
58 #define CDL_T2A_SUB_MPAGE 0x07
59 #define CDL_T2B_SUB_MPAGE 0x08
60 #define CDL_T2_SUB_MPAGE_LEN 232
61 #define ATA_FEATURE_SUB_MPAGE 0xf2
62 #define ATA_FEATURE_SUB_MPAGE_LEN 16
64 static const u8 def_rw_recovery_mpage[RW_RECOVERY_MPAGE_LEN] = {
66 RW_RECOVERY_MPAGE_LEN - 2,
68 0, /* read retry count */
70 0, /* write retry count */
74 static const u8 def_cache_mpage[CACHE_MPAGE_LEN] = {
77 0, /* contains WCE, needs to be 0 for logic */
78 0, 0, 0, 0, 0, 0, 0, 0, 0,
79 0, /* contains DRA, needs to be 0 for logic */
83 static const u8 def_control_mpage[CONTROL_MPAGE_LEN] = {
85 CONTROL_MPAGE_LEN - 2,
86 2, /* DSENSE=0, GLTSD=1 */
87 0, /* [QAM+QERR may be 1, see 05-359r1] */
88 0, 0, 0, 0, 0xff, 0xff,
89 0, 30 /* extended self test time, see 05-359r1 */
92 static ssize_t ata_scsi_park_show(struct device *device,
93 struct device_attribute *attr, char *buf)
95 struct scsi_device *sdev = to_scsi_device(device);
97 struct ata_link *link;
98 struct ata_device *dev;
103 ap = ata_shost_to_port(sdev->host);
105 spin_lock_irq(ap->lock);
106 dev = ata_scsi_find_dev(ap, sdev);
111 if (dev->flags & ATA_DFLAG_NO_UNLOAD) {
118 if (ap->pflags & ATA_PFLAG_EH_IN_PROGRESS &&
119 link->eh_context.unloaded_mask & (1 << dev->devno) &&
120 time_after(dev->unpark_deadline, now))
121 msecs = jiffies_to_msecs(dev->unpark_deadline - now);
126 spin_unlock_irq(ap->lock);
128 return rc ? rc : sysfs_emit(buf, "%u\n", msecs);
131 static ssize_t ata_scsi_park_store(struct device *device,
132 struct device_attribute *attr,
133 const char *buf, size_t len)
135 struct scsi_device *sdev = to_scsi_device(device);
137 struct ata_device *dev;
142 rc = kstrtoint(buf, 10, &input);
147 if (input > ATA_TMOUT_MAX_PARK) {
149 input = ATA_TMOUT_MAX_PARK;
152 ap = ata_shost_to_port(sdev->host);
154 spin_lock_irqsave(ap->lock, flags);
155 dev = ata_scsi_find_dev(ap, sdev);
156 if (unlikely(!dev)) {
160 if (dev->class != ATA_DEV_ATA &&
161 dev->class != ATA_DEV_ZAC) {
167 if (dev->flags & ATA_DFLAG_NO_UNLOAD) {
172 dev->unpark_deadline = ata_deadline(jiffies, input);
173 dev->link->eh_info.dev_action[dev->devno] |= ATA_EH_PARK;
174 ata_port_schedule_eh(ap);
175 complete(&ap->park_req_pending);
179 dev->flags &= ~ATA_DFLAG_NO_UNLOAD;
182 dev->flags |= ATA_DFLAG_NO_UNLOAD;
187 spin_unlock_irqrestore(ap->lock, flags);
189 return rc ? rc : len;
191 DEVICE_ATTR(unload_heads, S_IRUGO | S_IWUSR,
192 ata_scsi_park_show, ata_scsi_park_store);
193 EXPORT_SYMBOL_GPL(dev_attr_unload_heads);
195 bool ata_scsi_sense_is_valid(u8 sk, u8 asc, u8 ascq)
198 * If sk == NO_SENSE, and asc + ascq == NO ADDITIONAL SENSE INFORMATION,
199 * then there is no sense data to add.
201 if (sk == 0 && asc == 0 && ascq == 0)
204 /* If sk > COMPLETED, sense data is bogus. */
211 void ata_scsi_set_sense(struct ata_device *dev, struct scsi_cmnd *cmd,
212 u8 sk, u8 asc, u8 ascq)
214 bool d_sense = (dev->flags & ATA_DFLAG_D_SENSE);
216 scsi_build_sense(cmd, d_sense, sk, asc, ascq);
219 void ata_scsi_set_sense_information(struct ata_device *dev,
220 struct scsi_cmnd *cmd,
221 const struct ata_taskfile *tf)
225 information = ata_tf_read_block(tf, dev);
226 if (information == U64_MAX)
229 scsi_set_sense_information(cmd->sense_buffer,
230 SCSI_SENSE_BUFFERSIZE, information);
233 static void ata_scsi_set_invalid_field(struct ata_device *dev,
234 struct scsi_cmnd *cmd, u16 field, u8 bit)
236 ata_scsi_set_sense(dev, cmd, ILLEGAL_REQUEST, 0x24, 0x0);
237 /* "Invalid field in CDB" */
238 scsi_set_sense_field_pointer(cmd->sense_buffer, SCSI_SENSE_BUFFERSIZE,
242 static void ata_scsi_set_invalid_parameter(struct ata_device *dev,
243 struct scsi_cmnd *cmd, u16 field)
245 /* "Invalid field in parameter list" */
246 ata_scsi_set_sense(dev, cmd, ILLEGAL_REQUEST, 0x26, 0x0);
247 scsi_set_sense_field_pointer(cmd->sense_buffer, SCSI_SENSE_BUFFERSIZE,
251 static struct attribute *ata_common_sdev_attrs[] = {
252 &dev_attr_unload_heads.attr,
256 static const struct attribute_group ata_common_sdev_attr_group = {
257 .attrs = ata_common_sdev_attrs
260 const struct attribute_group *ata_common_sdev_groups[] = {
261 &ata_common_sdev_attr_group,
264 EXPORT_SYMBOL_GPL(ata_common_sdev_groups);
267 * ata_std_bios_param - generic bios head/sector/cylinder calculator used by sd.
268 * @sdev: SCSI device for which BIOS geometry is to be determined
269 * @bdev: block device associated with @sdev
270 * @capacity: capacity of SCSI device
271 * @geom: location to which geometry will be output
273 * Generic bios head/sector/cylinder calculator
274 * used by sd. Most BIOSes nowadays expect a XXX/255/16 (CHS)
275 * mapping. Some situations may arise where the disk is not
276 * bootable if this is not used.
279 * Defined by the SCSI layer. We don't really care.
284 int ata_std_bios_param(struct scsi_device *sdev, struct block_device *bdev,
285 sector_t capacity, int geom[])
289 sector_div(capacity, 255*63);
294 EXPORT_SYMBOL_GPL(ata_std_bios_param);
297 * ata_scsi_unlock_native_capacity - unlock native capacity
298 * @sdev: SCSI device to adjust device capacity for
300 * This function is called if a partition on @sdev extends beyond
301 * the end of the device. It requests EH to unlock HPA.
304 * Defined by the SCSI layer. Might sleep.
306 void ata_scsi_unlock_native_capacity(struct scsi_device *sdev)
308 struct ata_port *ap = ata_shost_to_port(sdev->host);
309 struct ata_device *dev;
312 spin_lock_irqsave(ap->lock, flags);
314 dev = ata_scsi_find_dev(ap, sdev);
315 if (dev && dev->n_sectors < dev->n_native_sectors) {
316 dev->flags |= ATA_DFLAG_UNLOCK_HPA;
317 dev->link->eh_info.action |= ATA_EH_RESET;
318 ata_port_schedule_eh(ap);
321 spin_unlock_irqrestore(ap->lock, flags);
322 ata_port_wait_eh(ap);
324 EXPORT_SYMBOL_GPL(ata_scsi_unlock_native_capacity);
327 * ata_get_identity - Handler for HDIO_GET_IDENTITY ioctl
329 * @sdev: SCSI device to get identify data for
330 * @arg: User buffer area for identify data
333 * Defined by the SCSI layer. We don't really care.
336 * Zero on success, negative errno on error.
338 static int ata_get_identity(struct ata_port *ap, struct scsi_device *sdev,
341 struct ata_device *dev = ata_scsi_find_dev(ap, sdev);
342 u16 __user *dst = arg;
348 if (copy_to_user(dst, dev->id, ATA_ID_WORDS * sizeof(u16)))
351 ata_id_string(dev->id, buf, ATA_ID_PROD, ATA_ID_PROD_LEN);
352 if (copy_to_user(dst + ATA_ID_PROD, buf, ATA_ID_PROD_LEN))
355 ata_id_string(dev->id, buf, ATA_ID_FW_REV, ATA_ID_FW_REV_LEN);
356 if (copy_to_user(dst + ATA_ID_FW_REV, buf, ATA_ID_FW_REV_LEN))
359 ata_id_string(dev->id, buf, ATA_ID_SERNO, ATA_ID_SERNO_LEN);
360 if (copy_to_user(dst + ATA_ID_SERNO, buf, ATA_ID_SERNO_LEN))
367 * ata_cmd_ioctl - Handler for HDIO_DRIVE_CMD ioctl
368 * @scsidev: Device to which we are issuing command
369 * @arg: User provided data for issuing command
372 * Defined by the SCSI layer. We don't really care.
375 * Zero on success, negative errno on error.
377 int ata_cmd_ioctl(struct scsi_device *scsidev, void __user *arg)
380 u8 sensebuf[SCSI_SENSE_BUFFERSIZE];
381 u8 scsi_cmd[MAX_COMMAND_SIZE];
382 u8 args[4], *argbuf = NULL;
384 struct scsi_sense_hdr sshdr;
385 const struct scsi_exec_args exec_args = {
388 .sense_len = sizeof(sensebuf),
395 if (copy_from_user(args, arg, sizeof(args)))
398 memset(sensebuf, 0, sizeof(sensebuf));
399 memset(scsi_cmd, 0, sizeof(scsi_cmd));
402 argsize = ATA_SECT_SIZE * args[3];
403 argbuf = kmalloc(argsize, GFP_KERNEL);
404 if (argbuf == NULL) {
409 scsi_cmd[1] = (4 << 1); /* PIO Data-in */
410 scsi_cmd[2] = 0x0e; /* no off.line or cc, read from dev,
411 block count in sector count field */
413 scsi_cmd[1] = (3 << 1); /* Non-data */
414 scsi_cmd[2] = 0x20; /* cc but no off.line or data xfer */
417 scsi_cmd[0] = ATA_16;
419 scsi_cmd[4] = args[2];
420 if (args[0] == ATA_CMD_SMART) { /* hack -- ide driver does this too */
421 scsi_cmd[6] = args[3];
422 scsi_cmd[8] = args[1];
423 scsi_cmd[10] = ATA_SMART_LBAM_PASS;
424 scsi_cmd[12] = ATA_SMART_LBAH_PASS;
426 scsi_cmd[6] = args[1];
428 scsi_cmd[14] = args[0];
430 /* Good values for timeout and retries? Values below
431 from scsi_ioctl_send_command() for default case... */
432 cmd_result = scsi_execute_cmd(scsidev, scsi_cmd, REQ_OP_DRV_IN, argbuf,
433 argsize, 10 * HZ, 5, &exec_args);
434 if (cmd_result < 0) {
438 if (scsi_sense_valid(&sshdr)) {/* sense data available */
439 u8 *desc = sensebuf + 8;
441 /* If we set cc then ATA pass-through will cause a
442 * check condition even if no error. Filter that. */
443 if (scsi_status_is_check_condition(cmd_result)) {
444 if (sshdr.sense_key == RECOVERED_ERROR &&
445 sshdr.asc == 0 && sshdr.ascq == 0x1d)
446 cmd_result &= ~SAM_STAT_CHECK_CONDITION;
449 /* Send userspace a few ATA registers (same as drivers/ide) */
450 if (sensebuf[0] == 0x72 && /* format is "descriptor" */
451 desc[0] == 0x09) { /* code is "ATA Descriptor" */
452 args[0] = desc[13]; /* status */
453 args[1] = desc[3]; /* error */
454 args[2] = desc[5]; /* sector count (0:7) */
455 if (copy_to_user(arg, args, sizeof(args)))
467 && copy_to_user(arg + sizeof(args), argbuf, argsize))
475 * ata_task_ioctl - Handler for HDIO_DRIVE_TASK ioctl
476 * @scsidev: Device to which we are issuing command
477 * @arg: User provided data for issuing command
480 * Defined by the SCSI layer. We don't really care.
483 * Zero on success, negative errno on error.
485 int ata_task_ioctl(struct scsi_device *scsidev, void __user *arg)
488 u8 sensebuf[SCSI_SENSE_BUFFERSIZE];
489 u8 scsi_cmd[MAX_COMMAND_SIZE];
491 struct scsi_sense_hdr sshdr;
493 const struct scsi_exec_args exec_args = {
496 .sense_len = sizeof(sensebuf),
502 if (copy_from_user(args, arg, sizeof(args)))
505 memset(sensebuf, 0, sizeof(sensebuf));
506 memset(scsi_cmd, 0, sizeof(scsi_cmd));
507 scsi_cmd[0] = ATA_16;
508 scsi_cmd[1] = (3 << 1); /* Non-data */
509 scsi_cmd[2] = 0x20; /* cc but no off.line or data xfer */
510 scsi_cmd[4] = args[1];
511 scsi_cmd[6] = args[2];
512 scsi_cmd[8] = args[3];
513 scsi_cmd[10] = args[4];
514 scsi_cmd[12] = args[5];
515 scsi_cmd[13] = args[6] & 0x4f;
516 scsi_cmd[14] = args[0];
518 /* Good values for timeout and retries? Values below
519 from scsi_ioctl_send_command() for default case... */
520 cmd_result = scsi_execute_cmd(scsidev, scsi_cmd, REQ_OP_DRV_IN, NULL,
521 0, 10 * HZ, 5, &exec_args);
522 if (cmd_result < 0) {
526 if (scsi_sense_valid(&sshdr)) {/* sense data available */
527 u8 *desc = sensebuf + 8;
529 /* If we set cc then ATA pass-through will cause a
530 * check condition even if no error. Filter that. */
531 if (cmd_result & SAM_STAT_CHECK_CONDITION) {
532 if (sshdr.sense_key == RECOVERED_ERROR &&
533 sshdr.asc == 0 && sshdr.ascq == 0x1d)
534 cmd_result &= ~SAM_STAT_CHECK_CONDITION;
537 /* Send userspace ATA registers */
538 if (sensebuf[0] == 0x72 && /* format is "descriptor" */
539 desc[0] == 0x09) {/* code is "ATA Descriptor" */
540 args[0] = desc[13]; /* status */
541 args[1] = desc[3]; /* error */
542 args[2] = desc[5]; /* sector count (0:7) */
543 args[3] = desc[7]; /* lbal */
544 args[4] = desc[9]; /* lbam */
545 args[5] = desc[11]; /* lbah */
546 args[6] = desc[12]; /* select */
547 if (copy_to_user(arg, args, sizeof(args)))
561 static bool ata_ioc32(struct ata_port *ap)
563 if (ap->flags & ATA_FLAG_PIO_DMA)
565 if (ap->pflags & ATA_PFLAG_PIO32)
571 * This handles both native and compat commands, so anything added
572 * here must have a compatible argument, or check in_compat_syscall()
574 int ata_sas_scsi_ioctl(struct ata_port *ap, struct scsi_device *scsidev,
575 unsigned int cmd, void __user *arg)
583 spin_lock_irqsave(ap->lock, flags);
585 spin_unlock_irqrestore(ap->lock, flags);
587 if (in_compat_syscall())
588 return put_user(val, (compat_ulong_t __user *)arg);
590 return put_user(val, (unsigned long __user *)arg);
593 val = (unsigned long) arg;
595 spin_lock_irqsave(ap->lock, flags);
596 if (ap->pflags & ATA_PFLAG_PIO32CHANGE) {
598 ap->pflags |= ATA_PFLAG_PIO32;
600 ap->pflags &= ~ATA_PFLAG_PIO32;
602 if (val != ata_ioc32(ap))
605 spin_unlock_irqrestore(ap->lock, flags);
608 case HDIO_GET_IDENTITY:
609 return ata_get_identity(ap, scsidev, arg);
612 if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
614 return ata_cmd_ioctl(scsidev, arg);
616 case HDIO_DRIVE_TASK:
617 if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
619 return ata_task_ioctl(scsidev, arg);
628 EXPORT_SYMBOL_GPL(ata_sas_scsi_ioctl);
630 int ata_scsi_ioctl(struct scsi_device *scsidev, unsigned int cmd,
633 return ata_sas_scsi_ioctl(ata_shost_to_port(scsidev->host),
636 EXPORT_SYMBOL_GPL(ata_scsi_ioctl);
639 * ata_scsi_qc_new - acquire new ata_queued_cmd reference
640 * @dev: ATA device to which the new command is attached
641 * @cmd: SCSI command that originated this ATA command
643 * Obtain a reference to an unused ata_queued_cmd structure,
644 * which is the basic libata structure representing a single
645 * ATA command sent to the hardware.
647 * If a command was available, fill in the SCSI-specific
648 * portions of the structure with information on the
652 * spin_lock_irqsave(host lock)
655 * Command allocated, or %NULL if none available.
657 static struct ata_queued_cmd *ata_scsi_qc_new(struct ata_device *dev,
658 struct scsi_cmnd *cmd)
660 struct ata_port *ap = dev->link->ap;
661 struct ata_queued_cmd *qc;
664 if (unlikely(ata_port_is_frozen(ap)))
667 if (ap->flags & ATA_FLAG_SAS_HOST) {
669 * SAS hosts may queue > ATA_MAX_QUEUE commands so use
670 * unique per-device budget token as a tag.
672 if (WARN_ON_ONCE(cmd->budget_token >= ATA_MAX_QUEUE))
674 tag = cmd->budget_token;
676 tag = scsi_cmd_to_rq(cmd)->tag;
679 qc = __ata_qc_from_tag(ap, tag);
680 qc->tag = qc->hw_tag = tag;
687 qc->scsidone = scsi_done;
689 qc->sg = scsi_sglist(cmd);
690 qc->n_elem = scsi_sg_count(cmd);
692 if (scsi_cmd_to_rq(cmd)->rq_flags & RQF_QUIET)
693 qc->flags |= ATA_QCFLAG_QUIET;
698 set_host_byte(cmd, DID_OK);
699 set_status_byte(cmd, SAM_STAT_TASK_SET_FULL);
704 static void ata_qc_set_pc_nbytes(struct ata_queued_cmd *qc)
706 struct scsi_cmnd *scmd = qc->scsicmd;
708 qc->extrabytes = scmd->extra_len;
709 qc->nbytes = scsi_bufflen(scmd) + qc->extrabytes;
713 * ata_to_sense_error - convert ATA error to SCSI error
714 * @id: ATA device number
715 * @drv_stat: value contained in ATA status register
716 * @drv_err: value contained in ATA error register
717 * @sk: the sense key we'll fill out
718 * @asc: the additional sense code we'll fill out
719 * @ascq: the additional sense code qualifier we'll fill out
721 * Converts an ATA error into a SCSI error. Fill out pointers to
722 * SK, ASC, and ASCQ bytes for later use in fixed or descriptor
723 * format sense blocks.
726 * spin_lock_irqsave(host lock)
728 static void ata_to_sense_error(unsigned id, u8 drv_stat, u8 drv_err, u8 *sk,
733 /* Based on the 3ware driver translation table */
734 static const unsigned char sense_table[][4] = {
736 {0xd1, ABORTED_COMMAND, 0x00, 0x00},
737 // Device busy Aborted command
739 {0xd0, ABORTED_COMMAND, 0x00, 0x00},
740 // Device busy Aborted command
742 {0x61, HARDWARE_ERROR, 0x00, 0x00},
743 // Device fault Hardware error
744 /* ICRC|ABRT */ /* NB: ICRC & !ABRT is BBD */
745 {0x84, ABORTED_COMMAND, 0x47, 0x00},
746 // Data CRC error SCSI parity error
747 /* MC|ID|ABRT|TRK0|MARK */
748 {0x37, NOT_READY, 0x04, 0x00},
749 // Unit offline Not ready
751 {0x09, NOT_READY, 0x04, 0x00},
752 // Unrecovered disk error Not ready
753 /* Bad address mark */
754 {0x01, MEDIUM_ERROR, 0x13, 0x00},
755 // Address mark not found for data field
756 /* TRK0 - Track 0 not found */
757 {0x02, HARDWARE_ERROR, 0x00, 0x00},
759 /* Abort: 0x04 is not translated here, see below */
760 /* Media change request */
761 {0x08, NOT_READY, 0x04, 0x00},
762 // FIXME: faking offline
763 /* SRV/IDNF - ID not found */
764 {0x10, ILLEGAL_REQUEST, 0x21, 0x00},
765 // Logical address out of range
766 /* MC - Media Changed */
767 {0x20, UNIT_ATTENTION, 0x28, 0x00},
768 // Not ready to ready change, medium may have changed
769 /* ECC - Uncorrectable ECC error */
770 {0x40, MEDIUM_ERROR, 0x11, 0x04},
771 // Unrecovered read error
772 /* BBD - block marked bad */
773 {0x80, MEDIUM_ERROR, 0x11, 0x04},
774 // Block marked bad Medium error, unrecovered read error
775 {0xFF, 0xFF, 0xFF, 0xFF}, // END mark
777 static const unsigned char stat_table[][4] = {
778 /* Must be first because BUSY means no other bits valid */
779 {0x80, ABORTED_COMMAND, 0x47, 0x00},
780 // Busy, fake parity for now
781 {0x40, ILLEGAL_REQUEST, 0x21, 0x04},
782 // Device ready, unaligned write command
783 {0x20, HARDWARE_ERROR, 0x44, 0x00},
784 // Device fault, internal target failure
785 {0x08, ABORTED_COMMAND, 0x47, 0x00},
786 // Timed out in xfer, fake parity for now
787 {0x04, RECOVERED_ERROR, 0x11, 0x00},
788 // Recovered ECC error Medium error, recovered
789 {0xFF, 0xFF, 0xFF, 0xFF}, // END mark
793 * Is this an error we can process/parse
795 if (drv_stat & ATA_BUSY) {
796 drv_err = 0; /* Ignore the err bits, they're invalid */
800 /* Look for drv_err */
801 for (i = 0; sense_table[i][0] != 0xFF; i++) {
802 /* Look for best matches first */
803 if ((sense_table[i][0] & drv_err) ==
805 *sk = sense_table[i][1];
806 *asc = sense_table[i][2];
807 *ascq = sense_table[i][3];
814 * Fall back to interpreting status bits. Note that if the drv_err
815 * has only the ABRT bit set, we decode drv_stat. ABRT by itself
816 * is not descriptive enough.
818 for (i = 0; stat_table[i][0] != 0xFF; i++) {
819 if (stat_table[i][0] & drv_stat) {
820 *sk = stat_table[i][1];
821 *asc = stat_table[i][2];
822 *ascq = stat_table[i][3];
828 * We need a sensible error return here, which is tricky, and one
829 * that won't cause people to do things like return a disk wrongly.
831 *sk = ABORTED_COMMAND;
837 * ata_gen_passthru_sense - Generate check condition sense block.
838 * @qc: Command that completed.
840 * This function is specific to the ATA descriptor format sense
841 * block specified for the ATA pass through commands. Regardless
842 * of whether the command errored or not, return a sense
843 * block. Copy all controller registers into the sense
844 * block. If there was no error, we get the request from an ATA
845 * passthrough command, so we use the following sense data:
846 * sk = RECOVERED ERROR
847 * asc,ascq = ATA PASS-THROUGH INFORMATION AVAILABLE
853 static void ata_gen_passthru_sense(struct ata_queued_cmd *qc)
855 struct scsi_cmnd *cmd = qc->scsicmd;
856 struct ata_taskfile *tf = &qc->result_tf;
857 unsigned char *sb = cmd->sense_buffer;
858 unsigned char *desc = sb + 8;
859 u8 sense_key, asc, ascq;
861 memset(sb, 0, SCSI_SENSE_BUFFERSIZE);
864 * Use ata_to_sense_error() to map status register bits
865 * onto sense key, asc & ascq.
868 tf->status & (ATA_BUSY | ATA_DF | ATA_ERR | ATA_DRQ)) {
869 ata_to_sense_error(qc->ap->print_id, tf->status, tf->error,
870 &sense_key, &asc, &ascq);
871 ata_scsi_set_sense(qc->dev, cmd, sense_key, asc, ascq);
874 * ATA PASS-THROUGH INFORMATION AVAILABLE
875 * Always in descriptor format sense.
877 scsi_build_sense(cmd, 1, RECOVERED_ERROR, 0, 0x1D);
880 if ((cmd->sense_buffer[0] & 0x7f) >= 0x72) {
883 /* descriptor format */
885 desc = (char *)scsi_sense_desc_find(sb, len + 8, 9);
887 if (SCSI_SENSE_BUFFERSIZE < len + 14)
895 * Copy registers into sense buffer.
903 desc[12] = tf->device;
904 desc[13] = tf->status;
907 * Fill in Extend bit, and the high order bytes
910 if (tf->flags & ATA_TFLAG_LBA48) {
912 desc[4] = tf->hob_nsect;
913 desc[6] = tf->hob_lbal;
914 desc[8] = tf->hob_lbam;
915 desc[10] = tf->hob_lbah;
918 /* Fixed sense format */
920 desc[1] = tf->status;
921 desc[2] = tf->device;
924 if (tf->flags & ATA_TFLAG_LBA48) {
928 if (tf->hob_lbal || tf->hob_lbam || tf->hob_lbah)
938 * ata_gen_ata_sense - generate a SCSI fixed sense block
939 * @qc: Command that we are erroring out
941 * Generate sense block for a failed ATA command @qc. Descriptor
942 * format is used to accommodate LBA48 block address.
947 static void ata_gen_ata_sense(struct ata_queued_cmd *qc)
949 struct ata_device *dev = qc->dev;
950 struct scsi_cmnd *cmd = qc->scsicmd;
951 struct ata_taskfile *tf = &qc->result_tf;
952 unsigned char *sb = cmd->sense_buffer;
954 u8 sense_key, asc, ascq;
956 memset(sb, 0, SCSI_SENSE_BUFFERSIZE);
958 if (ata_dev_disabled(dev)) {
959 /* Device disabled after error recovery */
960 /* LOGICAL UNIT NOT READY, HARD RESET REQUIRED */
961 ata_scsi_set_sense(dev, cmd, NOT_READY, 0x04, 0x21);
964 /* Use ata_to_sense_error() to map status register bits
965 * onto sense key, asc & ascq.
968 tf->status & (ATA_BUSY | ATA_DF | ATA_ERR | ATA_DRQ)) {
969 ata_to_sense_error(qc->ap->print_id, tf->status, tf->error,
970 &sense_key, &asc, &ascq);
971 ata_scsi_set_sense(dev, cmd, sense_key, asc, ascq);
973 /* Could not decode error */
974 ata_dev_warn(dev, "could not decode error status 0x%x err_mask 0x%x\n",
975 tf->status, qc->err_mask);
976 ata_scsi_set_sense(dev, cmd, ABORTED_COMMAND, 0, 0);
980 block = ata_tf_read_block(&qc->result_tf, dev);
981 if (block == U64_MAX)
984 scsi_set_sense_information(sb, SCSI_SENSE_BUFFERSIZE, block);
987 void ata_scsi_sdev_config(struct scsi_device *sdev)
989 sdev->use_10_for_rw = 1;
990 sdev->use_10_for_ms = 1;
991 sdev->no_write_same = 1;
993 /* Schedule policy is determined by ->qc_defer() callback and
994 * it needs to see every deferred qc. Set dev_blocked to 1 to
995 * prevent SCSI midlayer from automatically deferring
998 sdev->max_device_blocked = 1;
1002 * ata_scsi_dma_need_drain - Check whether data transfer may overflow
1003 * @rq: request to be checked
1005 * ATAPI commands which transfer variable length data to host
1006 * might overflow due to application error or hardware bug. This
1007 * function checks whether overflow should be drained and ignored
1014 * 1 if ; otherwise, 0.
1016 bool ata_scsi_dma_need_drain(struct request *rq)
1018 struct scsi_cmnd *scmd = blk_mq_rq_to_pdu(rq);
1020 return atapi_cmd_type(scmd->cmnd[0]) == ATAPI_MISC;
1022 EXPORT_SYMBOL_GPL(ata_scsi_dma_need_drain);
1024 int ata_scsi_dev_config(struct scsi_device *sdev, struct ata_device *dev)
1026 struct request_queue *q = sdev->request_queue;
1029 if (!ata_id_has_unload(dev->id))
1030 dev->flags |= ATA_DFLAG_NO_UNLOAD;
1032 /* configure max sectors */
1033 dev->max_sectors = min(dev->max_sectors, sdev->host->max_sectors);
1034 blk_queue_max_hw_sectors(q, dev->max_sectors);
1036 if (dev->class == ATA_DEV_ATAPI) {
1037 sdev->sector_size = ATA_SECT_SIZE;
1039 /* set DMA padding */
1040 blk_queue_update_dma_pad(q, ATA_DMA_PAD_SZ - 1);
1042 /* make room for appending the drain */
1043 blk_queue_max_segments(q, queue_max_segments(q) - 1);
1045 sdev->dma_drain_len = ATAPI_MAX_DRAIN;
1046 sdev->dma_drain_buf = kmalloc(sdev->dma_drain_len, GFP_NOIO);
1047 if (!sdev->dma_drain_buf) {
1048 ata_dev_err(dev, "drain buffer allocation failed\n");
1052 sdev->sector_size = ata_id_logical_sector_size(dev->id);
1055 * Ask the sd driver to issue START STOP UNIT on runtime suspend
1056 * and resume and shutdown only. For system level suspend/resume,
1057 * devices power state is handled directly by libata EH.
1058 * Given that disks are always spun up on system resume, also
1059 * make sure that the sd driver forces runtime suspended disks
1060 * to be resumed to correctly reflect the power state of the
1063 sdev->manage_runtime_start_stop = 1;
1064 sdev->manage_shutdown = 1;
1065 sdev->force_runtime_start_on_system_start = 1;
1069 * ata_pio_sectors() expects buffer for each sector to not cross
1070 * page boundary. Enforce it by requiring buffers to be sector
1071 * aligned, which works iff sector_size is not larger than
1072 * PAGE_SIZE. ATAPI devices also need the alignment as
1073 * IDENTIFY_PACKET is executed as ATA_PROT_PIO.
1075 if (sdev->sector_size > PAGE_SIZE)
1077 "sector_size=%u > PAGE_SIZE, PIO may malfunction\n",
1080 blk_queue_update_dma_alignment(q, sdev->sector_size - 1);
1082 if (dev->flags & ATA_DFLAG_AN)
1083 set_bit(SDEV_EVT_MEDIA_CHANGE, sdev->supported_events);
1085 if (ata_ncq_supported(dev))
1086 depth = min(sdev->host->can_queue, ata_id_queue_depth(dev->id));
1087 depth = min(ATA_MAX_QUEUE, depth);
1088 scsi_change_queue_depth(sdev, depth);
1090 if (dev->flags & ATA_DFLAG_TRUSTED)
1091 sdev->security_supported = 1;
1098 * ata_scsi_slave_alloc - Early setup of SCSI device
1099 * @sdev: SCSI device to examine
1101 * This is called from scsi_alloc_sdev() when the scsi device
1102 * associated with an ATA device is scanned on a port.
1105 * Defined by SCSI layer. We don't really care.
1108 int ata_scsi_slave_alloc(struct scsi_device *sdev)
1110 struct ata_port *ap = ata_shost_to_port(sdev->host);
1111 struct device_link *link;
1113 ata_scsi_sdev_config(sdev);
1116 * Create a link from the ata_port device to the scsi device to ensure
1117 * that PM does suspend/resume in the correct order: the scsi device is
1118 * consumer (child) and the ata port the supplier (parent).
1120 link = device_link_add(&sdev->sdev_gendev, &ap->tdev,
1122 DL_FLAG_PM_RUNTIME | DL_FLAG_RPM_ACTIVE);
1124 ata_port_err(ap, "Failed to create link to scsi device %s\n",
1125 dev_name(&sdev->sdev_gendev));
1131 EXPORT_SYMBOL_GPL(ata_scsi_slave_alloc);
1134 * ata_scsi_slave_config - Set SCSI device attributes
1135 * @sdev: SCSI device to examine
1137 * This is called before we actually start reading
1138 * and writing to the device, to configure certain
1139 * SCSI mid-layer behaviors.
1142 * Defined by SCSI layer. We don't really care.
1145 int ata_scsi_slave_config(struct scsi_device *sdev)
1147 struct ata_port *ap = ata_shost_to_port(sdev->host);
1148 struct ata_device *dev = __ata_scsi_find_dev(ap, sdev);
1151 return ata_scsi_dev_config(sdev, dev);
1155 EXPORT_SYMBOL_GPL(ata_scsi_slave_config);
1158 * ata_scsi_slave_destroy - SCSI device is about to be destroyed
1159 * @sdev: SCSI device to be destroyed
1161 * @sdev is about to be destroyed for hot/warm unplugging. If
1162 * this unplugging was initiated by libata as indicated by NULL
1163 * dev->sdev, this function doesn't have to do anything.
1164 * Otherwise, SCSI layer initiated warm-unplug is in progress.
1165 * Clear dev->sdev, schedule the device for ATA detach and invoke
1169 * Defined by SCSI layer. We don't really care.
1171 void ata_scsi_slave_destroy(struct scsi_device *sdev)
1173 struct ata_port *ap = ata_shost_to_port(sdev->host);
1174 unsigned long flags;
1175 struct ata_device *dev;
1177 device_link_remove(&sdev->sdev_gendev, &ap->tdev);
1179 spin_lock_irqsave(ap->lock, flags);
1180 dev = __ata_scsi_find_dev(ap, sdev);
1181 if (dev && dev->sdev) {
1182 /* SCSI device already in CANCEL state, no need to offline it */
1184 dev->flags |= ATA_DFLAG_DETACH;
1185 ata_port_schedule_eh(ap);
1187 spin_unlock_irqrestore(ap->lock, flags);
1189 kfree(sdev->dma_drain_buf);
1191 EXPORT_SYMBOL_GPL(ata_scsi_slave_destroy);
1194 * ata_scsi_start_stop_xlat - Translate SCSI START STOP UNIT command
1195 * @qc: Storage for translated ATA taskfile
1197 * Sets up an ATA taskfile to issue STANDBY (to stop) or READ VERIFY
1198 * (to start). Perhaps these commands should be preceded by
1199 * CHECK POWER MODE to see what power mode the device is already in.
1200 * [See SAT revision 5 at www.t10.org]
1203 * spin_lock_irqsave(host lock)
1206 * Zero on success, non-zero on error.
1208 static unsigned int ata_scsi_start_stop_xlat(struct ata_queued_cmd *qc)
1210 struct scsi_cmnd *scmd = qc->scsicmd;
1211 const u8 *cdb = scmd->cmnd;
1215 if (scmd->cmd_len < 5) {
1220 /* LOEJ bit set not supported */
1227 /* Power conditions not supported */
1228 if (((cdb[4] >> 4) & 0xf) != 0) {
1234 /* Ignore IMMED bit (cdb[1] & 0x1), violates sat-r05 */
1235 if (!ata_dev_power_init_tf(qc->dev, &qc->tf, cdb[4] & 0x1)) {
1236 ata_scsi_set_sense(qc->dev, scmd, ABORTED_COMMAND, 0, 0);
1241 * Standby and Idle condition timers could be implemented but that
1242 * would require libata to implement the Power condition mode page
1243 * and allow the user to change it. Changing mode pages requires
1244 * MODE SELECT to be implemented.
1250 ata_scsi_set_invalid_field(qc->dev, scmd, fp, bp);
1255 * ata_scsi_flush_xlat - Translate SCSI SYNCHRONIZE CACHE command
1256 * @qc: Storage for translated ATA taskfile
1258 * Sets up an ATA taskfile to issue FLUSH CACHE or
1262 * spin_lock_irqsave(host lock)
1265 * Zero on success, non-zero on error.
1267 static unsigned int ata_scsi_flush_xlat(struct ata_queued_cmd *qc)
1269 struct ata_taskfile *tf = &qc->tf;
1271 tf->flags |= ATA_TFLAG_DEVICE;
1272 tf->protocol = ATA_PROT_NODATA;
1274 if (qc->dev->flags & ATA_DFLAG_FLUSH_EXT)
1275 tf->command = ATA_CMD_FLUSH_EXT;
1277 tf->command = ATA_CMD_FLUSH;
1279 /* flush is critical for IO integrity, consider it an IO command */
1280 qc->flags |= ATA_QCFLAG_IO;
1286 * scsi_6_lba_len - Get LBA and transfer length
1287 * @cdb: SCSI command to translate
1289 * Calculate LBA and transfer length for 6-byte commands.
1293 * @plen: the transfer length
1295 static void scsi_6_lba_len(const u8 *cdb, u64 *plba, u32 *plen)
1300 lba |= ((u64)(cdb[1] & 0x1f)) << 16;
1301 lba |= ((u64)cdb[2]) << 8;
1302 lba |= ((u64)cdb[3]);
1311 * scsi_10_lba_len - Get LBA and transfer length
1312 * @cdb: SCSI command to translate
1314 * Calculate LBA and transfer length for 10-byte commands.
1318 * @plen: the transfer length
1320 static inline void scsi_10_lba_len(const u8 *cdb, u64 *plba, u32 *plen)
1322 *plba = get_unaligned_be32(&cdb[2]);
1323 *plen = get_unaligned_be16(&cdb[7]);
1327 * scsi_16_lba_len - Get LBA and transfer length
1328 * @cdb: SCSI command to translate
1330 * Calculate LBA and transfer length for 16-byte commands.
1334 * @plen: the transfer length
1336 static inline void scsi_16_lba_len(const u8 *cdb, u64 *plba, u32 *plen)
1338 *plba = get_unaligned_be64(&cdb[2]);
1339 *plen = get_unaligned_be32(&cdb[10]);
1343 * scsi_dld - Get duration limit descriptor index
1344 * @cdb: SCSI command to translate
1346 * Returns the dld bits indicating the index of a command duration limit
1349 static inline int scsi_dld(const u8 *cdb)
1351 return ((cdb[1] & 0x01) << 2) | ((cdb[14] >> 6) & 0x03);
1355 * ata_scsi_verify_xlat - Translate SCSI VERIFY command into an ATA one
1356 * @qc: Storage for translated ATA taskfile
1358 * Converts SCSI VERIFY command to an ATA READ VERIFY command.
1361 * spin_lock_irqsave(host lock)
1364 * Zero on success, non-zero on error.
1366 static unsigned int ata_scsi_verify_xlat(struct ata_queued_cmd *qc)
1368 struct scsi_cmnd *scmd = qc->scsicmd;
1369 struct ata_taskfile *tf = &qc->tf;
1370 struct ata_device *dev = qc->dev;
1371 u64 dev_sectors = qc->dev->n_sectors;
1372 const u8 *cdb = scmd->cmnd;
1377 tf->flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
1378 tf->protocol = ATA_PROT_NODATA;
1382 if (scmd->cmd_len < 10) {
1386 scsi_10_lba_len(cdb, &block, &n_block);
1389 if (scmd->cmd_len < 16) {
1393 scsi_16_lba_len(cdb, &block, &n_block);
1402 if (block >= dev_sectors)
1404 if ((block + n_block) > dev_sectors)
1407 if (dev->flags & ATA_DFLAG_LBA) {
1408 tf->flags |= ATA_TFLAG_LBA;
1410 if (lba_28_ok(block, n_block)) {
1412 tf->command = ATA_CMD_VERIFY;
1413 tf->device |= (block >> 24) & 0xf;
1414 } else if (lba_48_ok(block, n_block)) {
1415 if (!(dev->flags & ATA_DFLAG_LBA48))
1419 tf->flags |= ATA_TFLAG_LBA48;
1420 tf->command = ATA_CMD_VERIFY_EXT;
1422 tf->hob_nsect = (n_block >> 8) & 0xff;
1424 tf->hob_lbah = (block >> 40) & 0xff;
1425 tf->hob_lbam = (block >> 32) & 0xff;
1426 tf->hob_lbal = (block >> 24) & 0xff;
1428 /* request too large even for LBA48 */
1431 tf->nsect = n_block & 0xff;
1433 tf->lbah = (block >> 16) & 0xff;
1434 tf->lbam = (block >> 8) & 0xff;
1435 tf->lbal = block & 0xff;
1437 tf->device |= ATA_LBA;
1440 u32 sect, head, cyl, track;
1442 if (!lba_28_ok(block, n_block))
1445 /* Convert LBA to CHS */
1446 track = (u32)block / dev->sectors;
1447 cyl = track / dev->heads;
1448 head = track % dev->heads;
1449 sect = (u32)block % dev->sectors + 1;
1451 /* Check whether the converted CHS can fit.
1455 if ((cyl >> 16) || (head >> 4) || (sect >> 8) || (!sect))
1458 tf->command = ATA_CMD_VERIFY;
1459 tf->nsect = n_block & 0xff; /* Sector count 0 means 256 sectors */
1462 tf->lbah = cyl >> 8;
1469 ata_scsi_set_invalid_field(qc->dev, scmd, fp, 0xff);
1473 ata_scsi_set_sense(qc->dev, scmd, ILLEGAL_REQUEST, 0x21, 0x0);
1474 /* "Logical Block Address out of range" */
1478 scmd->result = SAM_STAT_GOOD;
1482 static bool ata_check_nblocks(struct scsi_cmnd *scmd, u32 n_blocks)
1484 struct request *rq = scsi_cmd_to_rq(scmd);
1487 if (!blk_rq_is_passthrough(rq))
1490 req_blocks = blk_rq_bytes(rq) / scmd->device->sector_size;
1491 if (n_blocks > req_blocks)
1498 * ata_scsi_rw_xlat - Translate SCSI r/w command into an ATA one
1499 * @qc: Storage for translated ATA taskfile
1501 * Converts any of six SCSI read/write commands into the
1502 * ATA counterpart, including starting sector (LBA),
1503 * sector count, and taking into account the device's LBA48
1506 * Commands %READ_6, %READ_10, %READ_16, %WRITE_6, %WRITE_10, and
1507 * %WRITE_16 are currently supported.
1510 * spin_lock_irqsave(host lock)
1513 * Zero on success, non-zero on error.
1515 static unsigned int ata_scsi_rw_xlat(struct ata_queued_cmd *qc)
1517 struct scsi_cmnd *scmd = qc->scsicmd;
1518 const u8 *cdb = scmd->cmnd;
1519 struct request *rq = scsi_cmd_to_rq(scmd);
1520 int class = IOPRIO_PRIO_CLASS(req_get_ioprio(rq));
1521 unsigned int tf_flags = 0;
1532 tf_flags |= ATA_TFLAG_WRITE;
1536 /* Calculate the SCSI LBA, transfer length and FUA. */
1540 if (unlikely(scmd->cmd_len < 10)) {
1544 scsi_10_lba_len(cdb, &block, &n_block);
1545 if (cdb[1] & (1 << 3))
1546 tf_flags |= ATA_TFLAG_FUA;
1547 if (!ata_check_nblocks(scmd, n_block))
1552 if (unlikely(scmd->cmd_len < 6)) {
1556 scsi_6_lba_len(cdb, &block, &n_block);
1558 /* for 6-byte r/w commands, transfer length 0
1559 * means 256 blocks of data, not 0 block.
1563 if (!ata_check_nblocks(scmd, n_block))
1568 if (unlikely(scmd->cmd_len < 16)) {
1572 scsi_16_lba_len(cdb, &block, &n_block);
1573 dld = scsi_dld(cdb);
1574 if (cdb[1] & (1 << 3))
1575 tf_flags |= ATA_TFLAG_FUA;
1576 if (!ata_check_nblocks(scmd, n_block))
1584 /* Check and compose ATA command */
1586 /* For 10-byte and 16-byte SCSI R/W commands, transfer
1587 * length 0 means transfer 0 block of data.
1588 * However, for ATA R/W commands, sector count 0 means
1589 * 256 or 65536 sectors, not 0 sectors as in SCSI.
1591 * WARNING: one or two older ATA drives treat 0 as 0...
1595 qc->flags |= ATA_QCFLAG_IO;
1596 qc->nbytes = n_block * scmd->device->sector_size;
1598 rc = ata_build_rw_tf(qc, block, n_block, tf_flags, dld, class);
1599 if (likely(rc == 0))
1604 /* treat all other errors as -EINVAL, fall through */
1606 ata_scsi_set_invalid_field(qc->dev, scmd, fp, 0xff);
1610 ata_scsi_set_sense(qc->dev, scmd, ILLEGAL_REQUEST, 0x21, 0x0);
1611 /* "Logical Block Address out of range" */
1615 scmd->result = SAM_STAT_GOOD;
1619 static void ata_qc_done(struct ata_queued_cmd *qc)
1621 struct scsi_cmnd *cmd = qc->scsicmd;
1622 void (*done)(struct scsi_cmnd *) = qc->scsidone;
1628 static void ata_scsi_qc_complete(struct ata_queued_cmd *qc)
1630 struct scsi_cmnd *cmd = qc->scsicmd;
1631 u8 *cdb = cmd->cmnd;
1632 int need_sense = (qc->err_mask != 0) &&
1633 !(qc->flags & ATA_QCFLAG_SENSE_VALID);
1635 /* For ATA pass thru (SAT) commands, generate a sense block if
1636 * user mandated it or if there's an error. Note that if we
1637 * generate because the user forced us to [CK_COND =1], a check
1638 * condition is generated and the ATA register values are returned
1639 * whether the command completed successfully or not. If there
1640 * was no error, we use the following sense data:
1641 * sk = RECOVERED ERROR
1642 * asc,ascq = ATA PASS-THROUGH INFORMATION AVAILABLE
1644 if (((cdb[0] == ATA_16) || (cdb[0] == ATA_12)) &&
1645 ((cdb[2] & 0x20) || need_sense))
1646 ata_gen_passthru_sense(qc);
1647 else if (need_sense)
1648 ata_gen_ata_sense(qc);
1650 /* Keep the SCSI ML and status byte, clear host byte. */
1651 cmd->result &= 0x0000ffff;
1657 * ata_scsi_translate - Translate then issue SCSI command to ATA device
1658 * @dev: ATA device to which the command is addressed
1659 * @cmd: SCSI command to execute
1660 * @xlat_func: Actor which translates @cmd to an ATA taskfile
1662 * Our ->queuecommand() function has decided that the SCSI
1663 * command issued can be directly translated into an ATA
1664 * command, rather than handled internally.
1666 * This function sets up an ata_queued_cmd structure for the
1667 * SCSI command, and sends that ata_queued_cmd to the hardware.
1669 * The xlat_func argument (actor) returns 0 if ready to execute
1670 * ATA command, else 1 to finish translation. If 1 is returned
1671 * then cmd->result (and possibly cmd->sense_buffer) are assumed
1672 * to be set reflecting an error condition or clean (early)
1676 * spin_lock_irqsave(host lock)
1679 * 0 on success, SCSI_ML_QUEUE_DEVICE_BUSY if the command
1680 * needs to be deferred.
1682 static int ata_scsi_translate(struct ata_device *dev, struct scsi_cmnd *cmd,
1683 ata_xlat_func_t xlat_func)
1685 struct ata_port *ap = dev->link->ap;
1686 struct ata_queued_cmd *qc;
1689 qc = ata_scsi_qc_new(dev, cmd);
1693 /* data is present; dma-map it */
1694 if (cmd->sc_data_direction == DMA_FROM_DEVICE ||
1695 cmd->sc_data_direction == DMA_TO_DEVICE) {
1696 if (unlikely(scsi_bufflen(cmd) < 1)) {
1697 ata_dev_warn(dev, "WARNING: zero len r/w req\n");
1701 ata_sg_init(qc, scsi_sglist(cmd), scsi_sg_count(cmd));
1703 qc->dma_dir = cmd->sc_data_direction;
1706 qc->complete_fn = ata_scsi_qc_complete;
1711 if (ap->ops->qc_defer) {
1712 if ((rc = ap->ops->qc_defer(qc)))
1716 /* select device, send command to hardware */
1728 cmd->result = (DID_ERROR << 16);
1735 if (rc == ATA_DEFER_LINK)
1736 return SCSI_MLQUEUE_DEVICE_BUSY;
1738 return SCSI_MLQUEUE_HOST_BUSY;
1741 struct ata_scsi_args {
1742 struct ata_device *dev;
1744 struct scsi_cmnd *cmd;
1748 * ata_scsi_rbuf_fill - wrapper for SCSI command simulators
1749 * @args: device IDENTIFY data / SCSI command of interest.
1750 * @actor: Callback hook for desired SCSI command simulator
1752 * Takes care of the hard work of simulating a SCSI command...
1753 * Mapping the response buffer, calling the command's handler,
1754 * and handling the handler's return value. This return value
1755 * indicates whether the handler wishes the SCSI command to be
1756 * completed successfully (0), or not (in which case cmd->result
1757 * and sense buffer are assumed to be set).
1760 * spin_lock_irqsave(host lock)
1762 static void ata_scsi_rbuf_fill(struct ata_scsi_args *args,
1763 unsigned int (*actor)(struct ata_scsi_args *args, u8 *rbuf))
1766 struct scsi_cmnd *cmd = args->cmd;
1767 unsigned long flags;
1769 spin_lock_irqsave(&ata_scsi_rbuf_lock, flags);
1771 memset(ata_scsi_rbuf, 0, ATA_SCSI_RBUF_SIZE);
1772 rc = actor(args, ata_scsi_rbuf);
1774 sg_copy_from_buffer(scsi_sglist(cmd), scsi_sg_count(cmd),
1775 ata_scsi_rbuf, ATA_SCSI_RBUF_SIZE);
1777 spin_unlock_irqrestore(&ata_scsi_rbuf_lock, flags);
1780 cmd->result = SAM_STAT_GOOD;
1784 * ata_scsiop_inq_std - Simulate INQUIRY command
1785 * @args: device IDENTIFY data / SCSI command of interest.
1786 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1788 * Returns standard device identification data associated
1789 * with non-VPD INQUIRY command output.
1792 * spin_lock_irqsave(host lock)
1794 static unsigned int ata_scsiop_inq_std(struct ata_scsi_args *args, u8 *rbuf)
1796 static const u8 versions[] = {
1798 0x60, /* SAM-3 (no version claimed) */
1801 0x20, /* SBC-2 (no version claimed) */
1804 0x00 /* SPC-3 (no version claimed) */
1806 static const u8 versions_zbc[] = {
1808 0xA0, /* SAM-5 (no version claimed) */
1811 0x00, /* SBC-4 (no version claimed) */
1814 0xC0, /* SPC-5 (no version claimed) */
1823 0x5, /* claim SPC-3 version compatibility */
1831 /* set scsi removable (RMB) bit per ata bit, or if the
1832 * AHCI port says it's external (Hotplug-capable, eSATA).
1834 if (ata_id_removable(args->id) ||
1835 (args->dev->link->ap->pflags & ATA_PFLAG_EXTERNAL))
1838 if (args->dev->class == ATA_DEV_ZAC) {
1840 hdr[2] = 0x7; /* claim SPC-5 version compatibility */
1843 if (args->dev->flags & ATA_DFLAG_CDL)
1844 hdr[2] = 0xd; /* claim SPC-6 version compatibility */
1846 memcpy(rbuf, hdr, sizeof(hdr));
1847 memcpy(&rbuf[8], "ATA ", 8);
1848 ata_id_string(args->id, &rbuf[16], ATA_ID_PROD, 16);
1850 /* From SAT, use last 2 words from fw rev unless they are spaces */
1851 ata_id_string(args->id, &rbuf[32], ATA_ID_FW_REV + 2, 4);
1852 if (strncmp(&rbuf[32], " ", 4) == 0)
1853 ata_id_string(args->id, &rbuf[32], ATA_ID_FW_REV, 4);
1855 if (rbuf[32] == 0 || rbuf[32] == ' ')
1856 memcpy(&rbuf[32], "n/a ", 4);
1858 if (ata_id_zoned_cap(args->id) || args->dev->class == ATA_DEV_ZAC)
1859 memcpy(rbuf + 58, versions_zbc, sizeof(versions_zbc));
1861 memcpy(rbuf + 58, versions, sizeof(versions));
1867 * ata_scsiop_inq_00 - Simulate INQUIRY VPD page 0, list of pages
1868 * @args: device IDENTIFY data / SCSI command of interest.
1869 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1871 * Returns list of inquiry VPD pages available.
1874 * spin_lock_irqsave(host lock)
1876 static unsigned int ata_scsiop_inq_00(struct ata_scsi_args *args, u8 *rbuf)
1878 int i, num_pages = 0;
1879 static const u8 pages[] = {
1880 0x00, /* page 0x00, this page */
1881 0x80, /* page 0x80, unit serial no page */
1882 0x83, /* page 0x83, device ident page */
1883 0x89, /* page 0x89, ata info page */
1884 0xb0, /* page 0xb0, block limits page */
1885 0xb1, /* page 0xb1, block device characteristics page */
1886 0xb2, /* page 0xb2, thin provisioning page */
1887 0xb6, /* page 0xb6, zoned block device characteristics */
1888 0xb9, /* page 0xb9, concurrent positioning ranges */
1891 for (i = 0; i < sizeof(pages); i++) {
1892 if (pages[i] == 0xb6 &&
1893 !(args->dev->flags & ATA_DFLAG_ZAC))
1895 rbuf[num_pages + 4] = pages[i];
1898 rbuf[3] = num_pages; /* number of supported VPD pages */
1903 * ata_scsiop_inq_80 - Simulate INQUIRY VPD page 80, device serial number
1904 * @args: device IDENTIFY data / SCSI command of interest.
1905 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1907 * Returns ATA device serial number.
1910 * spin_lock_irqsave(host lock)
1912 static unsigned int ata_scsiop_inq_80(struct ata_scsi_args *args, u8 *rbuf)
1914 static const u8 hdr[] = {
1916 0x80, /* this page code */
1918 ATA_ID_SERNO_LEN, /* page len */
1921 memcpy(rbuf, hdr, sizeof(hdr));
1922 ata_id_string(args->id, (unsigned char *) &rbuf[4],
1923 ATA_ID_SERNO, ATA_ID_SERNO_LEN);
1928 * ata_scsiop_inq_83 - Simulate INQUIRY VPD page 83, device identity
1929 * @args: device IDENTIFY data / SCSI command of interest.
1930 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1932 * Yields two logical unit device identification designators:
1933 * - vendor specific ASCII containing the ATA serial number
1934 * - SAT defined "t10 vendor id based" containing ASCII vendor
1935 * name ("ATA "), model and serial numbers.
1938 * spin_lock_irqsave(host lock)
1940 static unsigned int ata_scsiop_inq_83(struct ata_scsi_args *args, u8 *rbuf)
1942 const int sat_model_serial_desc_len = 68;
1945 rbuf[1] = 0x83; /* this page code */
1948 /* piv=0, assoc=lu, code_set=ACSII, designator=vendor */
1950 rbuf[num + 3] = ATA_ID_SERNO_LEN;
1952 ata_id_string(args->id, (unsigned char *) rbuf + num,
1953 ATA_ID_SERNO, ATA_ID_SERNO_LEN);
1954 num += ATA_ID_SERNO_LEN;
1956 /* SAT defined lu model and serial numbers descriptor */
1957 /* piv=0, assoc=lu, code_set=ACSII, designator=t10 vendor id */
1960 rbuf[num + 3] = sat_model_serial_desc_len;
1962 memcpy(rbuf + num, "ATA ", 8);
1964 ata_id_string(args->id, (unsigned char *) rbuf + num, ATA_ID_PROD,
1966 num += ATA_ID_PROD_LEN;
1967 ata_id_string(args->id, (unsigned char *) rbuf + num, ATA_ID_SERNO,
1969 num += ATA_ID_SERNO_LEN;
1971 if (ata_id_has_wwn(args->id)) {
1972 /* SAT defined lu world wide name */
1973 /* piv=0, assoc=lu, code_set=binary, designator=NAA */
1976 rbuf[num + 3] = ATA_ID_WWN_LEN;
1978 ata_id_string(args->id, (unsigned char *) rbuf + num,
1979 ATA_ID_WWN, ATA_ID_WWN_LEN);
1980 num += ATA_ID_WWN_LEN;
1982 rbuf[3] = num - 4; /* page len (assume less than 256 bytes) */
1987 * ata_scsiop_inq_89 - Simulate INQUIRY VPD page 89, ATA info
1988 * @args: device IDENTIFY data / SCSI command of interest.
1989 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1991 * Yields SAT-specified ATA VPD page.
1994 * spin_lock_irqsave(host lock)
1996 static unsigned int ata_scsiop_inq_89(struct ata_scsi_args *args, u8 *rbuf)
1998 rbuf[1] = 0x89; /* our page code */
1999 rbuf[2] = (0x238 >> 8); /* page size fixed at 238h */
2000 rbuf[3] = (0x238 & 0xff);
2002 memcpy(&rbuf[8], "linux ", 8);
2003 memcpy(&rbuf[16], "libata ", 16);
2004 memcpy(&rbuf[32], DRV_VERSION, 4);
2006 rbuf[36] = 0x34; /* force D2H Reg FIS (34h) */
2007 rbuf[37] = (1 << 7); /* bit 7 indicates Command FIS */
2010 /* we don't store the ATA device signature, so we fake it */
2011 rbuf[38] = ATA_DRDY; /* really, this is Status reg */
2015 rbuf[56] = ATA_CMD_ID_ATA;
2017 memcpy(&rbuf[60], &args->id[0], 512);
2021 static unsigned int ata_scsiop_inq_b0(struct ata_scsi_args *args, u8 *rbuf)
2023 struct ata_device *dev = args->dev;
2027 rbuf[3] = 0x3c; /* required VPD size with unmap support */
2030 * Optimal transfer length granularity.
2032 * This is always one physical block, but for disks with a smaller
2033 * logical than physical sector size we need to figure out what the
2036 min_io_sectors = 1 << ata_id_log2_per_physical_sector(args->id);
2037 put_unaligned_be16(min_io_sectors, &rbuf[6]);
2040 * Optimal unmap granularity.
2042 * The ATA spec doesn't even know about a granularity or alignment
2043 * for the TRIM command. We can leave away most of the unmap related
2044 * VPD page entries, but we have specifify a granularity to signal
2045 * that we support some form of unmap - in thise case via WRITE SAME
2046 * with the unmap bit set.
2048 if (ata_id_has_trim(args->id)) {
2049 u64 max_blocks = 65535 * ATA_MAX_TRIM_RNUM;
2051 if (dev->horkage & ATA_HORKAGE_MAX_TRIM_128M)
2052 max_blocks = 128 << (20 - SECTOR_SHIFT);
2054 put_unaligned_be64(max_blocks, &rbuf[36]);
2055 put_unaligned_be32(1, &rbuf[28]);
2061 static unsigned int ata_scsiop_inq_b1(struct ata_scsi_args *args, u8 *rbuf)
2063 int form_factor = ata_id_form_factor(args->id);
2064 int media_rotation_rate = ata_id_rotation_rate(args->id);
2065 u8 zoned = ata_id_zoned_cap(args->id);
2069 rbuf[4] = media_rotation_rate >> 8;
2070 rbuf[5] = media_rotation_rate;
2071 rbuf[7] = form_factor;
2073 rbuf[8] = (zoned << 4);
2078 static unsigned int ata_scsiop_inq_b2(struct ata_scsi_args *args, u8 *rbuf)
2080 /* SCSI Thin Provisioning VPD page: SBC-3 rev 22 or later */
2083 rbuf[5] = 1 << 6; /* TPWS */
2088 static unsigned int ata_scsiop_inq_b6(struct ata_scsi_args *args, u8 *rbuf)
2091 * zbc-r05 SCSI Zoned Block device characteristics VPD page
2097 * URSWRZ bit is only meaningful for host-managed ZAC drives
2099 if (args->dev->zac_zoned_cap & 1)
2101 put_unaligned_be32(args->dev->zac_zones_optimal_open, &rbuf[8]);
2102 put_unaligned_be32(args->dev->zac_zones_optimal_nonseq, &rbuf[12]);
2103 put_unaligned_be32(args->dev->zac_zones_max_open, &rbuf[16]);
2108 static unsigned int ata_scsiop_inq_b9(struct ata_scsi_args *args, u8 *rbuf)
2110 struct ata_cpr_log *cpr_log = args->dev->cpr_log;
2111 u8 *desc = &rbuf[64];
2114 /* SCSI Concurrent Positioning Ranges VPD page: SBC-5 rev 1 or later */
2116 put_unaligned_be16(64 + (int)cpr_log->nr_cpr * 32 - 4, &rbuf[2]);
2118 for (i = 0; i < cpr_log->nr_cpr; i++, desc += 32) {
2119 desc[0] = cpr_log->cpr[i].num;
2120 desc[1] = cpr_log->cpr[i].num_storage_elements;
2121 put_unaligned_be64(cpr_log->cpr[i].start_lba, &desc[8]);
2122 put_unaligned_be64(cpr_log->cpr[i].num_lbas, &desc[16]);
2129 * modecpy - Prepare response for MODE SENSE
2130 * @dest: output buffer
2131 * @src: data being copied
2132 * @n: length of mode page
2133 * @changeable: whether changeable parameters are requested
2135 * Generate a generic MODE SENSE page for either current or changeable
2141 static void modecpy(u8 *dest, const u8 *src, int n, bool changeable)
2144 memcpy(dest, src, 2);
2145 memset(dest + 2, 0, n - 2);
2147 memcpy(dest, src, n);
2152 * ata_msense_caching - Simulate MODE SENSE caching info page
2153 * @id: device IDENTIFY data
2154 * @buf: output buffer
2155 * @changeable: whether changeable parameters are requested
2157 * Generate a caching info page, which conditionally indicates
2158 * write caching to the SCSI layer, depending on device
2164 static unsigned int ata_msense_caching(u16 *id, u8 *buf, bool changeable)
2166 modecpy(buf, def_cache_mpage, sizeof(def_cache_mpage), changeable);
2168 buf[2] |= (1 << 2); /* ata_mselect_caching() */
2170 buf[2] |= (ata_id_wcache_enabled(id) << 2); /* write cache enable */
2171 buf[12] |= (!ata_id_rahead_enabled(id) << 5); /* disable read ahead */
2173 return sizeof(def_cache_mpage);
2177 * Simulate MODE SENSE control mode page, sub-page 0.
2179 static unsigned int ata_msense_control_spg0(struct ata_device *dev, u8 *buf,
2182 modecpy(buf, def_control_mpage,
2183 sizeof(def_control_mpage), changeable);
2185 /* ata_mselect_control() */
2188 bool d_sense = (dev->flags & ATA_DFLAG_D_SENSE);
2190 /* descriptor format sense data */
2191 buf[2] |= (d_sense << 2);
2194 return sizeof(def_control_mpage);
2198 * Translate an ATA duration limit in microseconds to a SCSI duration limit
2199 * using the t2cdlunits 0xa (10ms). Since the SCSI duration limits are 2-bytes
2200 * only, take care of overflows.
2202 static inline u16 ata_xlat_cdl_limit(u8 *buf)
2204 u32 limit = get_unaligned_le32(buf);
2206 return min_t(u32, limit / 10000, 65535);
2210 * Simulate MODE SENSE control mode page, sub-pages 07h and 08h
2211 * (command duration limits T2A and T2B mode pages).
2213 static unsigned int ata_msense_control_spgt2(struct ata_device *dev, u8 *buf,
2216 u8 *b, *cdl = dev->cdl, *desc;
2221 * Fill the subpage. The first four bytes of the T2A/T2B mode pages
2222 * are a header. The PAGE LENGTH field is the size of the page
2223 * excluding the header.
2225 buf[0] = CONTROL_MPAGE;
2227 put_unaligned_be16(CDL_T2_SUB_MPAGE_LEN - 4, &buf[2]);
2228 if (spg == CDL_T2A_SUB_MPAGE) {
2230 * Read descriptors map to the T2A page:
2231 * set perf_vs_duration_guidleine.
2233 buf[7] = (cdl[0] & 0x03) << 4;
2236 /* Write descriptors map to the T2B page */
2240 /* Fill the T2 page descriptors */
2242 policy = get_unaligned_le32(&cdl[0]);
2243 for (i = 0; i < 7; i++, b += 32, desc += 32) {
2244 /* t2cdlunits: fixed to 10ms */
2247 /* Max inactive time and its policy */
2248 put_unaligned_be16(ata_xlat_cdl_limit(&desc[8]), &b[2]);
2249 b[6] = ((policy >> 8) & 0x0f) << 4;
2251 /* Max active time and its policy */
2252 put_unaligned_be16(ata_xlat_cdl_limit(&desc[4]), &b[4]);
2253 b[6] |= (policy >> 4) & 0x0f;
2255 /* Command duration guideline and its policy */
2256 put_unaligned_be16(ata_xlat_cdl_limit(&desc[16]), &b[10]);
2257 b[14] = policy & 0x0f;
2260 return CDL_T2_SUB_MPAGE_LEN;
2264 * Simulate MODE SENSE control mode page, sub-page f2h
2265 * (ATA feature control mode page).
2267 static unsigned int ata_msense_control_ata_feature(struct ata_device *dev,
2271 buf[0] = CONTROL_MPAGE | (1 << 6);
2272 buf[1] = ATA_FEATURE_SUB_MPAGE;
2275 * The first four bytes of ATA Feature Control mode page are a header.
2276 * The PAGE LENGTH field is the size of the page excluding the header.
2278 put_unaligned_be16(ATA_FEATURE_SUB_MPAGE_LEN - 4, &buf[2]);
2280 if (dev->flags & ATA_DFLAG_CDL)
2281 buf[4] = 0x02; /* Support T2A and T2B pages */
2285 return ATA_FEATURE_SUB_MPAGE_LEN;
2289 * ata_msense_control - Simulate MODE SENSE control mode page
2290 * @dev: ATA device of interest
2291 * @buf: output buffer
2292 * @spg: sub-page code
2293 * @changeable: whether changeable parameters are requested
2295 * Generate a generic MODE SENSE control mode page.
2300 static unsigned int ata_msense_control(struct ata_device *dev, u8 *buf,
2301 u8 spg, bool changeable)
2307 return ata_msense_control_spg0(dev, buf, changeable);
2308 case CDL_T2A_SUB_MPAGE:
2309 case CDL_T2B_SUB_MPAGE:
2310 return ata_msense_control_spgt2(dev, buf, spg);
2311 case ATA_FEATURE_SUB_MPAGE:
2312 return ata_msense_control_ata_feature(dev, buf);
2313 case ALL_SUB_MPAGES:
2314 n = ata_msense_control_spg0(dev, buf, changeable);
2315 n += ata_msense_control_spgt2(dev, buf + n, CDL_T2A_SUB_MPAGE);
2316 n += ata_msense_control_spgt2(dev, buf + n, CDL_T2A_SUB_MPAGE);
2317 n += ata_msense_control_ata_feature(dev, buf + n);
2325 * ata_msense_rw_recovery - Simulate MODE SENSE r/w error recovery page
2326 * @buf: output buffer
2327 * @changeable: whether changeable parameters are requested
2329 * Generate a generic MODE SENSE r/w error recovery page.
2334 static unsigned int ata_msense_rw_recovery(u8 *buf, bool changeable)
2336 modecpy(buf, def_rw_recovery_mpage, sizeof(def_rw_recovery_mpage),
2338 return sizeof(def_rw_recovery_mpage);
2342 * ata_scsiop_mode_sense - Simulate MODE SENSE 6, 10 commands
2343 * @args: device IDENTIFY data / SCSI command of interest.
2344 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2346 * Simulate MODE SENSE commands. Assume this is invoked for direct
2347 * access devices (e.g. disks) only. There should be no block
2348 * descriptor for other device types.
2351 * spin_lock_irqsave(host lock)
2353 static unsigned int ata_scsiop_mode_sense(struct ata_scsi_args *args, u8 *rbuf)
2355 struct ata_device *dev = args->dev;
2356 u8 *scsicmd = args->cmd->cmnd, *p = rbuf;
2357 static const u8 sat_blk_desc[] = {
2358 0, 0, 0, 0, /* number of blocks: sat unspecified */
2360 0, 0x2, 0x0 /* block length: 512 bytes */
2363 unsigned int ebd, page_control, six_byte;
2364 u8 dpofua = 0, bp = 0xff;
2367 six_byte = (scsicmd[0] == MODE_SENSE);
2368 ebd = !(scsicmd[1] & 0x8); /* dbd bit inverted == edb */
2370 * LLBA bit in msense(10) ignored (compliant)
2373 page_control = scsicmd[2] >> 6;
2374 switch (page_control) {
2375 case 0: /* current */
2376 case 1: /* changeable */
2377 case 2: /* defaults */
2378 break; /* supported */
2380 goto saving_not_supp;
2388 p += 4 + (ebd ? 8 : 0);
2390 p += 8 + (ebd ? 8 : 0);
2392 pg = scsicmd[2] & 0x3f;
2396 * Supported subpages: all subpages and sub-pages 07h, 08h and f2h of
2401 case ALL_SUB_MPAGES:
2403 case CDL_T2A_SUB_MPAGE:
2404 case CDL_T2B_SUB_MPAGE:
2405 case ATA_FEATURE_SUB_MPAGE:
2406 if (dev->flags & ATA_DFLAG_CDL && pg == CONTROL_MPAGE)
2416 case RW_RECOVERY_MPAGE:
2417 p += ata_msense_rw_recovery(p, page_control == 1);
2421 p += ata_msense_caching(args->id, p, page_control == 1);
2425 p += ata_msense_control(args->dev, p, spg, page_control == 1);
2429 p += ata_msense_rw_recovery(p, page_control == 1);
2430 p += ata_msense_caching(args->id, p, page_control == 1);
2431 p += ata_msense_control(args->dev, p, spg, page_control == 1);
2434 default: /* invalid page code */
2439 if (dev->flags & ATA_DFLAG_FUA)
2443 rbuf[0] = p - rbuf - 1;
2446 rbuf[3] = sizeof(sat_blk_desc);
2447 memcpy(rbuf + 4, sat_blk_desc, sizeof(sat_blk_desc));
2450 put_unaligned_be16(p - rbuf - 2, &rbuf[0]);
2453 rbuf[7] = sizeof(sat_blk_desc);
2454 memcpy(rbuf + 8, sat_blk_desc, sizeof(sat_blk_desc));
2460 ata_scsi_set_invalid_field(dev, args->cmd, fp, bp);
2464 ata_scsi_set_sense(dev, args->cmd, ILLEGAL_REQUEST, 0x39, 0x0);
2465 /* "Saving parameters not supported" */
2470 * ata_scsiop_read_cap - Simulate READ CAPACITY[ 16] commands
2471 * @args: device IDENTIFY data / SCSI command of interest.
2472 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2474 * Simulate READ CAPACITY commands.
2479 static unsigned int ata_scsiop_read_cap(struct ata_scsi_args *args, u8 *rbuf)
2481 struct ata_device *dev = args->dev;
2482 u64 last_lba = dev->n_sectors - 1; /* LBA of the last block */
2483 u32 sector_size; /* physical sector size in bytes */
2487 sector_size = ata_id_logical_sector_size(dev->id);
2488 log2_per_phys = ata_id_log2_per_physical_sector(dev->id);
2489 lowest_aligned = ata_id_logical_sector_offset(dev->id, log2_per_phys);
2491 if (args->cmd->cmnd[0] == READ_CAPACITY) {
2492 if (last_lba >= 0xffffffffULL)
2493 last_lba = 0xffffffff;
2495 /* sector count, 32-bit */
2496 rbuf[0] = last_lba >> (8 * 3);
2497 rbuf[1] = last_lba >> (8 * 2);
2498 rbuf[2] = last_lba >> (8 * 1);
2502 rbuf[4] = sector_size >> (8 * 3);
2503 rbuf[5] = sector_size >> (8 * 2);
2504 rbuf[6] = sector_size >> (8 * 1);
2505 rbuf[7] = sector_size;
2507 /* sector count, 64-bit */
2508 rbuf[0] = last_lba >> (8 * 7);
2509 rbuf[1] = last_lba >> (8 * 6);
2510 rbuf[2] = last_lba >> (8 * 5);
2511 rbuf[3] = last_lba >> (8 * 4);
2512 rbuf[4] = last_lba >> (8 * 3);
2513 rbuf[5] = last_lba >> (8 * 2);
2514 rbuf[6] = last_lba >> (8 * 1);
2518 rbuf[ 8] = sector_size >> (8 * 3);
2519 rbuf[ 9] = sector_size >> (8 * 2);
2520 rbuf[10] = sector_size >> (8 * 1);
2521 rbuf[11] = sector_size;
2524 rbuf[13] = log2_per_phys;
2525 rbuf[14] = (lowest_aligned >> 8) & 0x3f;
2526 rbuf[15] = lowest_aligned;
2528 if (ata_id_has_trim(args->id) &&
2529 !(dev->horkage & ATA_HORKAGE_NOTRIM)) {
2530 rbuf[14] |= 0x80; /* LBPME */
2532 if (ata_id_has_zero_after_trim(args->id) &&
2533 dev->horkage & ATA_HORKAGE_ZERO_AFTER_TRIM) {
2534 ata_dev_info(dev, "Enabling discard_zeroes_data\n");
2535 rbuf[14] |= 0x40; /* LBPRZ */
2538 if (ata_id_zoned_cap(args->id) ||
2539 args->dev->class == ATA_DEV_ZAC)
2540 rbuf[12] = (1 << 4); /* RC_BASIS */
2546 * ata_scsiop_report_luns - Simulate REPORT LUNS command
2547 * @args: device IDENTIFY data / SCSI command of interest.
2548 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2550 * Simulate REPORT LUNS command.
2553 * spin_lock_irqsave(host lock)
2555 static unsigned int ata_scsiop_report_luns(struct ata_scsi_args *args, u8 *rbuf)
2557 rbuf[3] = 8; /* just one lun, LUN 0, size 8 bytes */
2563 * ATAPI devices typically report zero for their SCSI version, and sometimes
2564 * deviate from the spec WRT response data format. If SCSI version is
2565 * reported as zero like normal, then we make the following fixups:
2566 * 1) Fake MMC-5 version, to indicate to the Linux scsi midlayer this is a
2568 * 2) Ensure response data format / ATAPI information are always correct.
2570 static void atapi_fixup_inquiry(struct scsi_cmnd *cmd)
2574 sg_copy_to_buffer(scsi_sglist(cmd), scsi_sg_count(cmd), buf, 4);
2579 sg_copy_from_buffer(scsi_sglist(cmd), scsi_sg_count(cmd), buf, 4);
2582 static void atapi_qc_complete(struct ata_queued_cmd *qc)
2584 struct scsi_cmnd *cmd = qc->scsicmd;
2585 unsigned int err_mask = qc->err_mask;
2587 /* handle completion from EH */
2588 if (unlikely(err_mask || qc->flags & ATA_QCFLAG_SENSE_VALID)) {
2590 if (!(qc->flags & ATA_QCFLAG_SENSE_VALID)) {
2591 /* FIXME: not quite right; we don't want the
2592 * translation of taskfile registers into a
2593 * sense descriptors, since that's only
2594 * correct for ATA, not ATAPI
2596 ata_gen_passthru_sense(qc);
2599 /* SCSI EH automatically locks door if sdev->locked is
2600 * set. Sometimes door lock request continues to
2601 * fail, for example, when no media is present. This
2602 * creates a loop - SCSI EH issues door lock which
2603 * fails and gets invoked again to acquire sense data
2604 * for the failed command.
2606 * If door lock fails, always clear sdev->locked to
2607 * avoid this infinite loop.
2609 * This may happen before SCSI scan is complete. Make
2610 * sure qc->dev->sdev isn't NULL before dereferencing.
2612 if (qc->cdb[0] == ALLOW_MEDIUM_REMOVAL && qc->dev->sdev)
2613 qc->dev->sdev->locked = 0;
2615 qc->scsicmd->result = SAM_STAT_CHECK_CONDITION;
2620 /* successful completion path */
2621 if (cmd->cmnd[0] == INQUIRY && (cmd->cmnd[1] & 0x03) == 0)
2622 atapi_fixup_inquiry(cmd);
2623 cmd->result = SAM_STAT_GOOD;
2628 * atapi_xlat - Initialize PACKET taskfile
2629 * @qc: command structure to be initialized
2632 * spin_lock_irqsave(host lock)
2635 * Zero on success, non-zero on failure.
2637 static unsigned int atapi_xlat(struct ata_queued_cmd *qc)
2639 struct scsi_cmnd *scmd = qc->scsicmd;
2640 struct ata_device *dev = qc->dev;
2641 int nodata = (scmd->sc_data_direction == DMA_NONE);
2642 int using_pio = !nodata && (dev->flags & ATA_DFLAG_PIO);
2643 unsigned int nbytes;
2645 memset(qc->cdb, 0, dev->cdb_len);
2646 memcpy(qc->cdb, scmd->cmnd, scmd->cmd_len);
2648 qc->complete_fn = atapi_qc_complete;
2650 qc->tf.flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
2651 if (scmd->sc_data_direction == DMA_TO_DEVICE) {
2652 qc->tf.flags |= ATA_TFLAG_WRITE;
2655 qc->tf.command = ATA_CMD_PACKET;
2656 ata_qc_set_pc_nbytes(qc);
2658 /* check whether ATAPI DMA is safe */
2659 if (!nodata && !using_pio && atapi_check_dma(qc))
2662 /* Some controller variants snoop this value for Packet
2663 * transfers to do state machine and FIFO management. Thus we
2664 * want to set it properly, and for DMA where it is
2665 * effectively meaningless.
2667 nbytes = min(ata_qc_raw_nbytes(qc), (unsigned int)63 * 1024);
2669 /* Most ATAPI devices which honor transfer chunk size don't
2670 * behave according to the spec when odd chunk size which
2671 * matches the transfer length is specified. If the number of
2672 * bytes to transfer is 2n+1. According to the spec, what
2673 * should happen is to indicate that 2n+1 is going to be
2674 * transferred and transfer 2n+2 bytes where the last byte is
2677 * In practice, this doesn't happen. ATAPI devices first
2678 * indicate and transfer 2n bytes and then indicate and
2679 * transfer 2 bytes where the last byte is padding.
2681 * This inconsistency confuses several controllers which
2682 * perform PIO using DMA such as Intel AHCIs and sil3124/32.
2683 * These controllers use actual number of transferred bytes to
2684 * update DMA pointer and transfer of 4n+2 bytes make those
2685 * controller push DMA pointer by 4n+4 bytes because SATA data
2686 * FISes are aligned to 4 bytes. This causes data corruption
2687 * and buffer overrun.
2689 * Always setting nbytes to even number solves this problem
2690 * because then ATAPI devices don't have to split data at 2n
2696 qc->tf.lbam = (nbytes & 0xFF);
2697 qc->tf.lbah = (nbytes >> 8);
2700 qc->tf.protocol = ATAPI_PROT_NODATA;
2702 qc->tf.protocol = ATAPI_PROT_PIO;
2705 qc->tf.protocol = ATAPI_PROT_DMA;
2706 qc->tf.feature |= ATAPI_PKT_DMA;
2708 if ((dev->flags & ATA_DFLAG_DMADIR) &&
2709 (scmd->sc_data_direction != DMA_TO_DEVICE))
2710 /* some SATA bridges need us to indicate data xfer direction */
2711 qc->tf.feature |= ATAPI_DMADIR;
2715 /* FIXME: We need to translate 0x05 READ_BLOCK_LIMITS to a MODE_SENSE
2716 as ATAPI tape drives don't get this right otherwise */
2720 static struct ata_device *ata_find_dev(struct ata_port *ap, unsigned int devno)
2723 * For the non-PMP case, ata_link_max_devices() returns 1 (SATA case),
2724 * or 2 (IDE master + slave case). However, the former case includes
2725 * libsas hosted devices which are numbered per scsi host, leading
2726 * to devno potentially being larger than 0 but with each struct
2727 * ata_device having its own struct ata_port and struct ata_link.
2728 * To accommodate these, ignore devno and always use device number 0.
2730 if (likely(!sata_pmp_attached(ap))) {
2731 int link_max_devices = ata_link_max_devices(&ap->link);
2733 if (link_max_devices == 1)
2734 return &ap->link.device[0];
2736 if (devno < link_max_devices)
2737 return &ap->link.device[devno];
2743 * For PMP-attached devices, the device number corresponds to C
2744 * (channel) of SCSI [H:C:I:L], indicating the port pmp link
2747 if (devno < ap->nr_pmp_links)
2748 return &ap->pmp_link[devno].device[0];
2753 static struct ata_device *__ata_scsi_find_dev(struct ata_port *ap,
2754 const struct scsi_device *scsidev)
2758 /* skip commands not addressed to targets we simulate */
2759 if (!sata_pmp_attached(ap)) {
2760 if (unlikely(scsidev->channel || scsidev->lun))
2762 devno = scsidev->id;
2764 if (unlikely(scsidev->id || scsidev->lun))
2766 devno = scsidev->channel;
2769 return ata_find_dev(ap, devno);
2773 * ata_scsi_find_dev - lookup ata_device from scsi_cmnd
2774 * @ap: ATA port to which the device is attached
2775 * @scsidev: SCSI device from which we derive the ATA device
2777 * Given various information provided in struct scsi_cmnd,
2778 * map that onto an ATA bus, and using that mapping
2779 * determine which ata_device is associated with the
2780 * SCSI command to be sent.
2783 * spin_lock_irqsave(host lock)
2786 * Associated ATA device, or %NULL if not found.
2789 ata_scsi_find_dev(struct ata_port *ap, const struct scsi_device *scsidev)
2791 struct ata_device *dev = __ata_scsi_find_dev(ap, scsidev);
2793 if (unlikely(!dev || !ata_dev_enabled(dev)))
2800 * ata_scsi_map_proto - Map pass-thru protocol value to taskfile value.
2801 * @byte1: Byte 1 from pass-thru CDB.
2804 * ATA_PROT_UNKNOWN if mapping failed/unimplemented, protocol otherwise.
2807 ata_scsi_map_proto(u8 byte1)
2809 switch((byte1 & 0x1e) >> 1) {
2810 case 3: /* Non-data */
2811 return ATA_PROT_NODATA;
2814 case 10: /* UDMA Data-in */
2815 case 11: /* UDMA Data-Out */
2816 return ATA_PROT_DMA;
2818 case 4: /* PIO Data-in */
2819 case 5: /* PIO Data-out */
2820 return ATA_PROT_PIO;
2822 case 12: /* FPDMA */
2823 return ATA_PROT_NCQ;
2825 case 0: /* Hard Reset */
2827 case 8: /* Device Diagnostic */
2828 case 9: /* Device Reset */
2829 case 7: /* DMA Queued */
2830 case 15: /* Return Response Info */
2831 default: /* Reserved */
2835 return ATA_PROT_UNKNOWN;
2839 * ata_scsi_pass_thru - convert ATA pass-thru CDB to taskfile
2840 * @qc: command structure to be initialized
2842 * Handles either 12, 16, or 32-byte versions of the CDB.
2845 * Zero on success, non-zero on failure.
2847 static unsigned int ata_scsi_pass_thru(struct ata_queued_cmd *qc)
2849 struct ata_taskfile *tf = &(qc->tf);
2850 struct scsi_cmnd *scmd = qc->scsicmd;
2851 struct ata_device *dev = qc->dev;
2852 const u8 *cdb = scmd->cmnd;
2856 /* 7Fh variable length cmd means a ata pass-thru(32) */
2857 if (cdb[0] == VARIABLE_LENGTH_CMD)
2860 tf->protocol = ata_scsi_map_proto(cdb[1 + cdb_offset]);
2861 if (tf->protocol == ATA_PROT_UNKNOWN) {
2866 if ((cdb[2 + cdb_offset] & 0x3) == 0) {
2868 * When T_LENGTH is zero (No data is transferred), dir should
2871 if (scmd->sc_data_direction != DMA_NONE) {
2872 fp = 2 + cdb_offset;
2876 if (ata_is_ncq(tf->protocol))
2877 tf->protocol = ATA_PROT_NCQ_NODATA;
2881 tf->flags |= ATA_TFLAG_LBA;
2884 * 12 and 16 byte CDBs use different offsets to
2885 * provide the various register values.
2890 * 16-byte CDB - may contain extended commands.
2892 * If that is the case, copy the upper byte register values.
2894 if (cdb[1] & 0x01) {
2895 tf->hob_feature = cdb[3];
2896 tf->hob_nsect = cdb[5];
2897 tf->hob_lbal = cdb[7];
2898 tf->hob_lbam = cdb[9];
2899 tf->hob_lbah = cdb[11];
2900 tf->flags |= ATA_TFLAG_LBA48;
2902 tf->flags &= ~ATA_TFLAG_LBA48;
2905 * Always copy low byte, device and command registers.
2907 tf->feature = cdb[4];
2912 tf->device = cdb[13];
2913 tf->command = cdb[14];
2917 * 12-byte CDB - incapable of extended commands.
2919 tf->flags &= ~ATA_TFLAG_LBA48;
2921 tf->feature = cdb[3];
2926 tf->device = cdb[8];
2927 tf->command = cdb[9];
2931 * 32-byte CDB - may contain extended command fields.
2933 * If that is the case, copy the upper byte register values.
2935 if (cdb[10] & 0x01) {
2936 tf->hob_feature = cdb[20];
2937 tf->hob_nsect = cdb[22];
2938 tf->hob_lbal = cdb[16];
2939 tf->hob_lbam = cdb[15];
2940 tf->hob_lbah = cdb[14];
2941 tf->flags |= ATA_TFLAG_LBA48;
2943 tf->flags &= ~ATA_TFLAG_LBA48;
2945 tf->feature = cdb[21];
2946 tf->nsect = cdb[23];
2950 tf->device = cdb[24];
2951 tf->command = cdb[25];
2952 tf->auxiliary = get_unaligned_be32(&cdb[28]);
2956 /* For NCQ commands copy the tag value */
2957 if (ata_is_ncq(tf->protocol))
2958 tf->nsect = qc->hw_tag << 3;
2960 /* enforce correct master/slave bit */
2961 tf->device = dev->devno ?
2962 tf->device | ATA_DEV1 : tf->device & ~ATA_DEV1;
2964 switch (tf->command) {
2965 /* READ/WRITE LONG use a non-standard sect_size */
2966 case ATA_CMD_READ_LONG:
2967 case ATA_CMD_READ_LONG_ONCE:
2968 case ATA_CMD_WRITE_LONG:
2969 case ATA_CMD_WRITE_LONG_ONCE:
2970 if (tf->protocol != ATA_PROT_PIO || tf->nsect != 1) {
2974 qc->sect_size = scsi_bufflen(scmd);
2977 /* commands using reported Logical Block size (e.g. 512 or 4K) */
2978 case ATA_CMD_CFA_WRITE_NE:
2979 case ATA_CMD_CFA_TRANS_SECT:
2980 case ATA_CMD_CFA_WRITE_MULT_NE:
2981 /* XXX: case ATA_CMD_CFA_WRITE_SECTORS_WITHOUT_ERASE: */
2983 case ATA_CMD_READ_EXT:
2984 case ATA_CMD_READ_QUEUED:
2985 /* XXX: case ATA_CMD_READ_QUEUED_EXT: */
2986 case ATA_CMD_FPDMA_READ:
2987 case ATA_CMD_READ_MULTI:
2988 case ATA_CMD_READ_MULTI_EXT:
2989 case ATA_CMD_PIO_READ:
2990 case ATA_CMD_PIO_READ_EXT:
2991 case ATA_CMD_READ_STREAM_DMA_EXT:
2992 case ATA_CMD_READ_STREAM_EXT:
2993 case ATA_CMD_VERIFY:
2994 case ATA_CMD_VERIFY_EXT:
2996 case ATA_CMD_WRITE_EXT:
2997 case ATA_CMD_WRITE_FUA_EXT:
2998 case ATA_CMD_WRITE_QUEUED:
2999 case ATA_CMD_WRITE_QUEUED_FUA_EXT:
3000 case ATA_CMD_FPDMA_WRITE:
3001 case ATA_CMD_WRITE_MULTI:
3002 case ATA_CMD_WRITE_MULTI_EXT:
3003 case ATA_CMD_WRITE_MULTI_FUA_EXT:
3004 case ATA_CMD_PIO_WRITE:
3005 case ATA_CMD_PIO_WRITE_EXT:
3006 case ATA_CMD_WRITE_STREAM_DMA_EXT:
3007 case ATA_CMD_WRITE_STREAM_EXT:
3008 qc->sect_size = scmd->device->sector_size;
3011 /* Everything else uses 512 byte "sectors" */
3013 qc->sect_size = ATA_SECT_SIZE;
3017 * Set flags so that all registers will be written, pass on
3018 * write indication (used for PIO/DMA setup), result TF is
3019 * copied back and we don't whine too much about its failure.
3021 tf->flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
3022 if (scmd->sc_data_direction == DMA_TO_DEVICE)
3023 tf->flags |= ATA_TFLAG_WRITE;
3025 qc->flags |= ATA_QCFLAG_RESULT_TF | ATA_QCFLAG_QUIET;
3028 * Set transfer length.
3030 * TODO: find out if we need to do more here to
3031 * cover scatter/gather case.
3033 ata_qc_set_pc_nbytes(qc);
3035 /* We may not issue DMA commands if no DMA mode is set */
3036 if (tf->protocol == ATA_PROT_DMA && !ata_dma_enabled(dev)) {
3041 /* We may not issue NCQ commands to devices not supporting NCQ */
3042 if (ata_is_ncq(tf->protocol) && !ata_ncq_enabled(dev)) {
3047 /* sanity check for pio multi commands */
3048 if ((cdb[1] & 0xe0) && !is_multi_taskfile(tf)) {
3053 if (is_multi_taskfile(tf)) {
3054 unsigned int multi_count = 1 << (cdb[1] >> 5);
3056 /* compare the passed through multi_count
3057 * with the cached multi_count of libata
3059 if (multi_count != dev->multi_count)
3060 ata_dev_warn(dev, "invalid multi_count %u ignored\n",
3065 * Filter SET_FEATURES - XFER MODE command -- otherwise,
3066 * SET_FEATURES - XFER MODE must be preceded/succeeded
3067 * by an update to hardware-specific registers for each
3068 * controller (i.e. the reason for ->set_piomode(),
3069 * ->set_dmamode(), and ->post_set_mode() hooks).
3071 if (tf->command == ATA_CMD_SET_FEATURES &&
3072 tf->feature == SETFEATURES_XFER) {
3073 fp = (cdb[0] == ATA_16) ? 4 : 3;
3078 * Filter TPM commands by default. These provide an
3079 * essentially uncontrolled encrypted "back door" between
3080 * applications and the disk. Set libata.allow_tpm=1 if you
3081 * have a real reason for wanting to use them. This ensures
3082 * that installed software cannot easily mess stuff up without
3083 * user intent. DVR type users will probably ship with this enabled
3084 * for movie content management.
3086 * Note that for ATA8 we can issue a DCS change and DCS freeze lock
3087 * for this and should do in future but that it is not sufficient as
3088 * DCS is an optional feature set. Thus we also do the software filter
3089 * so that we comply with the TC consortium stated goal that the user
3090 * can turn off TC features of their system.
3092 if (tf->command >= 0x5C && tf->command <= 0x5F && !libata_allow_tpm) {
3093 fp = (cdb[0] == ATA_16) ? 14 : 9;
3100 ata_scsi_set_invalid_field(dev, scmd, fp, 0xff);
3105 * ata_format_dsm_trim_descr() - SATL Write Same to DSM Trim
3106 * @cmd: SCSI command being translated
3107 * @trmax: Maximum number of entries that will fit in sector_size bytes.
3108 * @sector: Starting sector
3109 * @count: Total Range of request in logical sectors
3111 * Rewrite the WRITE SAME descriptor to be a DSM TRIM little-endian formatted
3114 * Upto 64 entries of the format:
3115 * 63:48 Range Length
3118 * Range Length of 0 is ignored.
3119 * LBA's should be sorted order and not overlap.
3121 * NOTE: this is the same format as ADD LBA(S) TO NV CACHE PINNED SET
3123 * Return: Number of bytes copied into sglist.
3125 static size_t ata_format_dsm_trim_descr(struct scsi_cmnd *cmd, u32 trmax,
3126 u64 sector, u32 count)
3128 struct scsi_device *sdp = cmd->device;
3129 size_t len = sdp->sector_size;
3133 unsigned long flags;
3135 WARN_ON(len > ATA_SCSI_RBUF_SIZE);
3137 if (len > ATA_SCSI_RBUF_SIZE)
3138 len = ATA_SCSI_RBUF_SIZE;
3140 spin_lock_irqsave(&ata_scsi_rbuf_lock, flags);
3141 buf = ((void *)ata_scsi_rbuf);
3142 memset(buf, 0, len);
3144 u64 entry = sector |
3145 ((u64)(count > 0xffff ? 0xffff : count) << 48);
3146 buf[i++] = __cpu_to_le64(entry);
3147 if (count <= 0xffff)
3152 r = sg_copy_from_buffer(scsi_sglist(cmd), scsi_sg_count(cmd), buf, len);
3153 spin_unlock_irqrestore(&ata_scsi_rbuf_lock, flags);
3159 * ata_scsi_write_same_xlat() - SATL Write Same to ATA SCT Write Same
3160 * @qc: Command to be translated
3162 * Translate a SCSI WRITE SAME command to be either a DSM TRIM command or
3163 * an SCT Write Same command.
3164 * Based on WRITE SAME has the UNMAP flag:
3166 * - When set translate to DSM TRIM
3167 * - When clear translate to SCT Write Same
3169 static unsigned int ata_scsi_write_same_xlat(struct ata_queued_cmd *qc)
3171 struct ata_taskfile *tf = &qc->tf;
3172 struct scsi_cmnd *scmd = qc->scsicmd;
3173 struct scsi_device *sdp = scmd->device;
3174 size_t len = sdp->sector_size;
3175 struct ata_device *dev = qc->dev;
3176 const u8 *cdb = scmd->cmnd;
3179 const u32 trmax = len >> 3;
3183 u8 unmap = cdb[1] & 0x8;
3185 /* we may not issue DMA commands if no DMA mode is set */
3186 if (unlikely(!ata_dma_enabled(dev)))
3187 goto invalid_opcode;
3190 * We only allow sending this command through the block layer,
3191 * as it modifies the DATA OUT buffer, which would corrupt user
3192 * memory for SG_IO commands.
3194 if (unlikely(blk_rq_is_passthrough(scsi_cmd_to_rq(scmd))))
3195 goto invalid_opcode;
3197 if (unlikely(scmd->cmd_len < 16)) {
3201 scsi_16_lba_len(cdb, &block, &n_block);
3204 (dev->horkage & ATA_HORKAGE_NOTRIM) ||
3205 !ata_id_has_trim(dev->id)) {
3210 /* If the request is too large the cmd is invalid */
3211 if (n_block > 0xffff * trmax) {
3217 * WRITE SAME always has a sector sized buffer as payload, this
3218 * should never be a multiple entry S/G list.
3220 if (!scsi_sg_count(scmd))
3221 goto invalid_param_len;
3224 * size must match sector size in bytes
3225 * For DATA SET MANAGEMENT TRIM in ACS-2 nsect (aka count)
3226 * is defined as number of 512 byte blocks to be transferred.
3229 size = ata_format_dsm_trim_descr(scmd, trmax, block, n_block);
3231 goto invalid_param_len;
3233 if (ata_ncq_enabled(dev) && ata_fpdma_dsm_supported(dev)) {
3234 /* Newer devices support queued TRIM commands */
3235 tf->protocol = ATA_PROT_NCQ;
3236 tf->command = ATA_CMD_FPDMA_SEND;
3237 tf->hob_nsect = ATA_SUBCMD_FPDMA_SEND_DSM & 0x1f;
3238 tf->nsect = qc->hw_tag << 3;
3239 tf->hob_feature = (size / 512) >> 8;
3240 tf->feature = size / 512;
3244 tf->protocol = ATA_PROT_DMA;
3245 tf->hob_feature = 0;
3246 tf->feature = ATA_DSM_TRIM;
3247 tf->hob_nsect = (size / 512) >> 8;
3248 tf->nsect = size / 512;
3249 tf->command = ATA_CMD_DSM;
3252 tf->flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE | ATA_TFLAG_LBA48 |
3255 ata_qc_set_pc_nbytes(qc);
3260 ata_scsi_set_invalid_field(dev, scmd, fp, bp);
3263 /* "Parameter list length error" */
3264 ata_scsi_set_sense(dev, scmd, ILLEGAL_REQUEST, 0x1a, 0x0);
3267 /* "Invalid command operation code" */
3268 ata_scsi_set_sense(dev, scmd, ILLEGAL_REQUEST, 0x20, 0x0);
3273 * ata_scsiop_maint_in - Simulate a subset of MAINTENANCE_IN
3274 * @args: device MAINTENANCE_IN data / SCSI command of interest.
3275 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
3277 * Yields a subset to satisfy scsi_report_opcode()
3280 * spin_lock_irqsave(host lock)
3282 static unsigned int ata_scsiop_maint_in(struct ata_scsi_args *args, u8 *rbuf)
3284 struct ata_device *dev = args->dev;
3285 u8 *cdb = args->cmd->cmnd;
3286 u8 supported = 0, cdlp = 0, rwcdlp = 0;
3287 unsigned int err = 0;
3289 if (cdb[2] != 1 && cdb[2] != 3) {
3290 ata_dev_warn(dev, "invalid command format %d\n", cdb[2]);
3300 case SERVICE_ACTION_IN_16:
3303 case SYNCHRONIZE_CACHE:
3304 case SYNCHRONIZE_CACHE_16:
3308 case TEST_UNIT_READY:
3309 case SEND_DIAGNOSTIC:
3310 case MAINTENANCE_IN:
3320 case MODE_SELECT_10:
3326 if (dev->flags & ATA_DFLAG_CDL) {
3328 * CDL read descriptors map to the T2A page, that is,
3329 * rwcdlp = 0x01 and cdlp = 0x01
3337 if (dev->flags & ATA_DFLAG_CDL) {
3339 * CDL write descriptors map to the T2B page, that is,
3340 * rwcdlp = 0x01 and cdlp = 0x02
3348 if (ata_id_zoned_cap(dev->id) ||
3349 dev->class == ATA_DEV_ZAC)
3352 case SECURITY_PROTOCOL_IN:
3353 case SECURITY_PROTOCOL_OUT:
3354 if (dev->flags & ATA_DFLAG_TRUSTED)
3361 /* One command format */
3363 rbuf[1] = cdlp | supported;
3368 * ata_scsi_report_zones_complete - convert ATA output
3369 * @qc: command structure returning the data
3371 * Convert T-13 little-endian field representation into
3372 * T-10 big-endian field representation.
3375 static void ata_scsi_report_zones_complete(struct ata_queued_cmd *qc)
3377 struct scsi_cmnd *scmd = qc->scsicmd;
3378 struct sg_mapping_iter miter;
3379 unsigned long flags;
3380 unsigned int bytes = 0;
3382 sg_miter_start(&miter, scsi_sglist(scmd), scsi_sg_count(scmd),
3383 SG_MITER_TO_SG | SG_MITER_ATOMIC);
3385 local_irq_save(flags);
3386 while (sg_miter_next(&miter)) {
3387 unsigned int offset = 0;
3392 u64 max_lba, opt_lba;
3395 /* Swizzle header */
3397 list_length = get_unaligned_le32(&hdr[0]);
3398 same = get_unaligned_le16(&hdr[4]);
3399 max_lba = get_unaligned_le64(&hdr[8]);
3400 opt_lba = get_unaligned_le64(&hdr[16]);
3401 put_unaligned_be32(list_length, &hdr[0]);
3402 hdr[4] = same & 0xf;
3403 put_unaligned_be64(max_lba, &hdr[8]);
3404 put_unaligned_be64(opt_lba, &hdr[16]);
3408 while (offset < miter.length) {
3410 u8 cond, type, non_seq, reset;
3411 u64 size, start, wp;
3413 /* Swizzle zone descriptor */
3414 rec = miter.addr + offset;
3415 type = rec[0] & 0xf;
3416 cond = (rec[1] >> 4) & 0xf;
3417 non_seq = (rec[1] & 2);
3418 reset = (rec[1] & 1);
3419 size = get_unaligned_le64(&rec[8]);
3420 start = get_unaligned_le64(&rec[16]);
3421 wp = get_unaligned_le64(&rec[24]);
3423 rec[1] = (cond << 4) | non_seq | reset;
3424 put_unaligned_be64(size, &rec[8]);
3425 put_unaligned_be64(start, &rec[16]);
3426 put_unaligned_be64(wp, &rec[24]);
3427 WARN_ON(offset + 64 > miter.length);
3432 sg_miter_stop(&miter);
3433 local_irq_restore(flags);
3435 ata_scsi_qc_complete(qc);
3438 static unsigned int ata_scsi_zbc_in_xlat(struct ata_queued_cmd *qc)
3440 struct ata_taskfile *tf = &qc->tf;
3441 struct scsi_cmnd *scmd = qc->scsicmd;
3442 const u8 *cdb = scmd->cmnd;
3443 u16 sect, fp = (u16)-1;
3444 u8 sa, options, bp = 0xff;
3448 if (unlikely(scmd->cmd_len < 16)) {
3449 ata_dev_warn(qc->dev, "invalid cdb length %d\n",
3454 scsi_16_lba_len(cdb, &block, &n_block);
3455 if (n_block != scsi_bufflen(scmd)) {
3456 ata_dev_warn(qc->dev, "non-matching transfer count (%d/%d)\n",
3457 n_block, scsi_bufflen(scmd));
3458 goto invalid_param_len;
3461 if (sa != ZI_REPORT_ZONES) {
3462 ata_dev_warn(qc->dev, "invalid service action %d\n", sa);
3467 * ZAC allows only for transfers in 512 byte blocks,
3468 * and uses a 16 bit value for the transfer count.
3470 if ((n_block / 512) > 0xffff || n_block < 512 || (n_block % 512)) {
3471 ata_dev_warn(qc->dev, "invalid transfer count %d\n", n_block);
3472 goto invalid_param_len;
3474 sect = n_block / 512;
3475 options = cdb[14] & 0xbf;
3477 if (ata_ncq_enabled(qc->dev) &&
3478 ata_fpdma_zac_mgmt_in_supported(qc->dev)) {
3479 tf->protocol = ATA_PROT_NCQ;
3480 tf->command = ATA_CMD_FPDMA_RECV;
3481 tf->hob_nsect = ATA_SUBCMD_FPDMA_RECV_ZAC_MGMT_IN & 0x1f;
3482 tf->nsect = qc->hw_tag << 3;
3483 tf->feature = sect & 0xff;
3484 tf->hob_feature = (sect >> 8) & 0xff;
3485 tf->auxiliary = ATA_SUBCMD_ZAC_MGMT_IN_REPORT_ZONES | (options << 8);
3487 tf->command = ATA_CMD_ZAC_MGMT_IN;
3488 tf->feature = ATA_SUBCMD_ZAC_MGMT_IN_REPORT_ZONES;
3489 tf->protocol = ATA_PROT_DMA;
3490 tf->hob_feature = options;
3491 tf->hob_nsect = (sect >> 8) & 0xff;
3492 tf->nsect = sect & 0xff;
3494 tf->device = ATA_LBA;
3495 tf->lbah = (block >> 16) & 0xff;
3496 tf->lbam = (block >> 8) & 0xff;
3497 tf->lbal = block & 0xff;
3498 tf->hob_lbah = (block >> 40) & 0xff;
3499 tf->hob_lbam = (block >> 32) & 0xff;
3500 tf->hob_lbal = (block >> 24) & 0xff;
3502 tf->flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE | ATA_TFLAG_LBA48;
3503 qc->flags |= ATA_QCFLAG_RESULT_TF;
3505 ata_qc_set_pc_nbytes(qc);
3507 qc->complete_fn = ata_scsi_report_zones_complete;
3512 ata_scsi_set_invalid_field(qc->dev, scmd, fp, bp);
3516 /* "Parameter list length error" */
3517 ata_scsi_set_sense(qc->dev, scmd, ILLEGAL_REQUEST, 0x1a, 0x0);
3521 static unsigned int ata_scsi_zbc_out_xlat(struct ata_queued_cmd *qc)
3523 struct ata_taskfile *tf = &qc->tf;
3524 struct scsi_cmnd *scmd = qc->scsicmd;
3525 struct ata_device *dev = qc->dev;
3526 const u8 *cdb = scmd->cmnd;
3532 if (unlikely(scmd->cmd_len < 16)) {
3538 if ((sa != ZO_CLOSE_ZONE) && (sa != ZO_FINISH_ZONE) &&
3539 (sa != ZO_OPEN_ZONE) && (sa != ZO_RESET_WRITE_POINTER)) {
3544 scsi_16_lba_len(cdb, &block, &n_block);
3547 * ZAC MANAGEMENT OUT doesn't define any length
3549 goto invalid_param_len;
3552 all = cdb[14] & 0x1;
3555 * Ignore the block address (zone ID) as defined by ZBC.
3558 } else if (block >= dev->n_sectors) {
3560 * Block must be a valid zone ID (a zone start LBA).
3566 if (ata_ncq_enabled(qc->dev) &&
3567 ata_fpdma_zac_mgmt_out_supported(qc->dev)) {
3568 tf->protocol = ATA_PROT_NCQ_NODATA;
3569 tf->command = ATA_CMD_NCQ_NON_DATA;
3570 tf->feature = ATA_SUBCMD_NCQ_NON_DATA_ZAC_MGMT_OUT;
3571 tf->nsect = qc->hw_tag << 3;
3572 tf->auxiliary = sa | ((u16)all << 8);
3574 tf->protocol = ATA_PROT_NODATA;
3575 tf->command = ATA_CMD_ZAC_MGMT_OUT;
3577 tf->hob_feature = all;
3579 tf->lbah = (block >> 16) & 0xff;
3580 tf->lbam = (block >> 8) & 0xff;
3581 tf->lbal = block & 0xff;
3582 tf->hob_lbah = (block >> 40) & 0xff;
3583 tf->hob_lbam = (block >> 32) & 0xff;
3584 tf->hob_lbal = (block >> 24) & 0xff;
3585 tf->device = ATA_LBA;
3586 tf->flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE | ATA_TFLAG_LBA48;
3591 ata_scsi_set_invalid_field(qc->dev, scmd, fp, 0xff);
3594 /* "Parameter list length error" */
3595 ata_scsi_set_sense(qc->dev, scmd, ILLEGAL_REQUEST, 0x1a, 0x0);
3600 * ata_mselect_caching - Simulate MODE SELECT for caching info page
3601 * @qc: Storage for translated ATA taskfile
3602 * @buf: input buffer
3603 * @len: number of valid bytes in the input buffer
3604 * @fp: out parameter for the failed field on error
3606 * Prepare a taskfile to modify caching information for the device.
3611 static int ata_mselect_caching(struct ata_queued_cmd *qc,
3612 const u8 *buf, int len, u16 *fp)
3614 struct ata_taskfile *tf = &qc->tf;
3615 struct ata_device *dev = qc->dev;
3616 u8 mpage[CACHE_MPAGE_LEN];
3621 * The first two bytes of def_cache_mpage are a header, so offsets
3622 * in mpage are off by 2 compared to buf. Same for len.
3625 if (len != CACHE_MPAGE_LEN - 2) {
3626 *fp = min(len, CACHE_MPAGE_LEN - 2);
3630 wce = buf[0] & (1 << 2);
3633 * Check that read-only bits are not modified.
3635 ata_msense_caching(dev->id, mpage, false);
3636 for (i = 0; i < CACHE_MPAGE_LEN - 2; i++) {
3639 if (mpage[i + 2] != buf[i]) {
3645 tf->flags |= ATA_TFLAG_DEVICE | ATA_TFLAG_ISADDR;
3646 tf->protocol = ATA_PROT_NODATA;
3648 tf->command = ATA_CMD_SET_FEATURES;
3649 tf->feature = wce ? SETFEATURES_WC_ON : SETFEATURES_WC_OFF;
3654 * Simulate MODE SELECT control mode page, sub-page 0.
3656 static int ata_mselect_control_spg0(struct ata_queued_cmd *qc,
3657 const u8 *buf, int len, u16 *fp)
3659 struct ata_device *dev = qc->dev;
3660 u8 mpage[CONTROL_MPAGE_LEN];
3665 * The first two bytes of def_control_mpage are a header, so offsets
3666 * in mpage are off by 2 compared to buf. Same for len.
3669 if (len != CONTROL_MPAGE_LEN - 2) {
3670 *fp = min(len, CONTROL_MPAGE_LEN - 2);
3674 d_sense = buf[0] & (1 << 2);
3677 * Check that read-only bits are not modified.
3679 ata_msense_control_spg0(dev, mpage, false);
3680 for (i = 0; i < CONTROL_MPAGE_LEN - 2; i++) {
3683 if (mpage[2 + i] != buf[i]) {
3688 if (d_sense & (1 << 2))
3689 dev->flags |= ATA_DFLAG_D_SENSE;
3691 dev->flags &= ~ATA_DFLAG_D_SENSE;
3696 * Translate MODE SELECT control mode page, sub-pages f2h (ATA feature mode
3697 * page) into a SET FEATURES command.
3699 static unsigned int ata_mselect_control_ata_feature(struct ata_queued_cmd *qc,
3700 const u8 *buf, int len,
3703 struct ata_device *dev = qc->dev;
3704 struct ata_taskfile *tf = &qc->tf;
3708 * The first four bytes of ATA Feature Control mode page are a header,
3709 * so offsets in mpage are off by 4 compared to buf. Same for len.
3711 if (len != ATA_FEATURE_SUB_MPAGE_LEN - 4) {
3712 *fp = min(len, ATA_FEATURE_SUB_MPAGE_LEN - 4);
3716 /* Check cdl_ctrl */
3717 switch (buf[0] & 0x03) {
3721 dev->flags &= ~ATA_DFLAG_CDL_ENABLED;
3724 /* Enable CDL T2A/T2B: NCQ priority must be disabled */
3725 if (dev->flags & ATA_DFLAG_NCQ_PRIO_ENABLED) {
3727 "NCQ priority must be disabled to enable CDL\n");
3731 dev->flags |= ATA_DFLAG_CDL_ENABLED;
3738 tf->flags |= ATA_TFLAG_DEVICE | ATA_TFLAG_ISADDR;
3739 tf->protocol = ATA_PROT_NODATA;
3740 tf->command = ATA_CMD_SET_FEATURES;
3741 tf->feature = SETFEATURES_CDL;
3742 tf->nsect = cdl_action;
3748 * ata_mselect_control - Simulate MODE SELECT for control page
3749 * @qc: Storage for translated ATA taskfile
3750 * @spg: target sub-page of the control page
3751 * @buf: input buffer
3752 * @len: number of valid bytes in the input buffer
3753 * @fp: out parameter for the failed field on error
3755 * Prepare a taskfile to modify caching information for the device.
3760 static int ata_mselect_control(struct ata_queued_cmd *qc, u8 spg,
3761 const u8 *buf, int len, u16 *fp)
3765 return ata_mselect_control_spg0(qc, buf, len, fp);
3766 case ATA_FEATURE_SUB_MPAGE:
3767 return ata_mselect_control_ata_feature(qc, buf, len, fp);
3774 * ata_scsi_mode_select_xlat - Simulate MODE SELECT 6, 10 commands
3775 * @qc: Storage for translated ATA taskfile
3777 * Converts a MODE SELECT command to an ATA SET FEATURES taskfile.
3778 * Assume this is invoked for direct access devices (e.g. disks) only.
3779 * There should be no block descriptor for other device types.
3782 * spin_lock_irqsave(host lock)
3784 static unsigned int ata_scsi_mode_select_xlat(struct ata_queued_cmd *qc)
3786 struct scsi_cmnd *scmd = qc->scsicmd;
3787 const u8 *cdb = scmd->cmnd;
3789 unsigned six_byte, pg_len, hdr_len, bd_len;
3794 const u8 *p = buffer;
3796 six_byte = (cdb[0] == MODE_SELECT);
3798 if (scmd->cmd_len < 5) {
3806 if (scmd->cmd_len < 9) {
3811 len = get_unaligned_be16(&cdb[7]);
3815 /* We only support PF=1, SP=0. */
3816 if ((cdb[1] & 0x11) != 0x10) {
3818 bp = (cdb[1] & 0x01) ? 1 : 5;
3822 /* Test early for possible overrun. */
3823 if (!scsi_sg_count(scmd) || scsi_sglist(scmd)->length < len)
3824 goto invalid_param_len;
3826 /* Move past header and block descriptors. */
3828 goto invalid_param_len;
3830 if (!sg_copy_to_buffer(scsi_sglist(scmd), scsi_sg_count(scmd),
3831 buffer, sizeof(buffer)))
3832 goto invalid_param_len;
3837 bd_len = get_unaligned_be16(&p[6]);
3842 goto invalid_param_len;
3843 if (bd_len != 0 && bd_len != 8) {
3844 fp = (six_byte) ? 3 : 6;
3845 fp += bd_len + hdr_len;
3854 /* Parse both possible formats for the mode page headers. */
3858 goto invalid_param_len;
3861 pg_len = get_unaligned_be16(&p[2]);
3866 goto invalid_param_len;
3875 * Supported subpages: all subpages and ATA feature sub-page f2h of
3880 case ALL_SUB_MPAGES:
3881 /* All subpages is not supported for the control page */
3882 if (pg == CONTROL_MPAGE) {
3883 fp = (p[0] & 0x40) ? 1 : 0;
3884 fp += hdr_len + bd_len;
3888 case ATA_FEATURE_SUB_MPAGE:
3889 if (qc->dev->flags & ATA_DFLAG_CDL &&
3890 pg == CONTROL_MPAGE)
3894 fp = (p[0] & 0x40) ? 1 : 0;
3895 fp += hdr_len + bd_len;
3900 goto invalid_param_len;
3904 if (ata_mselect_caching(qc, p, pg_len, &fp) < 0) {
3905 fp += hdr_len + bd_len;
3910 ret = ata_mselect_control(qc, spg, p, pg_len, &fp);
3912 fp += hdr_len + bd_len;
3916 goto skip; /* No ATA command to send */
3919 /* Invalid page code */
3920 fp = bd_len + hdr_len;
3925 * Only one page has changeable data, so we only support setting one
3934 ata_scsi_set_invalid_field(qc->dev, scmd, fp, bp);
3938 ata_scsi_set_invalid_parameter(qc->dev, scmd, fp);
3942 /* "Parameter list length error" */
3943 ata_scsi_set_sense(qc->dev, scmd, ILLEGAL_REQUEST, 0x1a, 0x0);
3947 scmd->result = SAM_STAT_GOOD;
3951 static u8 ata_scsi_trusted_op(u32 len, bool send, bool dma)
3954 return ATA_CMD_TRUSTED_NONDATA;
3956 return dma ? ATA_CMD_TRUSTED_SND_DMA : ATA_CMD_TRUSTED_SND;
3958 return dma ? ATA_CMD_TRUSTED_RCV_DMA : ATA_CMD_TRUSTED_RCV;
3961 static unsigned int ata_scsi_security_inout_xlat(struct ata_queued_cmd *qc)
3963 struct scsi_cmnd *scmd = qc->scsicmd;
3964 const u8 *cdb = scmd->cmnd;
3965 struct ata_taskfile *tf = &qc->tf;
3967 bool send = (cdb[0] == SECURITY_PROTOCOL_OUT);
3968 u16 spsp = get_unaligned_be16(&cdb[2]);
3969 u32 len = get_unaligned_be32(&cdb[6]);
3970 bool dma = !(qc->dev->flags & ATA_DFLAG_PIO);
3973 * We don't support the ATA "security" protocol.
3976 ata_scsi_set_invalid_field(qc->dev, scmd, 1, 0);
3980 if (cdb[4] & 7) { /* INC_512 */
3982 ata_scsi_set_invalid_field(qc->dev, scmd, 6, 0);
3986 if (len > 0x01fffe00) {
3987 ata_scsi_set_invalid_field(qc->dev, scmd, 6, 0);
3991 /* convert to the sector-based ATA addressing */
3992 len = (len + 511) / 512;
3995 tf->protocol = dma ? ATA_PROT_DMA : ATA_PROT_PIO;
3996 tf->flags |= ATA_TFLAG_DEVICE | ATA_TFLAG_ISADDR | ATA_TFLAG_LBA;
3998 tf->flags |= ATA_TFLAG_WRITE;
3999 tf->command = ata_scsi_trusted_op(len, send, dma);
4001 tf->lbam = spsp & 0xff;
4002 tf->lbah = spsp >> 8;
4005 tf->nsect = len & 0xff;
4006 tf->lbal = len >> 8;
4009 tf->lbah = (1 << 7);
4012 ata_qc_set_pc_nbytes(qc);
4017 * ata_scsi_var_len_cdb_xlat - SATL variable length CDB to Handler
4018 * @qc: Command to be translated
4020 * Translate a SCSI variable length CDB to specified commands.
4021 * It checks a service action value in CDB to call corresponding handler.
4024 * Zero on success, non-zero on failure
4027 static unsigned int ata_scsi_var_len_cdb_xlat(struct ata_queued_cmd *qc)
4029 struct scsi_cmnd *scmd = qc->scsicmd;
4030 const u8 *cdb = scmd->cmnd;
4031 const u16 sa = get_unaligned_be16(&cdb[8]);
4034 * if service action represents a ata pass-thru(32) command,
4035 * then pass it to ata_scsi_pass_thru handler.
4038 return ata_scsi_pass_thru(qc);
4040 /* unsupported service action */
4045 * ata_get_xlat_func - check if SCSI to ATA translation is possible
4047 * @cmd: SCSI command opcode to consider
4049 * Look up the SCSI command given, and determine whether the
4050 * SCSI command is to be translated or simulated.
4053 * Pointer to translation function if possible, %NULL if not.
4056 static inline ata_xlat_func_t ata_get_xlat_func(struct ata_device *dev, u8 cmd)
4066 return ata_scsi_rw_xlat;
4069 return ata_scsi_write_same_xlat;
4071 case SYNCHRONIZE_CACHE:
4072 case SYNCHRONIZE_CACHE_16:
4073 if (ata_try_flush_cache(dev))
4074 return ata_scsi_flush_xlat;
4079 return ata_scsi_verify_xlat;
4083 return ata_scsi_pass_thru;
4085 case VARIABLE_LENGTH_CMD:
4086 return ata_scsi_var_len_cdb_xlat;
4089 case MODE_SELECT_10:
4090 return ata_scsi_mode_select_xlat;
4093 return ata_scsi_zbc_in_xlat;
4096 return ata_scsi_zbc_out_xlat;
4098 case SECURITY_PROTOCOL_IN:
4099 case SECURITY_PROTOCOL_OUT:
4100 if (!(dev->flags & ATA_DFLAG_TRUSTED))
4102 return ata_scsi_security_inout_xlat;
4105 return ata_scsi_start_stop_xlat;
4111 int __ata_scsi_queuecmd(struct scsi_cmnd *scmd, struct ata_device *dev)
4113 struct ata_port *ap = dev->link->ap;
4114 u8 scsi_op = scmd->cmnd[0];
4115 ata_xlat_func_t xlat_func;
4118 * scsi_queue_rq() will defer commands if scsi_host_in_recovery().
4119 * However, this check is done without holding the ap->lock (a libata
4120 * specific lock), so we can have received an error irq since then,
4121 * therefore we must check if EH is pending, while holding ap->lock.
4123 if (ap->pflags & (ATA_PFLAG_EH_PENDING | ATA_PFLAG_EH_IN_PROGRESS))
4124 return SCSI_MLQUEUE_DEVICE_BUSY;
4126 if (unlikely(!scmd->cmd_len))
4129 if (dev->class == ATA_DEV_ATA || dev->class == ATA_DEV_ZAC) {
4130 if (unlikely(scmd->cmd_len > dev->cdb_len))
4133 xlat_func = ata_get_xlat_func(dev, scsi_op);
4134 } else if (likely((scsi_op != ATA_16) || !atapi_passthru16)) {
4135 /* relay SCSI command to ATAPI device */
4136 int len = COMMAND_SIZE(scsi_op);
4138 if (unlikely(len > scmd->cmd_len ||
4139 len > dev->cdb_len ||
4140 scmd->cmd_len > ATAPI_CDB_LEN))
4143 xlat_func = atapi_xlat;
4145 /* ATA_16 passthru, treat as an ATA command */
4146 if (unlikely(scmd->cmd_len > 16))
4149 xlat_func = ata_get_xlat_func(dev, scsi_op);
4153 return ata_scsi_translate(dev, scmd, xlat_func);
4155 ata_scsi_simulate(dev, scmd);
4160 scmd->result = DID_ERROR << 16;
4166 * ata_scsi_queuecmd - Issue SCSI cdb to libata-managed device
4167 * @shost: SCSI host of command to be sent
4168 * @cmd: SCSI command to be sent
4170 * In some cases, this function translates SCSI commands into
4171 * ATA taskfiles, and queues the taskfiles to be sent to
4172 * hardware. In other cases, this function simulates a
4173 * SCSI device by evaluating and responding to certain
4174 * SCSI commands. This creates the overall effect of
4175 * ATA and ATAPI devices appearing as SCSI devices.
4181 * Return value from __ata_scsi_queuecmd() if @cmd can be queued,
4184 int ata_scsi_queuecmd(struct Scsi_Host *shost, struct scsi_cmnd *cmd)
4186 struct ata_port *ap;
4187 struct ata_device *dev;
4188 struct scsi_device *scsidev = cmd->device;
4190 unsigned long irq_flags;
4192 ap = ata_shost_to_port(shost);
4194 spin_lock_irqsave(ap->lock, irq_flags);
4196 dev = ata_scsi_find_dev(ap, scsidev);
4198 rc = __ata_scsi_queuecmd(cmd, dev);
4200 cmd->result = (DID_BAD_TARGET << 16);
4204 spin_unlock_irqrestore(ap->lock, irq_flags);
4208 EXPORT_SYMBOL_GPL(ata_scsi_queuecmd);
4211 * ata_scsi_simulate - simulate SCSI command on ATA device
4212 * @dev: the target device
4213 * @cmd: SCSI command being sent to device.
4215 * Interprets and directly executes a select list of SCSI commands
4216 * that can be handled internally.
4219 * spin_lock_irqsave(host lock)
4222 void ata_scsi_simulate(struct ata_device *dev, struct scsi_cmnd *cmd)
4224 struct ata_scsi_args args;
4225 const u8 *scsicmd = cmd->cmnd;
4232 switch(scsicmd[0]) {
4234 if (scsicmd[1] & 2) /* is CmdDt set? */
4235 ata_scsi_set_invalid_field(dev, cmd, 1, 0xff);
4236 else if ((scsicmd[1] & 1) == 0) /* is EVPD clear? */
4237 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_std);
4238 else switch (scsicmd[2]) {
4240 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_00);
4243 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_80);
4246 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_83);
4249 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_89);
4252 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_b0);
4255 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_b1);
4258 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_b2);
4261 if (dev->flags & ATA_DFLAG_ZAC)
4262 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_b6);
4264 ata_scsi_set_invalid_field(dev, cmd, 2, 0xff);
4268 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_b9);
4270 ata_scsi_set_invalid_field(dev, cmd, 2, 0xff);
4273 ata_scsi_set_invalid_field(dev, cmd, 2, 0xff);
4280 ata_scsi_rbuf_fill(&args, ata_scsiop_mode_sense);
4284 ata_scsi_rbuf_fill(&args, ata_scsiop_read_cap);
4287 case SERVICE_ACTION_IN_16:
4288 if ((scsicmd[1] & 0x1f) == SAI_READ_CAPACITY_16)
4289 ata_scsi_rbuf_fill(&args, ata_scsiop_read_cap);
4291 ata_scsi_set_invalid_field(dev, cmd, 1, 0xff);
4295 ata_scsi_rbuf_fill(&args, ata_scsiop_report_luns);
4299 ata_scsi_set_sense(dev, cmd, 0, 0, 0);
4302 /* if we reach this, then writeback caching is disabled,
4303 * turning this into a no-op.
4305 case SYNCHRONIZE_CACHE:
4306 case SYNCHRONIZE_CACHE_16:
4309 /* no-op's, complete with success */
4313 case TEST_UNIT_READY:
4316 case SEND_DIAGNOSTIC:
4317 tmp8 = scsicmd[1] & ~(1 << 3);
4318 if (tmp8 != 0x4 || scsicmd[3] || scsicmd[4])
4319 ata_scsi_set_invalid_field(dev, cmd, 1, 0xff);
4322 case MAINTENANCE_IN:
4323 if ((scsicmd[1] & 0x1f) == MI_REPORT_SUPPORTED_OPERATION_CODES)
4324 ata_scsi_rbuf_fill(&args, ata_scsiop_maint_in);
4326 ata_scsi_set_invalid_field(dev, cmd, 1, 0xff);
4329 /* all other commands */
4331 ata_scsi_set_sense(dev, cmd, ILLEGAL_REQUEST, 0x20, 0x0);
4332 /* "Invalid command operation code" */
4339 int ata_scsi_add_hosts(struct ata_host *host, const struct scsi_host_template *sht)
4343 for (i = 0; i < host->n_ports; i++) {
4344 struct ata_port *ap = host->ports[i];
4345 struct Scsi_Host *shost;
4348 shost = scsi_host_alloc(sht, sizeof(struct ata_port *));
4352 shost->eh_noresume = 1;
4353 *(struct ata_port **)&shost->hostdata[0] = ap;
4354 ap->scsi_host = shost;
4356 shost->transportt = ata_scsi_transport_template;
4357 shost->unique_id = ap->print_id;
4360 shost->max_channel = 1;
4361 shost->max_cmd_len = 32;
4363 /* Schedule policy is determined by ->qc_defer()
4364 * callback and it needs to see every deferred qc.
4365 * Set host_blocked to 1 to prevent SCSI midlayer from
4366 * automatically deferring requests.
4368 shost->max_host_blocked = 1;
4370 rc = scsi_add_host_with_dma(shost, &ap->tdev, ap->host->dev);
4379 struct Scsi_Host *shost = host->ports[i]->scsi_host;
4381 /* scsi_host_put() is in ata_devres_release() */
4382 scsi_remove_host(shost);
4388 static void ata_scsi_assign_ofnode(struct ata_device *dev, struct ata_port *ap)
4390 struct scsi_device *sdev = dev->sdev;
4391 struct device *d = ap->host->dev;
4392 struct device_node *np = d->of_node;
4393 struct device_node *child;
4395 for_each_available_child_of_node(np, child) {
4399 ret = of_property_read_u32(child, "reg", &val);
4402 if (val == dev->devno) {
4403 dev_dbg(d, "found matching device node\n");
4404 sdev->sdev_gendev.of_node = child;
4410 static void ata_scsi_assign_ofnode(struct ata_device *dev, struct ata_port *ap)
4415 void ata_scsi_scan_host(struct ata_port *ap, int sync)
4418 struct ata_device *last_failed_dev = NULL;
4419 struct ata_link *link;
4420 struct ata_device *dev;
4423 ata_for_each_link(link, ap, EDGE) {
4424 ata_for_each_dev(dev, link, ENABLED) {
4425 struct scsi_device *sdev;
4426 int channel = 0, id = 0;
4431 if (ata_is_host_link(link))
4434 channel = link->pmp;
4436 sdev = __scsi_add_device(ap->scsi_host, channel, id, 0,
4438 if (!IS_ERR(sdev)) {
4440 ata_scsi_assign_ofnode(dev, ap);
4441 scsi_device_put(sdev);
4448 /* If we scanned while EH was in progress or allocation
4449 * failure occurred, scan would have failed silently. Check
4450 * whether all devices are attached.
4452 ata_for_each_link(link, ap, EDGE) {
4453 ata_for_each_dev(dev, link, ENABLED) {
4462 /* we're missing some SCSI devices */
4464 /* If caller requested synchrnous scan && we've made
4465 * any progress, sleep briefly and repeat.
4467 if (dev != last_failed_dev) {
4469 last_failed_dev = dev;
4473 /* We might be failing to detect boot device, give it
4474 * a few more chances.
4482 "WARNING: synchronous SCSI scan failed without making any progress, switching to async\n");
4485 queue_delayed_work(system_long_wq, &ap->hotplug_task,
4486 round_jiffies_relative(HZ));
4490 * ata_scsi_offline_dev - offline attached SCSI device
4491 * @dev: ATA device to offline attached SCSI device for
4493 * This function is called from ata_eh_hotplug() and responsible
4494 * for taking the SCSI device attached to @dev offline. This
4495 * function is called with host lock which protects dev->sdev
4499 * spin_lock_irqsave(host lock)
4502 * 1 if attached SCSI device exists, 0 otherwise.
4504 int ata_scsi_offline_dev(struct ata_device *dev)
4507 scsi_device_set_state(dev->sdev, SDEV_OFFLINE);
4514 * ata_scsi_remove_dev - remove attached SCSI device
4515 * @dev: ATA device to remove attached SCSI device for
4517 * This function is called from ata_eh_scsi_hotplug() and
4518 * responsible for removing the SCSI device attached to @dev.
4521 * Kernel thread context (may sleep).
4523 static void ata_scsi_remove_dev(struct ata_device *dev)
4525 struct ata_port *ap = dev->link->ap;
4526 struct scsi_device *sdev;
4527 unsigned long flags;
4529 /* Alas, we need to grab scan_mutex to ensure SCSI device
4530 * state doesn't change underneath us and thus
4531 * scsi_device_get() always succeeds. The mutex locking can
4532 * be removed if there is __scsi_device_get() interface which
4533 * increments reference counts regardless of device state.
4535 mutex_lock(&ap->scsi_host->scan_mutex);
4536 spin_lock_irqsave(ap->lock, flags);
4538 /* clearing dev->sdev is protected by host lock */
4543 /* If user initiated unplug races with us, sdev can go
4544 * away underneath us after the host lock and
4545 * scan_mutex are released. Hold onto it.
4547 if (scsi_device_get(sdev) == 0) {
4548 /* The following ensures the attached sdev is
4549 * offline on return from ata_scsi_offline_dev()
4550 * regardless it wins or loses the race
4551 * against this function.
4553 scsi_device_set_state(sdev, SDEV_OFFLINE);
4560 spin_unlock_irqrestore(ap->lock, flags);
4561 mutex_unlock(&ap->scsi_host->scan_mutex);
4564 ata_dev_info(dev, "detaching (SCSI %s)\n",
4565 dev_name(&sdev->sdev_gendev));
4567 scsi_remove_device(sdev);
4568 scsi_device_put(sdev);
4572 static void ata_scsi_handle_link_detach(struct ata_link *link)
4574 struct ata_port *ap = link->ap;
4575 struct ata_device *dev;
4577 ata_for_each_dev(dev, link, ALL) {
4578 unsigned long flags;
4580 if (!(dev->flags & ATA_DFLAG_DETACHED))
4583 spin_lock_irqsave(ap->lock, flags);
4584 dev->flags &= ~ATA_DFLAG_DETACHED;
4585 spin_unlock_irqrestore(ap->lock, flags);
4587 if (zpodd_dev_enabled(dev))
4590 ata_scsi_remove_dev(dev);
4595 * ata_scsi_media_change_notify - send media change event
4596 * @dev: Pointer to the disk device with media change event
4598 * Tell the block layer to send a media change notification
4602 * spin_lock_irqsave(host lock)
4604 void ata_scsi_media_change_notify(struct ata_device *dev)
4607 sdev_evt_send_simple(dev->sdev, SDEV_EVT_MEDIA_CHANGE,
4612 * ata_scsi_hotplug - SCSI part of hotplug
4613 * @work: Pointer to ATA port to perform SCSI hotplug on
4615 * Perform SCSI part of hotplug. It's executed from a separate
4616 * workqueue after EH completes. This is necessary because SCSI
4617 * hot plugging requires working EH and hot unplugging is
4618 * synchronized with hot plugging with a mutex.
4621 * Kernel thread context (may sleep).
4623 void ata_scsi_hotplug(struct work_struct *work)
4625 struct ata_port *ap =
4626 container_of(work, struct ata_port, hotplug_task.work);
4629 if (ap->pflags & ATA_PFLAG_UNLOADING)
4632 mutex_lock(&ap->scsi_scan_mutex);
4634 /* Unplug detached devices. We cannot use link iterator here
4635 * because PMP links have to be scanned even if PMP is
4636 * currently not attached. Iterate manually.
4638 ata_scsi_handle_link_detach(&ap->link);
4640 for (i = 0; i < SATA_PMP_MAX_PORTS; i++)
4641 ata_scsi_handle_link_detach(&ap->pmp_link[i]);
4643 /* scan for new ones */
4644 ata_scsi_scan_host(ap, 0);
4646 mutex_unlock(&ap->scsi_scan_mutex);
4650 * ata_scsi_user_scan - indication for user-initiated bus scan
4651 * @shost: SCSI host to scan
4652 * @channel: Channel to scan
4656 * This function is called when user explicitly requests bus
4657 * scan. Set probe pending flag and invoke EH.
4660 * SCSI layer (we don't care)
4665 int ata_scsi_user_scan(struct Scsi_Host *shost, unsigned int channel,
4666 unsigned int id, u64 lun)
4668 struct ata_port *ap = ata_shost_to_port(shost);
4669 unsigned long flags;
4672 if (lun != SCAN_WILD_CARD && lun)
4675 if (!sata_pmp_attached(ap)) {
4676 if (channel != SCAN_WILD_CARD && channel)
4680 if (id != SCAN_WILD_CARD && id)
4685 spin_lock_irqsave(ap->lock, flags);
4687 if (devno == SCAN_WILD_CARD) {
4688 struct ata_link *link;
4690 ata_for_each_link(link, ap, EDGE) {
4691 struct ata_eh_info *ehi = &link->eh_info;
4692 ehi->probe_mask |= ATA_ALL_DEVICES;
4693 ehi->action |= ATA_EH_RESET;
4696 struct ata_device *dev = ata_find_dev(ap, devno);
4699 struct ata_eh_info *ehi = &dev->link->eh_info;
4700 ehi->probe_mask |= 1 << dev->devno;
4701 ehi->action |= ATA_EH_RESET;
4707 ata_port_schedule_eh(ap);
4708 spin_unlock_irqrestore(ap->lock, flags);
4709 ata_port_wait_eh(ap);
4711 spin_unlock_irqrestore(ap->lock, flags);
4717 * ata_scsi_dev_rescan - initiate scsi_rescan_device()
4718 * @work: Pointer to ATA port to perform scsi_rescan_device()
4720 * After ATA pass thru (SAT) commands are executed successfully,
4721 * libata need to propagate the changes to SCSI layer.
4724 * Kernel thread context (may sleep).
4726 void ata_scsi_dev_rescan(struct work_struct *work)
4728 struct ata_port *ap =
4729 container_of(work, struct ata_port, scsi_rescan_task.work);
4730 struct ata_link *link;
4731 struct ata_device *dev;
4732 unsigned long flags;
4735 mutex_lock(&ap->scsi_scan_mutex);
4736 spin_lock_irqsave(ap->lock, flags);
4738 ata_for_each_link(link, ap, EDGE) {
4739 ata_for_each_dev(dev, link, ENABLED) {
4740 struct scsi_device *sdev = dev->sdev;
4743 * If the port was suspended before this was scheduled,
4746 if (ap->pflags & ATA_PFLAG_SUSPENDED)
4751 if (scsi_device_get(sdev))
4754 spin_unlock_irqrestore(ap->lock, flags);
4755 ret = scsi_rescan_device(sdev);
4756 scsi_device_put(sdev);
4757 spin_lock_irqsave(ap->lock, flags);
4765 spin_unlock_irqrestore(ap->lock, flags);
4766 mutex_unlock(&ap->scsi_scan_mutex);
4768 /* Reschedule with a delay if scsi_rescan_device() returned an error */
4770 schedule_delayed_work(&ap->scsi_rescan_task,
4771 msecs_to_jiffies(5));