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 = kstrtol(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_dump_status - user friendly display of error info
714 * @ap: the port in question
715 * @tf: ptr to filled out taskfile
717 * Decode and dump the ATA error/status registers for the user so
718 * that they have some idea what really happened at the non
719 * make-believe layer.
722 * inherited from caller
724 static void ata_dump_status(struct ata_port *ap, struct ata_taskfile *tf)
726 u8 stat = tf->status, err = tf->error;
728 if (stat & ATA_BUSY) {
729 ata_port_warn(ap, "status=0x%02x {Busy} ", stat);
731 ata_port_warn(ap, "status=0x%02x { %s%s%s%s%s%s%s} ", stat,
732 stat & ATA_DRDY ? "DriveReady " : "",
733 stat & ATA_DF ? "DeviceFault " : "",
734 stat & ATA_DSC ? "SeekComplete " : "",
735 stat & ATA_DRQ ? "DataRequest " : "",
736 stat & ATA_CORR ? "CorrectedError " : "",
737 stat & ATA_SENSE ? "Sense " : "",
738 stat & ATA_ERR ? "Error " : "");
740 ata_port_warn(ap, "error=0x%02x {%s%s%s%s%s%s", err,
742 "DriveStatusError " : "",
745 "BadCRC " : "Sector ") : "",
746 err & ATA_UNC ? "UncorrectableError " : "",
747 err & ATA_IDNF ? "SectorIdNotFound " : "",
748 err & ATA_TRK0NF ? "TrackZeroNotFound " : "",
749 err & ATA_AMNF ? "AddrMarkNotFound " : "");
754 * ata_to_sense_error - convert ATA error to SCSI error
755 * @id: ATA device number
756 * @drv_stat: value contained in ATA status register
757 * @drv_err: value contained in ATA error register
758 * @sk: the sense key we'll fill out
759 * @asc: the additional sense code we'll fill out
760 * @ascq: the additional sense code qualifier we'll fill out
761 * @verbose: be verbose
763 * Converts an ATA error into a SCSI error. Fill out pointers to
764 * SK, ASC, and ASCQ bytes for later use in fixed or descriptor
765 * format sense blocks.
768 * spin_lock_irqsave(host lock)
770 static void ata_to_sense_error(unsigned id, u8 drv_stat, u8 drv_err, u8 *sk,
771 u8 *asc, u8 *ascq, int verbose)
775 /* Based on the 3ware driver translation table */
776 static const unsigned char sense_table[][4] = {
778 {0xd1, ABORTED_COMMAND, 0x00, 0x00},
779 // Device busy Aborted command
781 {0xd0, ABORTED_COMMAND, 0x00, 0x00},
782 // Device busy Aborted command
784 {0x61, HARDWARE_ERROR, 0x00, 0x00},
785 // Device fault Hardware error
786 /* ICRC|ABRT */ /* NB: ICRC & !ABRT is BBD */
787 {0x84, ABORTED_COMMAND, 0x47, 0x00},
788 // Data CRC error SCSI parity error
789 /* MC|ID|ABRT|TRK0|MARK */
790 {0x37, NOT_READY, 0x04, 0x00},
791 // Unit offline Not ready
793 {0x09, NOT_READY, 0x04, 0x00},
794 // Unrecovered disk error Not ready
795 /* Bad address mark */
796 {0x01, MEDIUM_ERROR, 0x13, 0x00},
797 // Address mark not found for data field
798 /* TRK0 - Track 0 not found */
799 {0x02, HARDWARE_ERROR, 0x00, 0x00},
801 /* Abort: 0x04 is not translated here, see below */
802 /* Media change request */
803 {0x08, NOT_READY, 0x04, 0x00},
804 // FIXME: faking offline
805 /* SRV/IDNF - ID not found */
806 {0x10, ILLEGAL_REQUEST, 0x21, 0x00},
807 // Logical address out of range
808 /* MC - Media Changed */
809 {0x20, UNIT_ATTENTION, 0x28, 0x00},
810 // Not ready to ready change, medium may have changed
811 /* ECC - Uncorrectable ECC error */
812 {0x40, MEDIUM_ERROR, 0x11, 0x04},
813 // Unrecovered read error
814 /* BBD - block marked bad */
815 {0x80, MEDIUM_ERROR, 0x11, 0x04},
816 // Block marked bad Medium error, unrecovered read error
817 {0xFF, 0xFF, 0xFF, 0xFF}, // END mark
819 static const unsigned char stat_table[][4] = {
820 /* Must be first because BUSY means no other bits valid */
821 {0x80, ABORTED_COMMAND, 0x47, 0x00},
822 // Busy, fake parity for now
823 {0x40, ILLEGAL_REQUEST, 0x21, 0x04},
824 // Device ready, unaligned write command
825 {0x20, HARDWARE_ERROR, 0x44, 0x00},
826 // Device fault, internal target failure
827 {0x08, ABORTED_COMMAND, 0x47, 0x00},
828 // Timed out in xfer, fake parity for now
829 {0x04, RECOVERED_ERROR, 0x11, 0x00},
830 // Recovered ECC error Medium error, recovered
831 {0xFF, 0xFF, 0xFF, 0xFF}, // END mark
835 * Is this an error we can process/parse
837 if (drv_stat & ATA_BUSY) {
838 drv_err = 0; /* Ignore the err bits, they're invalid */
842 /* Look for drv_err */
843 for (i = 0; sense_table[i][0] != 0xFF; i++) {
844 /* Look for best matches first */
845 if ((sense_table[i][0] & drv_err) ==
847 *sk = sense_table[i][1];
848 *asc = sense_table[i][2];
849 *ascq = sense_table[i][3];
856 * Fall back to interpreting status bits. Note that if the drv_err
857 * has only the ABRT bit set, we decode drv_stat. ABRT by itself
858 * is not descriptive enough.
860 for (i = 0; stat_table[i][0] != 0xFF; i++) {
861 if (stat_table[i][0] & drv_stat) {
862 *sk = stat_table[i][1];
863 *asc = stat_table[i][2];
864 *ascq = stat_table[i][3];
870 * We need a sensible error return here, which is tricky, and one
871 * that won't cause people to do things like return a disk wrongly.
873 *sk = ABORTED_COMMAND;
879 pr_err("ata%u: translated ATA stat/err 0x%02x/%02x to SCSI SK/ASC/ASCQ 0x%x/%02x/%02x\n",
880 id, drv_stat, drv_err, *sk, *asc, *ascq);
885 * ata_gen_passthru_sense - Generate check condition sense block.
886 * @qc: Command that completed.
888 * This function is specific to the ATA descriptor format sense
889 * block specified for the ATA pass through commands. Regardless
890 * of whether the command errored or not, return a sense
891 * block. Copy all controller registers into the sense
892 * block. If there was no error, we get the request from an ATA
893 * passthrough command, so we use the following sense data:
894 * sk = RECOVERED ERROR
895 * asc,ascq = ATA PASS-THROUGH INFORMATION AVAILABLE
901 static void ata_gen_passthru_sense(struct ata_queued_cmd *qc)
903 struct scsi_cmnd *cmd = qc->scsicmd;
904 struct ata_taskfile *tf = &qc->result_tf;
905 unsigned char *sb = cmd->sense_buffer;
906 unsigned char *desc = sb + 8;
907 int verbose = qc->ap->ops->error_handler == NULL;
908 u8 sense_key, asc, ascq;
910 memset(sb, 0, SCSI_SENSE_BUFFERSIZE);
913 * Use ata_to_sense_error() to map status register bits
914 * onto sense key, asc & ascq.
917 tf->status & (ATA_BUSY | ATA_DF | ATA_ERR | ATA_DRQ)) {
918 ata_to_sense_error(qc->ap->print_id, tf->status, tf->error,
919 &sense_key, &asc, &ascq, verbose);
920 ata_scsi_set_sense(qc->dev, cmd, sense_key, asc, ascq);
923 * ATA PASS-THROUGH INFORMATION AVAILABLE
924 * Always in descriptor format sense.
926 scsi_build_sense(cmd, 1, RECOVERED_ERROR, 0, 0x1D);
929 if ((cmd->sense_buffer[0] & 0x7f) >= 0x72) {
932 /* descriptor format */
934 desc = (char *)scsi_sense_desc_find(sb, len + 8, 9);
936 if (SCSI_SENSE_BUFFERSIZE < len + 14)
944 * Copy registers into sense buffer.
952 desc[12] = tf->device;
953 desc[13] = tf->status;
956 * Fill in Extend bit, and the high order bytes
959 if (tf->flags & ATA_TFLAG_LBA48) {
961 desc[4] = tf->hob_nsect;
962 desc[6] = tf->hob_lbal;
963 desc[8] = tf->hob_lbam;
964 desc[10] = tf->hob_lbah;
967 /* Fixed sense format */
969 desc[1] = tf->status;
970 desc[2] = tf->device;
973 if (tf->flags & ATA_TFLAG_LBA48) {
977 if (tf->hob_lbal || tf->hob_lbam || tf->hob_lbah)
987 * ata_gen_ata_sense - generate a SCSI fixed sense block
988 * @qc: Command that we are erroring out
990 * Generate sense block for a failed ATA command @qc. Descriptor
991 * format is used to accommodate LBA48 block address.
996 static void ata_gen_ata_sense(struct ata_queued_cmd *qc)
998 struct ata_device *dev = qc->dev;
999 struct scsi_cmnd *cmd = qc->scsicmd;
1000 struct ata_taskfile *tf = &qc->result_tf;
1001 unsigned char *sb = cmd->sense_buffer;
1002 int verbose = qc->ap->ops->error_handler == NULL;
1004 u8 sense_key, asc, ascq;
1006 memset(sb, 0, SCSI_SENSE_BUFFERSIZE);
1008 if (ata_dev_disabled(dev)) {
1009 /* Device disabled after error recovery */
1010 /* LOGICAL UNIT NOT READY, HARD RESET REQUIRED */
1011 ata_scsi_set_sense(dev, cmd, NOT_READY, 0x04, 0x21);
1014 /* Use ata_to_sense_error() to map status register bits
1015 * onto sense key, asc & ascq.
1018 tf->status & (ATA_BUSY | ATA_DF | ATA_ERR | ATA_DRQ)) {
1019 ata_to_sense_error(qc->ap->print_id, tf->status, tf->error,
1020 &sense_key, &asc, &ascq, verbose);
1021 ata_scsi_set_sense(dev, cmd, sense_key, asc, ascq);
1023 /* Could not decode error */
1024 ata_dev_warn(dev, "could not decode error status 0x%x err_mask 0x%x\n",
1025 tf->status, qc->err_mask);
1026 ata_scsi_set_sense(dev, cmd, ABORTED_COMMAND, 0, 0);
1030 block = ata_tf_read_block(&qc->result_tf, dev);
1031 if (block == U64_MAX)
1034 scsi_set_sense_information(sb, SCSI_SENSE_BUFFERSIZE, block);
1037 void ata_scsi_sdev_config(struct scsi_device *sdev)
1039 sdev->use_10_for_rw = 1;
1040 sdev->use_10_for_ms = 1;
1041 sdev->no_write_same = 1;
1043 /* Schedule policy is determined by ->qc_defer() callback and
1044 * it needs to see every deferred qc. Set dev_blocked to 1 to
1045 * prevent SCSI midlayer from automatically deferring
1048 sdev->max_device_blocked = 1;
1052 * ata_scsi_dma_need_drain - Check whether data transfer may overflow
1053 * @rq: request to be checked
1055 * ATAPI commands which transfer variable length data to host
1056 * might overflow due to application error or hardware bug. This
1057 * function checks whether overflow should be drained and ignored
1064 * 1 if ; otherwise, 0.
1066 bool ata_scsi_dma_need_drain(struct request *rq)
1068 struct scsi_cmnd *scmd = blk_mq_rq_to_pdu(rq);
1070 return atapi_cmd_type(scmd->cmnd[0]) == ATAPI_MISC;
1072 EXPORT_SYMBOL_GPL(ata_scsi_dma_need_drain);
1074 int ata_scsi_dev_config(struct scsi_device *sdev, struct ata_device *dev)
1076 struct request_queue *q = sdev->request_queue;
1079 if (!ata_id_has_unload(dev->id))
1080 dev->flags |= ATA_DFLAG_NO_UNLOAD;
1082 /* configure max sectors */
1083 dev->max_sectors = min(dev->max_sectors, sdev->host->max_sectors);
1084 blk_queue_max_hw_sectors(q, dev->max_sectors);
1086 if (dev->class == ATA_DEV_ATAPI) {
1087 sdev->sector_size = ATA_SECT_SIZE;
1089 /* set DMA padding */
1090 blk_queue_update_dma_pad(q, ATA_DMA_PAD_SZ - 1);
1092 /* make room for appending the drain */
1093 blk_queue_max_segments(q, queue_max_segments(q) - 1);
1095 sdev->dma_drain_len = ATAPI_MAX_DRAIN;
1096 sdev->dma_drain_buf = kmalloc(sdev->dma_drain_len, GFP_NOIO);
1097 if (!sdev->dma_drain_buf) {
1098 ata_dev_err(dev, "drain buffer allocation failed\n");
1102 sdev->sector_size = ata_id_logical_sector_size(dev->id);
1103 sdev->manage_start_stop = 1;
1107 * ata_pio_sectors() expects buffer for each sector to not cross
1108 * page boundary. Enforce it by requiring buffers to be sector
1109 * aligned, which works iff sector_size is not larger than
1110 * PAGE_SIZE. ATAPI devices also need the alignment as
1111 * IDENTIFY_PACKET is executed as ATA_PROT_PIO.
1113 if (sdev->sector_size > PAGE_SIZE)
1115 "sector_size=%u > PAGE_SIZE, PIO may malfunction\n",
1118 blk_queue_update_dma_alignment(q, sdev->sector_size - 1);
1120 if (dev->flags & ATA_DFLAG_AN)
1121 set_bit(SDEV_EVT_MEDIA_CHANGE, sdev->supported_events);
1123 if (ata_ncq_supported(dev))
1124 depth = min(sdev->host->can_queue, ata_id_queue_depth(dev->id));
1125 depth = min(ATA_MAX_QUEUE, depth);
1126 scsi_change_queue_depth(sdev, depth);
1128 if (dev->flags & ATA_DFLAG_TRUSTED)
1129 sdev->security_supported = 1;
1136 * ata_scsi_slave_config - Set SCSI device attributes
1137 * @sdev: SCSI device to examine
1139 * This is called before we actually start reading
1140 * and writing to the device, to configure certain
1141 * SCSI mid-layer behaviors.
1144 * Defined by SCSI layer. We don't really care.
1147 int ata_scsi_slave_config(struct scsi_device *sdev)
1149 struct ata_port *ap = ata_shost_to_port(sdev->host);
1150 struct ata_device *dev = __ata_scsi_find_dev(ap, sdev);
1153 ata_scsi_sdev_config(sdev);
1156 rc = ata_scsi_dev_config(sdev, dev);
1160 EXPORT_SYMBOL_GPL(ata_scsi_slave_config);
1163 * ata_scsi_slave_destroy - SCSI device is about to be destroyed
1164 * @sdev: SCSI device to be destroyed
1166 * @sdev is about to be destroyed for hot/warm unplugging. If
1167 * this unplugging was initiated by libata as indicated by NULL
1168 * dev->sdev, this function doesn't have to do anything.
1169 * Otherwise, SCSI layer initiated warm-unplug is in progress.
1170 * Clear dev->sdev, schedule the device for ATA detach and invoke
1174 * Defined by SCSI layer. We don't really care.
1176 void ata_scsi_slave_destroy(struct scsi_device *sdev)
1178 struct ata_port *ap = ata_shost_to_port(sdev->host);
1179 unsigned long flags;
1180 struct ata_device *dev;
1182 if (!ap->ops->error_handler)
1185 spin_lock_irqsave(ap->lock, flags);
1186 dev = __ata_scsi_find_dev(ap, sdev);
1187 if (dev && dev->sdev) {
1188 /* SCSI device already in CANCEL state, no need to offline it */
1190 dev->flags |= ATA_DFLAG_DETACH;
1191 ata_port_schedule_eh(ap);
1193 spin_unlock_irqrestore(ap->lock, flags);
1195 kfree(sdev->dma_drain_buf);
1197 EXPORT_SYMBOL_GPL(ata_scsi_slave_destroy);
1200 * ata_scsi_start_stop_xlat - Translate SCSI START STOP UNIT command
1201 * @qc: Storage for translated ATA taskfile
1203 * Sets up an ATA taskfile to issue STANDBY (to stop) or READ VERIFY
1204 * (to start). Perhaps these commands should be preceded by
1205 * CHECK POWER MODE to see what power mode the device is already in.
1206 * [See SAT revision 5 at www.t10.org]
1209 * spin_lock_irqsave(host lock)
1212 * Zero on success, non-zero on error.
1214 static unsigned int ata_scsi_start_stop_xlat(struct ata_queued_cmd *qc)
1216 struct scsi_cmnd *scmd = qc->scsicmd;
1217 struct ata_taskfile *tf = &qc->tf;
1218 const u8 *cdb = scmd->cmnd;
1222 if (scmd->cmd_len < 5) {
1227 tf->flags |= ATA_TFLAG_DEVICE | ATA_TFLAG_ISADDR;
1228 tf->protocol = ATA_PROT_NODATA;
1230 ; /* ignore IMMED bit, violates sat-r05 */
1235 goto invalid_fld; /* LOEJ bit set not supported */
1237 if (((cdb[4] >> 4) & 0xf) != 0) {
1240 goto invalid_fld; /* power conditions not supported */
1244 tf->nsect = 1; /* 1 sector, lba=0 */
1246 if (qc->dev->flags & ATA_DFLAG_LBA) {
1247 tf->flags |= ATA_TFLAG_LBA;
1252 tf->device |= ATA_LBA;
1255 tf->lbal = 0x1; /* sect */
1256 tf->lbam = 0x0; /* cyl low */
1257 tf->lbah = 0x0; /* cyl high */
1260 tf->command = ATA_CMD_VERIFY; /* READ VERIFY */
1262 /* Some odd clown BIOSen issue spindown on power off (ACPI S4
1263 * or S5) causing some drives to spin up and down again.
1265 if ((qc->ap->flags & ATA_FLAG_NO_POWEROFF_SPINDOWN) &&
1266 system_state == SYSTEM_POWER_OFF)
1269 if ((qc->ap->flags & ATA_FLAG_NO_HIBERNATE_SPINDOWN) &&
1270 system_entering_hibernation())
1273 /* Issue ATA STANDBY IMMEDIATE command */
1274 tf->command = ATA_CMD_STANDBYNOW1;
1278 * Standby and Idle condition timers could be implemented but that
1279 * would require libata to implement the Power condition mode page
1280 * and allow the user to change it. Changing mode pages requires
1281 * MODE SELECT to be implemented.
1287 ata_scsi_set_invalid_field(qc->dev, scmd, fp, bp);
1290 scmd->result = SAM_STAT_GOOD;
1296 * ata_scsi_flush_xlat - Translate SCSI SYNCHRONIZE CACHE command
1297 * @qc: Storage for translated ATA taskfile
1299 * Sets up an ATA taskfile to issue FLUSH CACHE or
1303 * spin_lock_irqsave(host lock)
1306 * Zero on success, non-zero on error.
1308 static unsigned int ata_scsi_flush_xlat(struct ata_queued_cmd *qc)
1310 struct ata_taskfile *tf = &qc->tf;
1312 tf->flags |= ATA_TFLAG_DEVICE;
1313 tf->protocol = ATA_PROT_NODATA;
1315 if (qc->dev->flags & ATA_DFLAG_FLUSH_EXT)
1316 tf->command = ATA_CMD_FLUSH_EXT;
1318 tf->command = ATA_CMD_FLUSH;
1320 /* flush is critical for IO integrity, consider it an IO command */
1321 qc->flags |= ATA_QCFLAG_IO;
1327 * scsi_6_lba_len - Get LBA and transfer length
1328 * @cdb: SCSI command to translate
1330 * Calculate LBA and transfer length for 6-byte commands.
1334 * @plen: the transfer length
1336 static void scsi_6_lba_len(const u8 *cdb, u64 *plba, u32 *plen)
1341 lba |= ((u64)(cdb[1] & 0x1f)) << 16;
1342 lba |= ((u64)cdb[2]) << 8;
1343 lba |= ((u64)cdb[3]);
1352 * scsi_10_lba_len - Get LBA and transfer length
1353 * @cdb: SCSI command to translate
1355 * Calculate LBA and transfer length for 10-byte commands.
1359 * @plen: the transfer length
1361 static inline void scsi_10_lba_len(const u8 *cdb, u64 *plba, u32 *plen)
1363 *plba = get_unaligned_be32(&cdb[2]);
1364 *plen = get_unaligned_be16(&cdb[7]);
1368 * scsi_16_lba_len - Get LBA and transfer length
1369 * @cdb: SCSI command to translate
1371 * Calculate LBA and transfer length for 16-byte commands.
1375 * @plen: the transfer length
1377 static inline void scsi_16_lba_len(const u8 *cdb, u64 *plba, u32 *plen)
1379 *plba = get_unaligned_be64(&cdb[2]);
1380 *plen = get_unaligned_be32(&cdb[10]);
1384 * scsi_dld - Get duration limit descriptor index
1385 * @cdb: SCSI command to translate
1387 * Returns the dld bits indicating the index of a command duration limit
1390 static inline int scsi_dld(const u8 *cdb)
1392 return ((cdb[1] & 0x01) << 2) | ((cdb[14] >> 6) & 0x03);
1396 * ata_scsi_verify_xlat - Translate SCSI VERIFY command into an ATA one
1397 * @qc: Storage for translated ATA taskfile
1399 * Converts SCSI VERIFY command to an ATA READ VERIFY command.
1402 * spin_lock_irqsave(host lock)
1405 * Zero on success, non-zero on error.
1407 static unsigned int ata_scsi_verify_xlat(struct ata_queued_cmd *qc)
1409 struct scsi_cmnd *scmd = qc->scsicmd;
1410 struct ata_taskfile *tf = &qc->tf;
1411 struct ata_device *dev = qc->dev;
1412 u64 dev_sectors = qc->dev->n_sectors;
1413 const u8 *cdb = scmd->cmnd;
1418 tf->flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
1419 tf->protocol = ATA_PROT_NODATA;
1423 if (scmd->cmd_len < 10) {
1427 scsi_10_lba_len(cdb, &block, &n_block);
1430 if (scmd->cmd_len < 16) {
1434 scsi_16_lba_len(cdb, &block, &n_block);
1443 if (block >= dev_sectors)
1445 if ((block + n_block) > dev_sectors)
1448 if (dev->flags & ATA_DFLAG_LBA) {
1449 tf->flags |= ATA_TFLAG_LBA;
1451 if (lba_28_ok(block, n_block)) {
1453 tf->command = ATA_CMD_VERIFY;
1454 tf->device |= (block >> 24) & 0xf;
1455 } else if (lba_48_ok(block, n_block)) {
1456 if (!(dev->flags & ATA_DFLAG_LBA48))
1460 tf->flags |= ATA_TFLAG_LBA48;
1461 tf->command = ATA_CMD_VERIFY_EXT;
1463 tf->hob_nsect = (n_block >> 8) & 0xff;
1465 tf->hob_lbah = (block >> 40) & 0xff;
1466 tf->hob_lbam = (block >> 32) & 0xff;
1467 tf->hob_lbal = (block >> 24) & 0xff;
1469 /* request too large even for LBA48 */
1472 tf->nsect = n_block & 0xff;
1474 tf->lbah = (block >> 16) & 0xff;
1475 tf->lbam = (block >> 8) & 0xff;
1476 tf->lbal = block & 0xff;
1478 tf->device |= ATA_LBA;
1481 u32 sect, head, cyl, track;
1483 if (!lba_28_ok(block, n_block))
1486 /* Convert LBA to CHS */
1487 track = (u32)block / dev->sectors;
1488 cyl = track / dev->heads;
1489 head = track % dev->heads;
1490 sect = (u32)block % dev->sectors + 1;
1492 /* Check whether the converted CHS can fit.
1496 if ((cyl >> 16) || (head >> 4) || (sect >> 8) || (!sect))
1499 tf->command = ATA_CMD_VERIFY;
1500 tf->nsect = n_block & 0xff; /* Sector count 0 means 256 sectors */
1503 tf->lbah = cyl >> 8;
1510 ata_scsi_set_invalid_field(qc->dev, scmd, fp, 0xff);
1514 ata_scsi_set_sense(qc->dev, scmd, ILLEGAL_REQUEST, 0x21, 0x0);
1515 /* "Logical Block Address out of range" */
1519 scmd->result = SAM_STAT_GOOD;
1523 static bool ata_check_nblocks(struct scsi_cmnd *scmd, u32 n_blocks)
1525 struct request *rq = scsi_cmd_to_rq(scmd);
1528 if (!blk_rq_is_passthrough(rq))
1531 req_blocks = blk_rq_bytes(rq) / scmd->device->sector_size;
1532 if (n_blocks > req_blocks)
1539 * ata_scsi_rw_xlat - Translate SCSI r/w command into an ATA one
1540 * @qc: Storage for translated ATA taskfile
1542 * Converts any of six SCSI read/write commands into the
1543 * ATA counterpart, including starting sector (LBA),
1544 * sector count, and taking into account the device's LBA48
1547 * Commands %READ_6, %READ_10, %READ_16, %WRITE_6, %WRITE_10, and
1548 * %WRITE_16 are currently supported.
1551 * spin_lock_irqsave(host lock)
1554 * Zero on success, non-zero on error.
1556 static unsigned int ata_scsi_rw_xlat(struct ata_queued_cmd *qc)
1558 struct scsi_cmnd *scmd = qc->scsicmd;
1559 const u8 *cdb = scmd->cmnd;
1560 struct request *rq = scsi_cmd_to_rq(scmd);
1561 int class = IOPRIO_PRIO_CLASS(req_get_ioprio(rq));
1562 unsigned int tf_flags = 0;
1573 tf_flags |= ATA_TFLAG_WRITE;
1577 /* Calculate the SCSI LBA, transfer length and FUA. */
1581 if (unlikely(scmd->cmd_len < 10)) {
1585 scsi_10_lba_len(cdb, &block, &n_block);
1586 if (cdb[1] & (1 << 3))
1587 tf_flags |= ATA_TFLAG_FUA;
1588 if (!ata_check_nblocks(scmd, n_block))
1593 if (unlikely(scmd->cmd_len < 6)) {
1597 scsi_6_lba_len(cdb, &block, &n_block);
1599 /* for 6-byte r/w commands, transfer length 0
1600 * means 256 blocks of data, not 0 block.
1604 if (!ata_check_nblocks(scmd, n_block))
1609 if (unlikely(scmd->cmd_len < 16)) {
1613 scsi_16_lba_len(cdb, &block, &n_block);
1614 dld = scsi_dld(cdb);
1615 if (cdb[1] & (1 << 3))
1616 tf_flags |= ATA_TFLAG_FUA;
1617 if (!ata_check_nblocks(scmd, n_block))
1625 /* Check and compose ATA command */
1627 /* For 10-byte and 16-byte SCSI R/W commands, transfer
1628 * length 0 means transfer 0 block of data.
1629 * However, for ATA R/W commands, sector count 0 means
1630 * 256 or 65536 sectors, not 0 sectors as in SCSI.
1632 * WARNING: one or two older ATA drives treat 0 as 0...
1636 qc->flags |= ATA_QCFLAG_IO;
1637 qc->nbytes = n_block * scmd->device->sector_size;
1639 rc = ata_build_rw_tf(qc, block, n_block, tf_flags, dld, class);
1640 if (likely(rc == 0))
1645 /* treat all other errors as -EINVAL, fall through */
1647 ata_scsi_set_invalid_field(qc->dev, scmd, fp, 0xff);
1651 ata_scsi_set_sense(qc->dev, scmd, ILLEGAL_REQUEST, 0x21, 0x0);
1652 /* "Logical Block Address out of range" */
1656 scmd->result = SAM_STAT_GOOD;
1660 static void ata_qc_done(struct ata_queued_cmd *qc)
1662 struct scsi_cmnd *cmd = qc->scsicmd;
1663 void (*done)(struct scsi_cmnd *) = qc->scsidone;
1669 static void ata_scsi_qc_complete(struct ata_queued_cmd *qc)
1671 struct ata_port *ap = qc->ap;
1672 struct scsi_cmnd *cmd = qc->scsicmd;
1673 u8 *cdb = cmd->cmnd;
1674 int need_sense = (qc->err_mask != 0) &&
1675 !(qc->flags & ATA_QCFLAG_SENSE_VALID);
1677 /* For ATA pass thru (SAT) commands, generate a sense block if
1678 * user mandated it or if there's an error. Note that if we
1679 * generate because the user forced us to [CK_COND =1], a check
1680 * condition is generated and the ATA register values are returned
1681 * whether the command completed successfully or not. If there
1682 * was no error, we use the following sense data:
1683 * sk = RECOVERED ERROR
1684 * asc,ascq = ATA PASS-THROUGH INFORMATION AVAILABLE
1686 if (((cdb[0] == ATA_16) || (cdb[0] == ATA_12)) &&
1687 ((cdb[2] & 0x20) || need_sense))
1688 ata_gen_passthru_sense(qc);
1689 else if (need_sense)
1690 ata_gen_ata_sense(qc);
1692 /* Keep the SCSI ML and status byte, clear host byte. */
1693 cmd->result &= 0x0000ffff;
1695 if (need_sense && !ap->ops->error_handler)
1696 ata_dump_status(ap, &qc->result_tf);
1702 * ata_scsi_translate - Translate then issue SCSI command to ATA device
1703 * @dev: ATA device to which the command is addressed
1704 * @cmd: SCSI command to execute
1705 * @xlat_func: Actor which translates @cmd to an ATA taskfile
1707 * Our ->queuecommand() function has decided that the SCSI
1708 * command issued can be directly translated into an ATA
1709 * command, rather than handled internally.
1711 * This function sets up an ata_queued_cmd structure for the
1712 * SCSI command, and sends that ata_queued_cmd to the hardware.
1714 * The xlat_func argument (actor) returns 0 if ready to execute
1715 * ATA command, else 1 to finish translation. If 1 is returned
1716 * then cmd->result (and possibly cmd->sense_buffer) are assumed
1717 * to be set reflecting an error condition or clean (early)
1721 * spin_lock_irqsave(host lock)
1724 * 0 on success, SCSI_ML_QUEUE_DEVICE_BUSY if the command
1725 * needs to be deferred.
1727 static int ata_scsi_translate(struct ata_device *dev, struct scsi_cmnd *cmd,
1728 ata_xlat_func_t xlat_func)
1730 struct ata_port *ap = dev->link->ap;
1731 struct ata_queued_cmd *qc;
1734 qc = ata_scsi_qc_new(dev, cmd);
1738 /* data is present; dma-map it */
1739 if (cmd->sc_data_direction == DMA_FROM_DEVICE ||
1740 cmd->sc_data_direction == DMA_TO_DEVICE) {
1741 if (unlikely(scsi_bufflen(cmd) < 1)) {
1742 ata_dev_warn(dev, "WARNING: zero len r/w req\n");
1746 ata_sg_init(qc, scsi_sglist(cmd), scsi_sg_count(cmd));
1748 qc->dma_dir = cmd->sc_data_direction;
1751 qc->complete_fn = ata_scsi_qc_complete;
1756 if (ap->ops->qc_defer) {
1757 if ((rc = ap->ops->qc_defer(qc)))
1761 /* select device, send command to hardware */
1773 cmd->result = (DID_ERROR << 16);
1780 if (rc == ATA_DEFER_LINK)
1781 return SCSI_MLQUEUE_DEVICE_BUSY;
1783 return SCSI_MLQUEUE_HOST_BUSY;
1786 struct ata_scsi_args {
1787 struct ata_device *dev;
1789 struct scsi_cmnd *cmd;
1793 * ata_scsi_rbuf_fill - wrapper for SCSI command simulators
1794 * @args: device IDENTIFY data / SCSI command of interest.
1795 * @actor: Callback hook for desired SCSI command simulator
1797 * Takes care of the hard work of simulating a SCSI command...
1798 * Mapping the response buffer, calling the command's handler,
1799 * and handling the handler's return value. This return value
1800 * indicates whether the handler wishes the SCSI command to be
1801 * completed successfully (0), or not (in which case cmd->result
1802 * and sense buffer are assumed to be set).
1805 * spin_lock_irqsave(host lock)
1807 static void ata_scsi_rbuf_fill(struct ata_scsi_args *args,
1808 unsigned int (*actor)(struct ata_scsi_args *args, u8 *rbuf))
1811 struct scsi_cmnd *cmd = args->cmd;
1812 unsigned long flags;
1814 spin_lock_irqsave(&ata_scsi_rbuf_lock, flags);
1816 memset(ata_scsi_rbuf, 0, ATA_SCSI_RBUF_SIZE);
1817 rc = actor(args, ata_scsi_rbuf);
1819 sg_copy_from_buffer(scsi_sglist(cmd), scsi_sg_count(cmd),
1820 ata_scsi_rbuf, ATA_SCSI_RBUF_SIZE);
1822 spin_unlock_irqrestore(&ata_scsi_rbuf_lock, flags);
1825 cmd->result = SAM_STAT_GOOD;
1829 * ata_scsiop_inq_std - Simulate INQUIRY command
1830 * @args: device IDENTIFY data / SCSI command of interest.
1831 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1833 * Returns standard device identification data associated
1834 * with non-VPD INQUIRY command output.
1837 * spin_lock_irqsave(host lock)
1839 static unsigned int ata_scsiop_inq_std(struct ata_scsi_args *args, u8 *rbuf)
1841 static const u8 versions[] = {
1843 0x60, /* SAM-3 (no version claimed) */
1846 0x20, /* SBC-2 (no version claimed) */
1849 0x00 /* SPC-3 (no version claimed) */
1851 static const u8 versions_zbc[] = {
1853 0xA0, /* SAM-5 (no version claimed) */
1856 0x00, /* SBC-4 (no version claimed) */
1859 0xC0, /* SPC-5 (no version claimed) */
1868 0x5, /* claim SPC-3 version compatibility */
1876 /* set scsi removable (RMB) bit per ata bit, or if the
1877 * AHCI port says it's external (Hotplug-capable, eSATA).
1879 if (ata_id_removable(args->id) ||
1880 (args->dev->link->ap->pflags & ATA_PFLAG_EXTERNAL))
1883 if (args->dev->class == ATA_DEV_ZAC) {
1885 hdr[2] = 0x7; /* claim SPC-5 version compatibility */
1888 memcpy(rbuf, hdr, sizeof(hdr));
1889 memcpy(&rbuf[8], "ATA ", 8);
1890 ata_id_string(args->id, &rbuf[16], ATA_ID_PROD, 16);
1892 /* From SAT, use last 2 words from fw rev unless they are spaces */
1893 ata_id_string(args->id, &rbuf[32], ATA_ID_FW_REV + 2, 4);
1894 if (strncmp(&rbuf[32], " ", 4) == 0)
1895 ata_id_string(args->id, &rbuf[32], ATA_ID_FW_REV, 4);
1897 if (rbuf[32] == 0 || rbuf[32] == ' ')
1898 memcpy(&rbuf[32], "n/a ", 4);
1900 if (ata_id_zoned_cap(args->id) || args->dev->class == ATA_DEV_ZAC)
1901 memcpy(rbuf + 58, versions_zbc, sizeof(versions_zbc));
1903 memcpy(rbuf + 58, versions, sizeof(versions));
1909 * ata_scsiop_inq_00 - Simulate INQUIRY VPD page 0, list of pages
1910 * @args: device IDENTIFY data / SCSI command of interest.
1911 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1913 * Returns list of inquiry VPD pages available.
1916 * spin_lock_irqsave(host lock)
1918 static unsigned int ata_scsiop_inq_00(struct ata_scsi_args *args, u8 *rbuf)
1920 int i, num_pages = 0;
1921 static const u8 pages[] = {
1922 0x00, /* page 0x00, this page */
1923 0x80, /* page 0x80, unit serial no page */
1924 0x83, /* page 0x83, device ident page */
1925 0x89, /* page 0x89, ata info page */
1926 0xb0, /* page 0xb0, block limits page */
1927 0xb1, /* page 0xb1, block device characteristics page */
1928 0xb2, /* page 0xb2, thin provisioning page */
1929 0xb6, /* page 0xb6, zoned block device characteristics */
1930 0xb9, /* page 0xb9, concurrent positioning ranges */
1933 for (i = 0; i < sizeof(pages); i++) {
1934 if (pages[i] == 0xb6 &&
1935 !(args->dev->flags & ATA_DFLAG_ZAC))
1937 rbuf[num_pages + 4] = pages[i];
1940 rbuf[3] = num_pages; /* number of supported VPD pages */
1945 * ata_scsiop_inq_80 - Simulate INQUIRY VPD page 80, device serial number
1946 * @args: device IDENTIFY data / SCSI command of interest.
1947 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1949 * Returns ATA device serial number.
1952 * spin_lock_irqsave(host lock)
1954 static unsigned int ata_scsiop_inq_80(struct ata_scsi_args *args, u8 *rbuf)
1956 static const u8 hdr[] = {
1958 0x80, /* this page code */
1960 ATA_ID_SERNO_LEN, /* page len */
1963 memcpy(rbuf, hdr, sizeof(hdr));
1964 ata_id_string(args->id, (unsigned char *) &rbuf[4],
1965 ATA_ID_SERNO, ATA_ID_SERNO_LEN);
1970 * ata_scsiop_inq_83 - Simulate INQUIRY VPD page 83, device identity
1971 * @args: device IDENTIFY data / SCSI command of interest.
1972 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1974 * Yields two logical unit device identification designators:
1975 * - vendor specific ASCII containing the ATA serial number
1976 * - SAT defined "t10 vendor id based" containing ASCII vendor
1977 * name ("ATA "), model and serial numbers.
1980 * spin_lock_irqsave(host lock)
1982 static unsigned int ata_scsiop_inq_83(struct ata_scsi_args *args, u8 *rbuf)
1984 const int sat_model_serial_desc_len = 68;
1987 rbuf[1] = 0x83; /* this page code */
1990 /* piv=0, assoc=lu, code_set=ACSII, designator=vendor */
1992 rbuf[num + 3] = ATA_ID_SERNO_LEN;
1994 ata_id_string(args->id, (unsigned char *) rbuf + num,
1995 ATA_ID_SERNO, ATA_ID_SERNO_LEN);
1996 num += ATA_ID_SERNO_LEN;
1998 /* SAT defined lu model and serial numbers descriptor */
1999 /* piv=0, assoc=lu, code_set=ACSII, designator=t10 vendor id */
2002 rbuf[num + 3] = sat_model_serial_desc_len;
2004 memcpy(rbuf + num, "ATA ", 8);
2006 ata_id_string(args->id, (unsigned char *) rbuf + num, ATA_ID_PROD,
2008 num += ATA_ID_PROD_LEN;
2009 ata_id_string(args->id, (unsigned char *) rbuf + num, ATA_ID_SERNO,
2011 num += ATA_ID_SERNO_LEN;
2013 if (ata_id_has_wwn(args->id)) {
2014 /* SAT defined lu world wide name */
2015 /* piv=0, assoc=lu, code_set=binary, designator=NAA */
2018 rbuf[num + 3] = ATA_ID_WWN_LEN;
2020 ata_id_string(args->id, (unsigned char *) rbuf + num,
2021 ATA_ID_WWN, ATA_ID_WWN_LEN);
2022 num += ATA_ID_WWN_LEN;
2024 rbuf[3] = num - 4; /* page len (assume less than 256 bytes) */
2029 * ata_scsiop_inq_89 - Simulate INQUIRY VPD page 89, ATA info
2030 * @args: device IDENTIFY data / SCSI command of interest.
2031 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2033 * Yields SAT-specified ATA VPD page.
2036 * spin_lock_irqsave(host lock)
2038 static unsigned int ata_scsiop_inq_89(struct ata_scsi_args *args, u8 *rbuf)
2040 rbuf[1] = 0x89; /* our page code */
2041 rbuf[2] = (0x238 >> 8); /* page size fixed at 238h */
2042 rbuf[3] = (0x238 & 0xff);
2044 memcpy(&rbuf[8], "linux ", 8);
2045 memcpy(&rbuf[16], "libata ", 16);
2046 memcpy(&rbuf[32], DRV_VERSION, 4);
2048 rbuf[36] = 0x34; /* force D2H Reg FIS (34h) */
2049 rbuf[37] = (1 << 7); /* bit 7 indicates Command FIS */
2052 /* we don't store the ATA device signature, so we fake it */
2053 rbuf[38] = ATA_DRDY; /* really, this is Status reg */
2057 rbuf[56] = ATA_CMD_ID_ATA;
2059 memcpy(&rbuf[60], &args->id[0], 512);
2063 static unsigned int ata_scsiop_inq_b0(struct ata_scsi_args *args, u8 *rbuf)
2065 struct ata_device *dev = args->dev;
2069 rbuf[3] = 0x3c; /* required VPD size with unmap support */
2072 * Optimal transfer length granularity.
2074 * This is always one physical block, but for disks with a smaller
2075 * logical than physical sector size we need to figure out what the
2078 min_io_sectors = 1 << ata_id_log2_per_physical_sector(args->id);
2079 put_unaligned_be16(min_io_sectors, &rbuf[6]);
2082 * Optimal unmap granularity.
2084 * The ATA spec doesn't even know about a granularity or alignment
2085 * for the TRIM command. We can leave away most of the unmap related
2086 * VPD page entries, but we have specifify a granularity to signal
2087 * that we support some form of unmap - in thise case via WRITE SAME
2088 * with the unmap bit set.
2090 if (ata_id_has_trim(args->id)) {
2091 u64 max_blocks = 65535 * ATA_MAX_TRIM_RNUM;
2093 if (dev->horkage & ATA_HORKAGE_MAX_TRIM_128M)
2094 max_blocks = 128 << (20 - SECTOR_SHIFT);
2096 put_unaligned_be64(max_blocks, &rbuf[36]);
2097 put_unaligned_be32(1, &rbuf[28]);
2103 static unsigned int ata_scsiop_inq_b1(struct ata_scsi_args *args, u8 *rbuf)
2105 int form_factor = ata_id_form_factor(args->id);
2106 int media_rotation_rate = ata_id_rotation_rate(args->id);
2107 u8 zoned = ata_id_zoned_cap(args->id);
2111 rbuf[4] = media_rotation_rate >> 8;
2112 rbuf[5] = media_rotation_rate;
2113 rbuf[7] = form_factor;
2115 rbuf[8] = (zoned << 4);
2120 static unsigned int ata_scsiop_inq_b2(struct ata_scsi_args *args, u8 *rbuf)
2122 /* SCSI Thin Provisioning VPD page: SBC-3 rev 22 or later */
2125 rbuf[5] = 1 << 6; /* TPWS */
2130 static unsigned int ata_scsiop_inq_b6(struct ata_scsi_args *args, u8 *rbuf)
2133 * zbc-r05 SCSI Zoned Block device characteristics VPD page
2139 * URSWRZ bit is only meaningful for host-managed ZAC drives
2141 if (args->dev->zac_zoned_cap & 1)
2143 put_unaligned_be32(args->dev->zac_zones_optimal_open, &rbuf[8]);
2144 put_unaligned_be32(args->dev->zac_zones_optimal_nonseq, &rbuf[12]);
2145 put_unaligned_be32(args->dev->zac_zones_max_open, &rbuf[16]);
2150 static unsigned int ata_scsiop_inq_b9(struct ata_scsi_args *args, u8 *rbuf)
2152 struct ata_cpr_log *cpr_log = args->dev->cpr_log;
2153 u8 *desc = &rbuf[64];
2156 /* SCSI Concurrent Positioning Ranges VPD page: SBC-5 rev 1 or later */
2158 put_unaligned_be16(64 + (int)cpr_log->nr_cpr * 32 - 4, &rbuf[2]);
2160 for (i = 0; i < cpr_log->nr_cpr; i++, desc += 32) {
2161 desc[0] = cpr_log->cpr[i].num;
2162 desc[1] = cpr_log->cpr[i].num_storage_elements;
2163 put_unaligned_be64(cpr_log->cpr[i].start_lba, &desc[8]);
2164 put_unaligned_be64(cpr_log->cpr[i].num_lbas, &desc[16]);
2171 * modecpy - Prepare response for MODE SENSE
2172 * @dest: output buffer
2173 * @src: data being copied
2174 * @n: length of mode page
2175 * @changeable: whether changeable parameters are requested
2177 * Generate a generic MODE SENSE page for either current or changeable
2183 static void modecpy(u8 *dest, const u8 *src, int n, bool changeable)
2186 memcpy(dest, src, 2);
2187 memset(dest + 2, 0, n - 2);
2189 memcpy(dest, src, n);
2194 * ata_msense_caching - Simulate MODE SENSE caching info page
2195 * @id: device IDENTIFY data
2196 * @buf: output buffer
2197 * @changeable: whether changeable parameters are requested
2199 * Generate a caching info page, which conditionally indicates
2200 * write caching to the SCSI layer, depending on device
2206 static unsigned int ata_msense_caching(u16 *id, u8 *buf, bool changeable)
2208 modecpy(buf, def_cache_mpage, sizeof(def_cache_mpage), changeable);
2210 buf[2] |= (1 << 2); /* ata_mselect_caching() */
2212 buf[2] |= (ata_id_wcache_enabled(id) << 2); /* write cache enable */
2213 buf[12] |= (!ata_id_rahead_enabled(id) << 5); /* disable read ahead */
2215 return sizeof(def_cache_mpage);
2219 * Simulate MODE SENSE control mode page, sub-page 0.
2221 static unsigned int ata_msense_control_spg0(struct ata_device *dev, u8 *buf,
2224 modecpy(buf, def_control_mpage,
2225 sizeof(def_control_mpage), changeable);
2227 /* ata_mselect_control() */
2230 bool d_sense = (dev->flags & ATA_DFLAG_D_SENSE);
2232 /* descriptor format sense data */
2233 buf[2] |= (d_sense << 2);
2236 return sizeof(def_control_mpage);
2240 * Translate an ATA duration limit in microseconds to a SCSI duration limit
2241 * using the t2cdlunits 0xa (10ms). Since the SCSI duration limits are 2-bytes
2242 * only, take care of overflows.
2244 static inline u16 ata_xlat_cdl_limit(u8 *buf)
2246 u32 limit = get_unaligned_le32(buf);
2248 return min_t(u32, limit / 10000, 65535);
2252 * Simulate MODE SENSE control mode page, sub-pages 07h and 08h
2253 * (command duration limits T2A and T2B mode pages).
2255 static unsigned int ata_msense_control_spgt2(struct ata_device *dev, u8 *buf,
2258 u8 *b, *cdl = dev->cdl, *desc;
2263 * Fill the subpage. The first four bytes of the T2A/T2B mode pages
2264 * are a header. The PAGE LENGTH field is the size of the page
2265 * excluding the header.
2267 buf[0] = CONTROL_MPAGE;
2269 put_unaligned_be16(CDL_T2_SUB_MPAGE_LEN - 4, &buf[2]);
2270 if (spg == CDL_T2A_SUB_MPAGE) {
2272 * Read descriptors map to the T2A page:
2273 * set perf_vs_duration_guidleine.
2275 buf[7] = (cdl[0] & 0x03) << 4;
2278 /* Write descriptors map to the T2B page */
2282 /* Fill the T2 page descriptors */
2284 policy = get_unaligned_le32(&cdl[0]);
2285 for (i = 0; i < 7; i++, b += 32, desc += 32) {
2286 /* t2cdlunits: fixed to 10ms */
2289 /* Max inactive time and its policy */
2290 put_unaligned_be16(ata_xlat_cdl_limit(&desc[8]), &b[2]);
2291 b[6] = ((policy >> 8) & 0x0f) << 4;
2293 /* Max active time and its policy */
2294 put_unaligned_be16(ata_xlat_cdl_limit(&desc[4]), &b[4]);
2295 b[6] |= (policy >> 4) & 0x0f;
2297 /* Command duration guideline and its policy */
2298 put_unaligned_be16(ata_xlat_cdl_limit(&desc[16]), &b[10]);
2299 b[14] = policy & 0x0f;
2302 return CDL_T2_SUB_MPAGE_LEN;
2306 * Simulate MODE SENSE control mode page, sub-page f2h
2307 * (ATA feature control mode page).
2309 static unsigned int ata_msense_control_ata_feature(struct ata_device *dev,
2313 buf[0] = CONTROL_MPAGE | (1 << 6);
2314 buf[1] = ATA_FEATURE_SUB_MPAGE;
2317 * The first four bytes of ATA Feature Control mode page are a header.
2318 * The PAGE LENGTH field is the size of the page excluding the header.
2320 put_unaligned_be16(ATA_FEATURE_SUB_MPAGE_LEN - 4, &buf[2]);
2322 if (dev->flags & ATA_DFLAG_CDL)
2323 buf[4] = 0x02; /* Support T2A and T2B pages */
2327 return ATA_FEATURE_SUB_MPAGE_LEN;
2331 * ata_msense_control - Simulate MODE SENSE control mode page
2332 * @dev: ATA device of interest
2333 * @buf: output buffer
2334 * @spg: sub-page code
2335 * @changeable: whether changeable parameters are requested
2337 * Generate a generic MODE SENSE control mode page.
2342 static unsigned int ata_msense_control(struct ata_device *dev, u8 *buf,
2343 u8 spg, bool changeable)
2349 return ata_msense_control_spg0(dev, buf, changeable);
2350 case CDL_T2A_SUB_MPAGE:
2351 case CDL_T2B_SUB_MPAGE:
2352 return ata_msense_control_spgt2(dev, buf, spg);
2353 case ATA_FEATURE_SUB_MPAGE:
2354 return ata_msense_control_ata_feature(dev, buf);
2355 case ALL_SUB_MPAGES:
2356 n = ata_msense_control_spg0(dev, buf, changeable);
2357 n += ata_msense_control_spgt2(dev, buf + n, CDL_T2A_SUB_MPAGE);
2358 n += ata_msense_control_spgt2(dev, buf + n, CDL_T2A_SUB_MPAGE);
2359 n += ata_msense_control_ata_feature(dev, buf + n);
2367 * ata_msense_rw_recovery - Simulate MODE SENSE r/w error recovery page
2368 * @buf: output buffer
2369 * @changeable: whether changeable parameters are requested
2371 * Generate a generic MODE SENSE r/w error recovery page.
2376 static unsigned int ata_msense_rw_recovery(u8 *buf, bool changeable)
2378 modecpy(buf, def_rw_recovery_mpage, sizeof(def_rw_recovery_mpage),
2380 return sizeof(def_rw_recovery_mpage);
2384 * ata_scsiop_mode_sense - Simulate MODE SENSE 6, 10 commands
2385 * @args: device IDENTIFY data / SCSI command of interest.
2386 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2388 * Simulate MODE SENSE commands. Assume this is invoked for direct
2389 * access devices (e.g. disks) only. There should be no block
2390 * descriptor for other device types.
2393 * spin_lock_irqsave(host lock)
2395 static unsigned int ata_scsiop_mode_sense(struct ata_scsi_args *args, u8 *rbuf)
2397 struct ata_device *dev = args->dev;
2398 u8 *scsicmd = args->cmd->cmnd, *p = rbuf;
2399 static const u8 sat_blk_desc[] = {
2400 0, 0, 0, 0, /* number of blocks: sat unspecified */
2402 0, 0x2, 0x0 /* block length: 512 bytes */
2405 unsigned int ebd, page_control, six_byte;
2406 u8 dpofua = 0, bp = 0xff;
2409 six_byte = (scsicmd[0] == MODE_SENSE);
2410 ebd = !(scsicmd[1] & 0x8); /* dbd bit inverted == edb */
2412 * LLBA bit in msense(10) ignored (compliant)
2415 page_control = scsicmd[2] >> 6;
2416 switch (page_control) {
2417 case 0: /* current */
2418 case 1: /* changeable */
2419 case 2: /* defaults */
2420 break; /* supported */
2422 goto saving_not_supp;
2430 p += 4 + (ebd ? 8 : 0);
2432 p += 8 + (ebd ? 8 : 0);
2434 pg = scsicmd[2] & 0x3f;
2438 * Supported subpages: all subpages and sub-pages 07h, 08h and f2h of
2443 case ALL_SUB_MPAGES:
2445 case CDL_T2A_SUB_MPAGE:
2446 case CDL_T2B_SUB_MPAGE:
2447 case ATA_FEATURE_SUB_MPAGE:
2448 if (dev->flags & ATA_DFLAG_CDL && pg == CONTROL_MPAGE)
2458 case RW_RECOVERY_MPAGE:
2459 p += ata_msense_rw_recovery(p, page_control == 1);
2463 p += ata_msense_caching(args->id, p, page_control == 1);
2467 p += ata_msense_control(args->dev, p, spg, page_control == 1);
2471 p += ata_msense_rw_recovery(p, page_control == 1);
2472 p += ata_msense_caching(args->id, p, page_control == 1);
2473 p += ata_msense_control(args->dev, p, spg, page_control == 1);
2476 default: /* invalid page code */
2481 if (dev->flags & ATA_DFLAG_FUA)
2485 rbuf[0] = p - rbuf - 1;
2488 rbuf[3] = sizeof(sat_blk_desc);
2489 memcpy(rbuf + 4, sat_blk_desc, sizeof(sat_blk_desc));
2492 put_unaligned_be16(p - rbuf - 2, &rbuf[0]);
2495 rbuf[7] = sizeof(sat_blk_desc);
2496 memcpy(rbuf + 8, sat_blk_desc, sizeof(sat_blk_desc));
2502 ata_scsi_set_invalid_field(dev, args->cmd, fp, bp);
2506 ata_scsi_set_sense(dev, args->cmd, ILLEGAL_REQUEST, 0x39, 0x0);
2507 /* "Saving parameters not supported" */
2512 * ata_scsiop_read_cap - Simulate READ CAPACITY[ 16] commands
2513 * @args: device IDENTIFY data / SCSI command of interest.
2514 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2516 * Simulate READ CAPACITY commands.
2521 static unsigned int ata_scsiop_read_cap(struct ata_scsi_args *args, u8 *rbuf)
2523 struct ata_device *dev = args->dev;
2524 u64 last_lba = dev->n_sectors - 1; /* LBA of the last block */
2525 u32 sector_size; /* physical sector size in bytes */
2529 sector_size = ata_id_logical_sector_size(dev->id);
2530 log2_per_phys = ata_id_log2_per_physical_sector(dev->id);
2531 lowest_aligned = ata_id_logical_sector_offset(dev->id, log2_per_phys);
2533 if (args->cmd->cmnd[0] == READ_CAPACITY) {
2534 if (last_lba >= 0xffffffffULL)
2535 last_lba = 0xffffffff;
2537 /* sector count, 32-bit */
2538 rbuf[0] = last_lba >> (8 * 3);
2539 rbuf[1] = last_lba >> (8 * 2);
2540 rbuf[2] = last_lba >> (8 * 1);
2544 rbuf[4] = sector_size >> (8 * 3);
2545 rbuf[5] = sector_size >> (8 * 2);
2546 rbuf[6] = sector_size >> (8 * 1);
2547 rbuf[7] = sector_size;
2549 /* sector count, 64-bit */
2550 rbuf[0] = last_lba >> (8 * 7);
2551 rbuf[1] = last_lba >> (8 * 6);
2552 rbuf[2] = last_lba >> (8 * 5);
2553 rbuf[3] = last_lba >> (8 * 4);
2554 rbuf[4] = last_lba >> (8 * 3);
2555 rbuf[5] = last_lba >> (8 * 2);
2556 rbuf[6] = last_lba >> (8 * 1);
2560 rbuf[ 8] = sector_size >> (8 * 3);
2561 rbuf[ 9] = sector_size >> (8 * 2);
2562 rbuf[10] = sector_size >> (8 * 1);
2563 rbuf[11] = sector_size;
2566 rbuf[13] = log2_per_phys;
2567 rbuf[14] = (lowest_aligned >> 8) & 0x3f;
2568 rbuf[15] = lowest_aligned;
2570 if (ata_id_has_trim(args->id) &&
2571 !(dev->horkage & ATA_HORKAGE_NOTRIM)) {
2572 rbuf[14] |= 0x80; /* LBPME */
2574 if (ata_id_has_zero_after_trim(args->id) &&
2575 dev->horkage & ATA_HORKAGE_ZERO_AFTER_TRIM) {
2576 ata_dev_info(dev, "Enabling discard_zeroes_data\n");
2577 rbuf[14] |= 0x40; /* LBPRZ */
2580 if (ata_id_zoned_cap(args->id) ||
2581 args->dev->class == ATA_DEV_ZAC)
2582 rbuf[12] = (1 << 4); /* RC_BASIS */
2588 * ata_scsiop_report_luns - Simulate REPORT LUNS command
2589 * @args: device IDENTIFY data / SCSI command of interest.
2590 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2592 * Simulate REPORT LUNS command.
2595 * spin_lock_irqsave(host lock)
2597 static unsigned int ata_scsiop_report_luns(struct ata_scsi_args *args, u8 *rbuf)
2599 rbuf[3] = 8; /* just one lun, LUN 0, size 8 bytes */
2604 static void atapi_sense_complete(struct ata_queued_cmd *qc)
2606 if (qc->err_mask && ((qc->err_mask & AC_ERR_DEV) == 0)) {
2607 /* FIXME: not quite right; we don't want the
2608 * translation of taskfile registers into
2609 * a sense descriptors, since that's only
2610 * correct for ATA, not ATAPI
2612 ata_gen_passthru_sense(qc);
2618 /* is it pointless to prefer PIO for "safety reasons"? */
2619 static inline int ata_pio_use_silly(struct ata_port *ap)
2621 return (ap->flags & ATA_FLAG_PIO_DMA);
2624 static void atapi_request_sense(struct ata_queued_cmd *qc)
2626 struct ata_port *ap = qc->ap;
2627 struct scsi_cmnd *cmd = qc->scsicmd;
2629 memset(cmd->sense_buffer, 0, SCSI_SENSE_BUFFERSIZE);
2631 #ifdef CONFIG_ATA_SFF
2632 if (ap->ops->sff_tf_read)
2633 ap->ops->sff_tf_read(ap, &qc->tf);
2636 /* fill these in, for the case where they are -not- overwritten */
2637 cmd->sense_buffer[0] = 0x70;
2638 cmd->sense_buffer[2] = qc->tf.error >> 4;
2642 /* setup sg table and init transfer direction */
2643 sg_init_one(&qc->sgent, cmd->sense_buffer, SCSI_SENSE_BUFFERSIZE);
2644 ata_sg_init(qc, &qc->sgent, 1);
2645 qc->dma_dir = DMA_FROM_DEVICE;
2647 memset(&qc->cdb, 0, qc->dev->cdb_len);
2648 qc->cdb[0] = REQUEST_SENSE;
2649 qc->cdb[4] = SCSI_SENSE_BUFFERSIZE;
2651 qc->tf.flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
2652 qc->tf.command = ATA_CMD_PACKET;
2654 if (ata_pio_use_silly(ap)) {
2655 qc->tf.protocol = ATAPI_PROT_DMA;
2656 qc->tf.feature |= ATAPI_PKT_DMA;
2658 qc->tf.protocol = ATAPI_PROT_PIO;
2659 qc->tf.lbam = SCSI_SENSE_BUFFERSIZE;
2662 qc->nbytes = SCSI_SENSE_BUFFERSIZE;
2664 qc->complete_fn = atapi_sense_complete;
2670 * ATAPI devices typically report zero for their SCSI version, and sometimes
2671 * deviate from the spec WRT response data format. If SCSI version is
2672 * reported as zero like normal, then we make the following fixups:
2673 * 1) Fake MMC-5 version, to indicate to the Linux scsi midlayer this is a
2675 * 2) Ensure response data format / ATAPI information are always correct.
2677 static void atapi_fixup_inquiry(struct scsi_cmnd *cmd)
2681 sg_copy_to_buffer(scsi_sglist(cmd), scsi_sg_count(cmd), buf, 4);
2686 sg_copy_from_buffer(scsi_sglist(cmd), scsi_sg_count(cmd), buf, 4);
2689 static void atapi_qc_complete(struct ata_queued_cmd *qc)
2691 struct scsi_cmnd *cmd = qc->scsicmd;
2692 unsigned int err_mask = qc->err_mask;
2694 /* handle completion from new EH */
2695 if (unlikely(qc->ap->ops->error_handler &&
2696 (err_mask || qc->flags & ATA_QCFLAG_SENSE_VALID))) {
2698 if (!(qc->flags & ATA_QCFLAG_SENSE_VALID)) {
2699 /* FIXME: not quite right; we don't want the
2700 * translation of taskfile registers into a
2701 * sense descriptors, since that's only
2702 * correct for ATA, not ATAPI
2704 ata_gen_passthru_sense(qc);
2707 /* SCSI EH automatically locks door if sdev->locked is
2708 * set. Sometimes door lock request continues to
2709 * fail, for example, when no media is present. This
2710 * creates a loop - SCSI EH issues door lock which
2711 * fails and gets invoked again to acquire sense data
2712 * for the failed command.
2714 * If door lock fails, always clear sdev->locked to
2715 * avoid this infinite loop.
2717 * This may happen before SCSI scan is complete. Make
2718 * sure qc->dev->sdev isn't NULL before dereferencing.
2720 if (qc->cdb[0] == ALLOW_MEDIUM_REMOVAL && qc->dev->sdev)
2721 qc->dev->sdev->locked = 0;
2723 qc->scsicmd->result = SAM_STAT_CHECK_CONDITION;
2728 /* successful completion or old EH failure path */
2729 if (unlikely(err_mask & AC_ERR_DEV)) {
2730 cmd->result = SAM_STAT_CHECK_CONDITION;
2731 atapi_request_sense(qc);
2733 } else if (unlikely(err_mask)) {
2734 /* FIXME: not quite right; we don't want the
2735 * translation of taskfile registers into
2736 * a sense descriptors, since that's only
2737 * correct for ATA, not ATAPI
2739 ata_gen_passthru_sense(qc);
2741 if (cmd->cmnd[0] == INQUIRY && (cmd->cmnd[1] & 0x03) == 0)
2742 atapi_fixup_inquiry(cmd);
2743 cmd->result = SAM_STAT_GOOD;
2749 * atapi_xlat - Initialize PACKET taskfile
2750 * @qc: command structure to be initialized
2753 * spin_lock_irqsave(host lock)
2756 * Zero on success, non-zero on failure.
2758 static unsigned int atapi_xlat(struct ata_queued_cmd *qc)
2760 struct scsi_cmnd *scmd = qc->scsicmd;
2761 struct ata_device *dev = qc->dev;
2762 int nodata = (scmd->sc_data_direction == DMA_NONE);
2763 int using_pio = !nodata && (dev->flags & ATA_DFLAG_PIO);
2764 unsigned int nbytes;
2766 memset(qc->cdb, 0, dev->cdb_len);
2767 memcpy(qc->cdb, scmd->cmnd, scmd->cmd_len);
2769 qc->complete_fn = atapi_qc_complete;
2771 qc->tf.flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
2772 if (scmd->sc_data_direction == DMA_TO_DEVICE) {
2773 qc->tf.flags |= ATA_TFLAG_WRITE;
2776 qc->tf.command = ATA_CMD_PACKET;
2777 ata_qc_set_pc_nbytes(qc);
2779 /* check whether ATAPI DMA is safe */
2780 if (!nodata && !using_pio && atapi_check_dma(qc))
2783 /* Some controller variants snoop this value for Packet
2784 * transfers to do state machine and FIFO management. Thus we
2785 * want to set it properly, and for DMA where it is
2786 * effectively meaningless.
2788 nbytes = min(ata_qc_raw_nbytes(qc), (unsigned int)63 * 1024);
2790 /* Most ATAPI devices which honor transfer chunk size don't
2791 * behave according to the spec when odd chunk size which
2792 * matches the transfer length is specified. If the number of
2793 * bytes to transfer is 2n+1. According to the spec, what
2794 * should happen is to indicate that 2n+1 is going to be
2795 * transferred and transfer 2n+2 bytes where the last byte is
2798 * In practice, this doesn't happen. ATAPI devices first
2799 * indicate and transfer 2n bytes and then indicate and
2800 * transfer 2 bytes where the last byte is padding.
2802 * This inconsistency confuses several controllers which
2803 * perform PIO using DMA such as Intel AHCIs and sil3124/32.
2804 * These controllers use actual number of transferred bytes to
2805 * update DMA pointer and transfer of 4n+2 bytes make those
2806 * controller push DMA pointer by 4n+4 bytes because SATA data
2807 * FISes are aligned to 4 bytes. This causes data corruption
2808 * and buffer overrun.
2810 * Always setting nbytes to even number solves this problem
2811 * because then ATAPI devices don't have to split data at 2n
2817 qc->tf.lbam = (nbytes & 0xFF);
2818 qc->tf.lbah = (nbytes >> 8);
2821 qc->tf.protocol = ATAPI_PROT_NODATA;
2823 qc->tf.protocol = ATAPI_PROT_PIO;
2826 qc->tf.protocol = ATAPI_PROT_DMA;
2827 qc->tf.feature |= ATAPI_PKT_DMA;
2829 if ((dev->flags & ATA_DFLAG_DMADIR) &&
2830 (scmd->sc_data_direction != DMA_TO_DEVICE))
2831 /* some SATA bridges need us to indicate data xfer direction */
2832 qc->tf.feature |= ATAPI_DMADIR;
2836 /* FIXME: We need to translate 0x05 READ_BLOCK_LIMITS to a MODE_SENSE
2837 as ATAPI tape drives don't get this right otherwise */
2841 static struct ata_device *ata_find_dev(struct ata_port *ap, unsigned int devno)
2844 * For the non-PMP case, ata_link_max_devices() returns 1 (SATA case),
2845 * or 2 (IDE master + slave case). However, the former case includes
2846 * libsas hosted devices which are numbered per scsi host, leading
2847 * to devno potentially being larger than 0 but with each struct
2848 * ata_device having its own struct ata_port and struct ata_link.
2849 * To accommodate these, ignore devno and always use device number 0.
2851 if (likely(!sata_pmp_attached(ap))) {
2852 int link_max_devices = ata_link_max_devices(&ap->link);
2854 if (link_max_devices == 1)
2855 return &ap->link.device[0];
2857 if (devno < link_max_devices)
2858 return &ap->link.device[devno];
2864 * For PMP-attached devices, the device number corresponds to C
2865 * (channel) of SCSI [H:C:I:L], indicating the port pmp link
2868 if (devno < ap->nr_pmp_links)
2869 return &ap->pmp_link[devno].device[0];
2874 static struct ata_device *__ata_scsi_find_dev(struct ata_port *ap,
2875 const struct scsi_device *scsidev)
2879 /* skip commands not addressed to targets we simulate */
2880 if (!sata_pmp_attached(ap)) {
2881 if (unlikely(scsidev->channel || scsidev->lun))
2883 devno = scsidev->id;
2885 if (unlikely(scsidev->id || scsidev->lun))
2887 devno = scsidev->channel;
2890 return ata_find_dev(ap, devno);
2894 * ata_scsi_find_dev - lookup ata_device from scsi_cmnd
2895 * @ap: ATA port to which the device is attached
2896 * @scsidev: SCSI device from which we derive the ATA device
2898 * Given various information provided in struct scsi_cmnd,
2899 * map that onto an ATA bus, and using that mapping
2900 * determine which ata_device is associated with the
2901 * SCSI command to be sent.
2904 * spin_lock_irqsave(host lock)
2907 * Associated ATA device, or %NULL if not found.
2910 ata_scsi_find_dev(struct ata_port *ap, const struct scsi_device *scsidev)
2912 struct ata_device *dev = __ata_scsi_find_dev(ap, scsidev);
2914 if (unlikely(!dev || !ata_dev_enabled(dev)))
2921 * ata_scsi_map_proto - Map pass-thru protocol value to taskfile value.
2922 * @byte1: Byte 1 from pass-thru CDB.
2925 * ATA_PROT_UNKNOWN if mapping failed/unimplemented, protocol otherwise.
2928 ata_scsi_map_proto(u8 byte1)
2930 switch((byte1 & 0x1e) >> 1) {
2931 case 3: /* Non-data */
2932 return ATA_PROT_NODATA;
2935 case 10: /* UDMA Data-in */
2936 case 11: /* UDMA Data-Out */
2937 return ATA_PROT_DMA;
2939 case 4: /* PIO Data-in */
2940 case 5: /* PIO Data-out */
2941 return ATA_PROT_PIO;
2943 case 12: /* FPDMA */
2944 return ATA_PROT_NCQ;
2946 case 0: /* Hard Reset */
2948 case 8: /* Device Diagnostic */
2949 case 9: /* Device Reset */
2950 case 7: /* DMA Queued */
2951 case 15: /* Return Response Info */
2952 default: /* Reserved */
2956 return ATA_PROT_UNKNOWN;
2960 * ata_scsi_pass_thru - convert ATA pass-thru CDB to taskfile
2961 * @qc: command structure to be initialized
2963 * Handles either 12, 16, or 32-byte versions of the CDB.
2966 * Zero on success, non-zero on failure.
2968 static unsigned int ata_scsi_pass_thru(struct ata_queued_cmd *qc)
2970 struct ata_taskfile *tf = &(qc->tf);
2971 struct scsi_cmnd *scmd = qc->scsicmd;
2972 struct ata_device *dev = qc->dev;
2973 const u8 *cdb = scmd->cmnd;
2977 /* 7Fh variable length cmd means a ata pass-thru(32) */
2978 if (cdb[0] == VARIABLE_LENGTH_CMD)
2981 tf->protocol = ata_scsi_map_proto(cdb[1 + cdb_offset]);
2982 if (tf->protocol == ATA_PROT_UNKNOWN) {
2987 if ((cdb[2 + cdb_offset] & 0x3) == 0) {
2989 * When T_LENGTH is zero (No data is transferred), dir should
2992 if (scmd->sc_data_direction != DMA_NONE) {
2993 fp = 2 + cdb_offset;
2997 if (ata_is_ncq(tf->protocol))
2998 tf->protocol = ATA_PROT_NCQ_NODATA;
3002 tf->flags |= ATA_TFLAG_LBA;
3005 * 12 and 16 byte CDBs use different offsets to
3006 * provide the various register values.
3011 * 16-byte CDB - may contain extended commands.
3013 * If that is the case, copy the upper byte register values.
3015 if (cdb[1] & 0x01) {
3016 tf->hob_feature = cdb[3];
3017 tf->hob_nsect = cdb[5];
3018 tf->hob_lbal = cdb[7];
3019 tf->hob_lbam = cdb[9];
3020 tf->hob_lbah = cdb[11];
3021 tf->flags |= ATA_TFLAG_LBA48;
3023 tf->flags &= ~ATA_TFLAG_LBA48;
3026 * Always copy low byte, device and command registers.
3028 tf->feature = cdb[4];
3033 tf->device = cdb[13];
3034 tf->command = cdb[14];
3038 * 12-byte CDB - incapable of extended commands.
3040 tf->flags &= ~ATA_TFLAG_LBA48;
3042 tf->feature = cdb[3];
3047 tf->device = cdb[8];
3048 tf->command = cdb[9];
3052 * 32-byte CDB - may contain extended command fields.
3054 * If that is the case, copy the upper byte register values.
3056 if (cdb[10] & 0x01) {
3057 tf->hob_feature = cdb[20];
3058 tf->hob_nsect = cdb[22];
3059 tf->hob_lbal = cdb[16];
3060 tf->hob_lbam = cdb[15];
3061 tf->hob_lbah = cdb[14];
3062 tf->flags |= ATA_TFLAG_LBA48;
3064 tf->flags &= ~ATA_TFLAG_LBA48;
3066 tf->feature = cdb[21];
3067 tf->nsect = cdb[23];
3071 tf->device = cdb[24];
3072 tf->command = cdb[25];
3073 tf->auxiliary = get_unaligned_be32(&cdb[28]);
3077 /* For NCQ commands copy the tag value */
3078 if (ata_is_ncq(tf->protocol))
3079 tf->nsect = qc->hw_tag << 3;
3081 /* enforce correct master/slave bit */
3082 tf->device = dev->devno ?
3083 tf->device | ATA_DEV1 : tf->device & ~ATA_DEV1;
3085 switch (tf->command) {
3086 /* READ/WRITE LONG use a non-standard sect_size */
3087 case ATA_CMD_READ_LONG:
3088 case ATA_CMD_READ_LONG_ONCE:
3089 case ATA_CMD_WRITE_LONG:
3090 case ATA_CMD_WRITE_LONG_ONCE:
3091 if (tf->protocol != ATA_PROT_PIO || tf->nsect != 1) {
3095 qc->sect_size = scsi_bufflen(scmd);
3098 /* commands using reported Logical Block size (e.g. 512 or 4K) */
3099 case ATA_CMD_CFA_WRITE_NE:
3100 case ATA_CMD_CFA_TRANS_SECT:
3101 case ATA_CMD_CFA_WRITE_MULT_NE:
3102 /* XXX: case ATA_CMD_CFA_WRITE_SECTORS_WITHOUT_ERASE: */
3104 case ATA_CMD_READ_EXT:
3105 case ATA_CMD_READ_QUEUED:
3106 /* XXX: case ATA_CMD_READ_QUEUED_EXT: */
3107 case ATA_CMD_FPDMA_READ:
3108 case ATA_CMD_READ_MULTI:
3109 case ATA_CMD_READ_MULTI_EXT:
3110 case ATA_CMD_PIO_READ:
3111 case ATA_CMD_PIO_READ_EXT:
3112 case ATA_CMD_READ_STREAM_DMA_EXT:
3113 case ATA_CMD_READ_STREAM_EXT:
3114 case ATA_CMD_VERIFY:
3115 case ATA_CMD_VERIFY_EXT:
3117 case ATA_CMD_WRITE_EXT:
3118 case ATA_CMD_WRITE_FUA_EXT:
3119 case ATA_CMD_WRITE_QUEUED:
3120 case ATA_CMD_WRITE_QUEUED_FUA_EXT:
3121 case ATA_CMD_FPDMA_WRITE:
3122 case ATA_CMD_WRITE_MULTI:
3123 case ATA_CMD_WRITE_MULTI_EXT:
3124 case ATA_CMD_WRITE_MULTI_FUA_EXT:
3125 case ATA_CMD_PIO_WRITE:
3126 case ATA_CMD_PIO_WRITE_EXT:
3127 case ATA_CMD_WRITE_STREAM_DMA_EXT:
3128 case ATA_CMD_WRITE_STREAM_EXT:
3129 qc->sect_size = scmd->device->sector_size;
3132 /* Everything else uses 512 byte "sectors" */
3134 qc->sect_size = ATA_SECT_SIZE;
3138 * Set flags so that all registers will be written, pass on
3139 * write indication (used for PIO/DMA setup), result TF is
3140 * copied back and we don't whine too much about its failure.
3142 tf->flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
3143 if (scmd->sc_data_direction == DMA_TO_DEVICE)
3144 tf->flags |= ATA_TFLAG_WRITE;
3146 qc->flags |= ATA_QCFLAG_RESULT_TF | ATA_QCFLAG_QUIET;
3149 * Set transfer length.
3151 * TODO: find out if we need to do more here to
3152 * cover scatter/gather case.
3154 ata_qc_set_pc_nbytes(qc);
3156 /* We may not issue DMA commands if no DMA mode is set */
3157 if (tf->protocol == ATA_PROT_DMA && !ata_dma_enabled(dev)) {
3162 /* We may not issue NCQ commands to devices not supporting NCQ */
3163 if (ata_is_ncq(tf->protocol) && !ata_ncq_enabled(dev)) {
3168 /* sanity check for pio multi commands */
3169 if ((cdb[1] & 0xe0) && !is_multi_taskfile(tf)) {
3174 if (is_multi_taskfile(tf)) {
3175 unsigned int multi_count = 1 << (cdb[1] >> 5);
3177 /* compare the passed through multi_count
3178 * with the cached multi_count of libata
3180 if (multi_count != dev->multi_count)
3181 ata_dev_warn(dev, "invalid multi_count %u ignored\n",
3186 * Filter SET_FEATURES - XFER MODE command -- otherwise,
3187 * SET_FEATURES - XFER MODE must be preceded/succeeded
3188 * by an update to hardware-specific registers for each
3189 * controller (i.e. the reason for ->set_piomode(),
3190 * ->set_dmamode(), and ->post_set_mode() hooks).
3192 if (tf->command == ATA_CMD_SET_FEATURES &&
3193 tf->feature == SETFEATURES_XFER) {
3194 fp = (cdb[0] == ATA_16) ? 4 : 3;
3199 * Filter TPM commands by default. These provide an
3200 * essentially uncontrolled encrypted "back door" between
3201 * applications and the disk. Set libata.allow_tpm=1 if you
3202 * have a real reason for wanting to use them. This ensures
3203 * that installed software cannot easily mess stuff up without
3204 * user intent. DVR type users will probably ship with this enabled
3205 * for movie content management.
3207 * Note that for ATA8 we can issue a DCS change and DCS freeze lock
3208 * for this and should do in future but that it is not sufficient as
3209 * DCS is an optional feature set. Thus we also do the software filter
3210 * so that we comply with the TC consortium stated goal that the user
3211 * can turn off TC features of their system.
3213 if (tf->command >= 0x5C && tf->command <= 0x5F && !libata_allow_tpm) {
3214 fp = (cdb[0] == ATA_16) ? 14 : 9;
3221 ata_scsi_set_invalid_field(dev, scmd, fp, 0xff);
3226 * ata_format_dsm_trim_descr() - SATL Write Same to DSM Trim
3227 * @cmd: SCSI command being translated
3228 * @trmax: Maximum number of entries that will fit in sector_size bytes.
3229 * @sector: Starting sector
3230 * @count: Total Range of request in logical sectors
3232 * Rewrite the WRITE SAME descriptor to be a DSM TRIM little-endian formatted
3235 * Upto 64 entries of the format:
3236 * 63:48 Range Length
3239 * Range Length of 0 is ignored.
3240 * LBA's should be sorted order and not overlap.
3242 * NOTE: this is the same format as ADD LBA(S) TO NV CACHE PINNED SET
3244 * Return: Number of bytes copied into sglist.
3246 static size_t ata_format_dsm_trim_descr(struct scsi_cmnd *cmd, u32 trmax,
3247 u64 sector, u32 count)
3249 struct scsi_device *sdp = cmd->device;
3250 size_t len = sdp->sector_size;
3254 unsigned long flags;
3256 WARN_ON(len > ATA_SCSI_RBUF_SIZE);
3258 if (len > ATA_SCSI_RBUF_SIZE)
3259 len = ATA_SCSI_RBUF_SIZE;
3261 spin_lock_irqsave(&ata_scsi_rbuf_lock, flags);
3262 buf = ((void *)ata_scsi_rbuf);
3263 memset(buf, 0, len);
3265 u64 entry = sector |
3266 ((u64)(count > 0xffff ? 0xffff : count) << 48);
3267 buf[i++] = __cpu_to_le64(entry);
3268 if (count <= 0xffff)
3273 r = sg_copy_from_buffer(scsi_sglist(cmd), scsi_sg_count(cmd), buf, len);
3274 spin_unlock_irqrestore(&ata_scsi_rbuf_lock, flags);
3280 * ata_scsi_write_same_xlat() - SATL Write Same to ATA SCT Write Same
3281 * @qc: Command to be translated
3283 * Translate a SCSI WRITE SAME command to be either a DSM TRIM command or
3284 * an SCT Write Same command.
3285 * Based on WRITE SAME has the UNMAP flag:
3287 * - When set translate to DSM TRIM
3288 * - When clear translate to SCT Write Same
3290 static unsigned int ata_scsi_write_same_xlat(struct ata_queued_cmd *qc)
3292 struct ata_taskfile *tf = &qc->tf;
3293 struct scsi_cmnd *scmd = qc->scsicmd;
3294 struct scsi_device *sdp = scmd->device;
3295 size_t len = sdp->sector_size;
3296 struct ata_device *dev = qc->dev;
3297 const u8 *cdb = scmd->cmnd;
3300 const u32 trmax = len >> 3;
3304 u8 unmap = cdb[1] & 0x8;
3306 /* we may not issue DMA commands if no DMA mode is set */
3307 if (unlikely(!ata_dma_enabled(dev)))
3308 goto invalid_opcode;
3311 * We only allow sending this command through the block layer,
3312 * as it modifies the DATA OUT buffer, which would corrupt user
3313 * memory for SG_IO commands.
3315 if (unlikely(blk_rq_is_passthrough(scsi_cmd_to_rq(scmd))))
3316 goto invalid_opcode;
3318 if (unlikely(scmd->cmd_len < 16)) {
3322 scsi_16_lba_len(cdb, &block, &n_block);
3325 (dev->horkage & ATA_HORKAGE_NOTRIM) ||
3326 !ata_id_has_trim(dev->id)) {
3331 /* If the request is too large the cmd is invalid */
3332 if (n_block > 0xffff * trmax) {
3338 * WRITE SAME always has a sector sized buffer as payload, this
3339 * should never be a multiple entry S/G list.
3341 if (!scsi_sg_count(scmd))
3342 goto invalid_param_len;
3345 * size must match sector size in bytes
3346 * For DATA SET MANAGEMENT TRIM in ACS-2 nsect (aka count)
3347 * is defined as number of 512 byte blocks to be transferred.
3350 size = ata_format_dsm_trim_descr(scmd, trmax, block, n_block);
3352 goto invalid_param_len;
3354 if (ata_ncq_enabled(dev) && ata_fpdma_dsm_supported(dev)) {
3355 /* Newer devices support queued TRIM commands */
3356 tf->protocol = ATA_PROT_NCQ;
3357 tf->command = ATA_CMD_FPDMA_SEND;
3358 tf->hob_nsect = ATA_SUBCMD_FPDMA_SEND_DSM & 0x1f;
3359 tf->nsect = qc->hw_tag << 3;
3360 tf->hob_feature = (size / 512) >> 8;
3361 tf->feature = size / 512;
3365 tf->protocol = ATA_PROT_DMA;
3366 tf->hob_feature = 0;
3367 tf->feature = ATA_DSM_TRIM;
3368 tf->hob_nsect = (size / 512) >> 8;
3369 tf->nsect = size / 512;
3370 tf->command = ATA_CMD_DSM;
3373 tf->flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE | ATA_TFLAG_LBA48 |
3376 ata_qc_set_pc_nbytes(qc);
3381 ata_scsi_set_invalid_field(dev, scmd, fp, bp);
3384 /* "Parameter list length error" */
3385 ata_scsi_set_sense(dev, scmd, ILLEGAL_REQUEST, 0x1a, 0x0);
3388 /* "Invalid command operation code" */
3389 ata_scsi_set_sense(dev, scmd, ILLEGAL_REQUEST, 0x20, 0x0);
3394 * ata_scsiop_maint_in - Simulate a subset of MAINTENANCE_IN
3395 * @args: device MAINTENANCE_IN data / SCSI command of interest.
3396 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
3398 * Yields a subset to satisfy scsi_report_opcode()
3401 * spin_lock_irqsave(host lock)
3403 static unsigned int ata_scsiop_maint_in(struct ata_scsi_args *args, u8 *rbuf)
3405 struct ata_device *dev = args->dev;
3406 u8 *cdb = args->cmd->cmnd;
3407 u8 supported = 0, cdlp = 0, rwcdlp = 0;
3408 unsigned int err = 0;
3410 if (cdb[2] != 1 && cdb[2] != 3) {
3411 ata_dev_warn(dev, "invalid command format %d\n", cdb[2]);
3421 case SERVICE_ACTION_IN_16:
3424 case SYNCHRONIZE_CACHE:
3425 case SYNCHRONIZE_CACHE_16:
3429 case TEST_UNIT_READY:
3430 case SEND_DIAGNOSTIC:
3431 case MAINTENANCE_IN:
3441 case MODE_SELECT_10:
3447 if (dev->flags & ATA_DFLAG_CDL) {
3449 * CDL read descriptors map to the T2A page, that is,
3450 * rwcdlp = 0x01 and cdlp = 0x01
3458 if (dev->flags & ATA_DFLAG_CDL) {
3460 * CDL write descriptors map to the T2B page, that is,
3461 * rwcdlp = 0x01 and cdlp = 0x02
3469 if (ata_id_zoned_cap(dev->id) ||
3470 dev->class == ATA_DEV_ZAC)
3473 case SECURITY_PROTOCOL_IN:
3474 case SECURITY_PROTOCOL_OUT:
3475 if (dev->flags & ATA_DFLAG_TRUSTED)
3482 /* One command format */
3484 rbuf[1] = cdlp | supported;
3489 * ata_scsi_report_zones_complete - convert ATA output
3490 * @qc: command structure returning the data
3492 * Convert T-13 little-endian field representation into
3493 * T-10 big-endian field representation.
3496 static void ata_scsi_report_zones_complete(struct ata_queued_cmd *qc)
3498 struct scsi_cmnd *scmd = qc->scsicmd;
3499 struct sg_mapping_iter miter;
3500 unsigned long flags;
3501 unsigned int bytes = 0;
3503 sg_miter_start(&miter, scsi_sglist(scmd), scsi_sg_count(scmd),
3504 SG_MITER_TO_SG | SG_MITER_ATOMIC);
3506 local_irq_save(flags);
3507 while (sg_miter_next(&miter)) {
3508 unsigned int offset = 0;
3513 u64 max_lba, opt_lba;
3516 /* Swizzle header */
3518 list_length = get_unaligned_le32(&hdr[0]);
3519 same = get_unaligned_le16(&hdr[4]);
3520 max_lba = get_unaligned_le64(&hdr[8]);
3521 opt_lba = get_unaligned_le64(&hdr[16]);
3522 put_unaligned_be32(list_length, &hdr[0]);
3523 hdr[4] = same & 0xf;
3524 put_unaligned_be64(max_lba, &hdr[8]);
3525 put_unaligned_be64(opt_lba, &hdr[16]);
3529 while (offset < miter.length) {
3531 u8 cond, type, non_seq, reset;
3532 u64 size, start, wp;
3534 /* Swizzle zone descriptor */
3535 rec = miter.addr + offset;
3536 type = rec[0] & 0xf;
3537 cond = (rec[1] >> 4) & 0xf;
3538 non_seq = (rec[1] & 2);
3539 reset = (rec[1] & 1);
3540 size = get_unaligned_le64(&rec[8]);
3541 start = get_unaligned_le64(&rec[16]);
3542 wp = get_unaligned_le64(&rec[24]);
3544 rec[1] = (cond << 4) | non_seq | reset;
3545 put_unaligned_be64(size, &rec[8]);
3546 put_unaligned_be64(start, &rec[16]);
3547 put_unaligned_be64(wp, &rec[24]);
3548 WARN_ON(offset + 64 > miter.length);
3553 sg_miter_stop(&miter);
3554 local_irq_restore(flags);
3556 ata_scsi_qc_complete(qc);
3559 static unsigned int ata_scsi_zbc_in_xlat(struct ata_queued_cmd *qc)
3561 struct ata_taskfile *tf = &qc->tf;
3562 struct scsi_cmnd *scmd = qc->scsicmd;
3563 const u8 *cdb = scmd->cmnd;
3564 u16 sect, fp = (u16)-1;
3565 u8 sa, options, bp = 0xff;
3569 if (unlikely(scmd->cmd_len < 16)) {
3570 ata_dev_warn(qc->dev, "invalid cdb length %d\n",
3575 scsi_16_lba_len(cdb, &block, &n_block);
3576 if (n_block != scsi_bufflen(scmd)) {
3577 ata_dev_warn(qc->dev, "non-matching transfer count (%d/%d)\n",
3578 n_block, scsi_bufflen(scmd));
3579 goto invalid_param_len;
3582 if (sa != ZI_REPORT_ZONES) {
3583 ata_dev_warn(qc->dev, "invalid service action %d\n", sa);
3588 * ZAC allows only for transfers in 512 byte blocks,
3589 * and uses a 16 bit value for the transfer count.
3591 if ((n_block / 512) > 0xffff || n_block < 512 || (n_block % 512)) {
3592 ata_dev_warn(qc->dev, "invalid transfer count %d\n", n_block);
3593 goto invalid_param_len;
3595 sect = n_block / 512;
3596 options = cdb[14] & 0xbf;
3598 if (ata_ncq_enabled(qc->dev) &&
3599 ata_fpdma_zac_mgmt_in_supported(qc->dev)) {
3600 tf->protocol = ATA_PROT_NCQ;
3601 tf->command = ATA_CMD_FPDMA_RECV;
3602 tf->hob_nsect = ATA_SUBCMD_FPDMA_RECV_ZAC_MGMT_IN & 0x1f;
3603 tf->nsect = qc->hw_tag << 3;
3604 tf->feature = sect & 0xff;
3605 tf->hob_feature = (sect >> 8) & 0xff;
3606 tf->auxiliary = ATA_SUBCMD_ZAC_MGMT_IN_REPORT_ZONES | (options << 8);
3608 tf->command = ATA_CMD_ZAC_MGMT_IN;
3609 tf->feature = ATA_SUBCMD_ZAC_MGMT_IN_REPORT_ZONES;
3610 tf->protocol = ATA_PROT_DMA;
3611 tf->hob_feature = options;
3612 tf->hob_nsect = (sect >> 8) & 0xff;
3613 tf->nsect = sect & 0xff;
3615 tf->device = ATA_LBA;
3616 tf->lbah = (block >> 16) & 0xff;
3617 tf->lbam = (block >> 8) & 0xff;
3618 tf->lbal = block & 0xff;
3619 tf->hob_lbah = (block >> 40) & 0xff;
3620 tf->hob_lbam = (block >> 32) & 0xff;
3621 tf->hob_lbal = (block >> 24) & 0xff;
3623 tf->flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE | ATA_TFLAG_LBA48;
3624 qc->flags |= ATA_QCFLAG_RESULT_TF;
3626 ata_qc_set_pc_nbytes(qc);
3628 qc->complete_fn = ata_scsi_report_zones_complete;
3633 ata_scsi_set_invalid_field(qc->dev, scmd, fp, bp);
3637 /* "Parameter list length error" */
3638 ata_scsi_set_sense(qc->dev, scmd, ILLEGAL_REQUEST, 0x1a, 0x0);
3642 static unsigned int ata_scsi_zbc_out_xlat(struct ata_queued_cmd *qc)
3644 struct ata_taskfile *tf = &qc->tf;
3645 struct scsi_cmnd *scmd = qc->scsicmd;
3646 struct ata_device *dev = qc->dev;
3647 const u8 *cdb = scmd->cmnd;
3653 if (unlikely(scmd->cmd_len < 16)) {
3659 if ((sa != ZO_CLOSE_ZONE) && (sa != ZO_FINISH_ZONE) &&
3660 (sa != ZO_OPEN_ZONE) && (sa != ZO_RESET_WRITE_POINTER)) {
3665 scsi_16_lba_len(cdb, &block, &n_block);
3668 * ZAC MANAGEMENT OUT doesn't define any length
3670 goto invalid_param_len;
3673 all = cdb[14] & 0x1;
3676 * Ignore the block address (zone ID) as defined by ZBC.
3679 } else if (block >= dev->n_sectors) {
3681 * Block must be a valid zone ID (a zone start LBA).
3687 if (ata_ncq_enabled(qc->dev) &&
3688 ata_fpdma_zac_mgmt_out_supported(qc->dev)) {
3689 tf->protocol = ATA_PROT_NCQ_NODATA;
3690 tf->command = ATA_CMD_NCQ_NON_DATA;
3691 tf->feature = ATA_SUBCMD_NCQ_NON_DATA_ZAC_MGMT_OUT;
3692 tf->nsect = qc->hw_tag << 3;
3693 tf->auxiliary = sa | ((u16)all << 8);
3695 tf->protocol = ATA_PROT_NODATA;
3696 tf->command = ATA_CMD_ZAC_MGMT_OUT;
3698 tf->hob_feature = all;
3700 tf->lbah = (block >> 16) & 0xff;
3701 tf->lbam = (block >> 8) & 0xff;
3702 tf->lbal = block & 0xff;
3703 tf->hob_lbah = (block >> 40) & 0xff;
3704 tf->hob_lbam = (block >> 32) & 0xff;
3705 tf->hob_lbal = (block >> 24) & 0xff;
3706 tf->device = ATA_LBA;
3707 tf->flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE | ATA_TFLAG_LBA48;
3712 ata_scsi_set_invalid_field(qc->dev, scmd, fp, 0xff);
3715 /* "Parameter list length error" */
3716 ata_scsi_set_sense(qc->dev, scmd, ILLEGAL_REQUEST, 0x1a, 0x0);
3721 * ata_mselect_caching - Simulate MODE SELECT for caching info page
3722 * @qc: Storage for translated ATA taskfile
3723 * @buf: input buffer
3724 * @len: number of valid bytes in the input buffer
3725 * @fp: out parameter for the failed field on error
3727 * Prepare a taskfile to modify caching information for the device.
3732 static int ata_mselect_caching(struct ata_queued_cmd *qc,
3733 const u8 *buf, int len, u16 *fp)
3735 struct ata_taskfile *tf = &qc->tf;
3736 struct ata_device *dev = qc->dev;
3737 u8 mpage[CACHE_MPAGE_LEN];
3742 * The first two bytes of def_cache_mpage are a header, so offsets
3743 * in mpage are off by 2 compared to buf. Same for len.
3746 if (len != CACHE_MPAGE_LEN - 2) {
3747 *fp = min(len, CACHE_MPAGE_LEN - 2);
3751 wce = buf[0] & (1 << 2);
3754 * Check that read-only bits are not modified.
3756 ata_msense_caching(dev->id, mpage, false);
3757 for (i = 0; i < CACHE_MPAGE_LEN - 2; i++) {
3760 if (mpage[i + 2] != buf[i]) {
3766 tf->flags |= ATA_TFLAG_DEVICE | ATA_TFLAG_ISADDR;
3767 tf->protocol = ATA_PROT_NODATA;
3769 tf->command = ATA_CMD_SET_FEATURES;
3770 tf->feature = wce ? SETFEATURES_WC_ON : SETFEATURES_WC_OFF;
3775 * Simulate MODE SELECT control mode page, sub-page 0.
3777 static int ata_mselect_control_spg0(struct ata_queued_cmd *qc,
3778 const u8 *buf, int len, u16 *fp)
3780 struct ata_device *dev = qc->dev;
3781 u8 mpage[CONTROL_MPAGE_LEN];
3786 * The first two bytes of def_control_mpage are a header, so offsets
3787 * in mpage are off by 2 compared to buf. Same for len.
3790 if (len != CONTROL_MPAGE_LEN - 2) {
3791 *fp = min(len, CONTROL_MPAGE_LEN - 2);
3795 d_sense = buf[0] & (1 << 2);
3798 * Check that read-only bits are not modified.
3800 ata_msense_control_spg0(dev, mpage, false);
3801 for (i = 0; i < CONTROL_MPAGE_LEN - 2; i++) {
3804 if (mpage[2 + i] != buf[i]) {
3809 if (d_sense & (1 << 2))
3810 dev->flags |= ATA_DFLAG_D_SENSE;
3812 dev->flags &= ~ATA_DFLAG_D_SENSE;
3817 * Translate MODE SELECT control mode page, sub-pages f2h (ATA feature mode
3818 * page) into a SET FEATURES command.
3820 static unsigned int ata_mselect_control_ata_feature(struct ata_queued_cmd *qc,
3821 const u8 *buf, int len,
3824 struct ata_device *dev = qc->dev;
3825 struct ata_taskfile *tf = &qc->tf;
3829 * The first four bytes of ATA Feature Control mode page are a header,
3830 * so offsets in mpage are off by 4 compared to buf. Same for len.
3832 if (len != ATA_FEATURE_SUB_MPAGE_LEN - 4) {
3833 *fp = min(len, ATA_FEATURE_SUB_MPAGE_LEN - 4);
3837 /* Check cdl_ctrl */
3838 switch (buf[0] & 0x03) {
3842 dev->flags &= ~ATA_DFLAG_CDL_ENABLED;
3845 /* Enable CDL T2A/T2B: NCQ priority must be disabled */
3846 if (dev->flags & ATA_DFLAG_NCQ_PRIO_ENABLED) {
3848 "NCQ priority must be disabled to enable CDL\n");
3852 dev->flags |= ATA_DFLAG_CDL_ENABLED;
3859 tf->flags |= ATA_TFLAG_DEVICE | ATA_TFLAG_ISADDR;
3860 tf->protocol = ATA_PROT_NODATA;
3861 tf->command = ATA_CMD_SET_FEATURES;
3862 tf->feature = SETFEATURES_CDL;
3863 tf->nsect = cdl_action;
3869 * ata_mselect_control - Simulate MODE SELECT for control page
3870 * @qc: Storage for translated ATA taskfile
3871 * @spg: target sub-page of the control page
3872 * @buf: input buffer
3873 * @len: number of valid bytes in the input buffer
3874 * @fp: out parameter for the failed field on error
3876 * Prepare a taskfile to modify caching information for the device.
3881 static int ata_mselect_control(struct ata_queued_cmd *qc, u8 spg,
3882 const u8 *buf, int len, u16 *fp)
3886 return ata_mselect_control_spg0(qc, buf, len, fp);
3887 case ATA_FEATURE_SUB_MPAGE:
3888 return ata_mselect_control_ata_feature(qc, buf, len, fp);
3895 * ata_scsi_mode_select_xlat - Simulate MODE SELECT 6, 10 commands
3896 * @qc: Storage for translated ATA taskfile
3898 * Converts a MODE SELECT command to an ATA SET FEATURES taskfile.
3899 * Assume this is invoked for direct access devices (e.g. disks) only.
3900 * There should be no block descriptor for other device types.
3903 * spin_lock_irqsave(host lock)
3905 static unsigned int ata_scsi_mode_select_xlat(struct ata_queued_cmd *qc)
3907 struct scsi_cmnd *scmd = qc->scsicmd;
3908 const u8 *cdb = scmd->cmnd;
3910 unsigned six_byte, pg_len, hdr_len, bd_len;
3915 const u8 *p = buffer;
3917 six_byte = (cdb[0] == MODE_SELECT);
3919 if (scmd->cmd_len < 5) {
3927 if (scmd->cmd_len < 9) {
3932 len = get_unaligned_be16(&cdb[7]);
3936 /* We only support PF=1, SP=0. */
3937 if ((cdb[1] & 0x11) != 0x10) {
3939 bp = (cdb[1] & 0x01) ? 1 : 5;
3943 /* Test early for possible overrun. */
3944 if (!scsi_sg_count(scmd) || scsi_sglist(scmd)->length < len)
3945 goto invalid_param_len;
3947 /* Move past header and block descriptors. */
3949 goto invalid_param_len;
3951 if (!sg_copy_to_buffer(scsi_sglist(scmd), scsi_sg_count(scmd),
3952 buffer, sizeof(buffer)))
3953 goto invalid_param_len;
3958 bd_len = get_unaligned_be16(&p[6]);
3963 goto invalid_param_len;
3964 if (bd_len != 0 && bd_len != 8) {
3965 fp = (six_byte) ? 3 : 6;
3966 fp += bd_len + hdr_len;
3975 /* Parse both possible formats for the mode page headers. */
3979 goto invalid_param_len;
3982 pg_len = get_unaligned_be16(&p[2]);
3987 goto invalid_param_len;
3996 * Supported subpages: all subpages and ATA feature sub-page f2h of
4001 case ALL_SUB_MPAGES:
4002 /* All subpages is not supported for the control page */
4003 if (pg == CONTROL_MPAGE) {
4004 fp = (p[0] & 0x40) ? 1 : 0;
4005 fp += hdr_len + bd_len;
4009 case ATA_FEATURE_SUB_MPAGE:
4010 if (qc->dev->flags & ATA_DFLAG_CDL &&
4011 pg == CONTROL_MPAGE)
4015 fp = (p[0] & 0x40) ? 1 : 0;
4016 fp += hdr_len + bd_len;
4021 goto invalid_param_len;
4025 if (ata_mselect_caching(qc, p, pg_len, &fp) < 0) {
4026 fp += hdr_len + bd_len;
4031 ret = ata_mselect_control(qc, spg, p, pg_len, &fp);
4033 fp += hdr_len + bd_len;
4037 goto skip; /* No ATA command to send */
4040 /* Invalid page code */
4041 fp = bd_len + hdr_len;
4046 * Only one page has changeable data, so we only support setting one
4055 ata_scsi_set_invalid_field(qc->dev, scmd, fp, bp);
4059 ata_scsi_set_invalid_parameter(qc->dev, scmd, fp);
4063 /* "Parameter list length error" */
4064 ata_scsi_set_sense(qc->dev, scmd, ILLEGAL_REQUEST, 0x1a, 0x0);
4068 scmd->result = SAM_STAT_GOOD;
4072 static u8 ata_scsi_trusted_op(u32 len, bool send, bool dma)
4075 return ATA_CMD_TRUSTED_NONDATA;
4077 return dma ? ATA_CMD_TRUSTED_SND_DMA : ATA_CMD_TRUSTED_SND;
4079 return dma ? ATA_CMD_TRUSTED_RCV_DMA : ATA_CMD_TRUSTED_RCV;
4082 static unsigned int ata_scsi_security_inout_xlat(struct ata_queued_cmd *qc)
4084 struct scsi_cmnd *scmd = qc->scsicmd;
4085 const u8 *cdb = scmd->cmnd;
4086 struct ata_taskfile *tf = &qc->tf;
4088 bool send = (cdb[0] == SECURITY_PROTOCOL_OUT);
4089 u16 spsp = get_unaligned_be16(&cdb[2]);
4090 u32 len = get_unaligned_be32(&cdb[6]);
4091 bool dma = !(qc->dev->flags & ATA_DFLAG_PIO);
4094 * We don't support the ATA "security" protocol.
4097 ata_scsi_set_invalid_field(qc->dev, scmd, 1, 0);
4101 if (cdb[4] & 7) { /* INC_512 */
4103 ata_scsi_set_invalid_field(qc->dev, scmd, 6, 0);
4107 if (len > 0x01fffe00) {
4108 ata_scsi_set_invalid_field(qc->dev, scmd, 6, 0);
4112 /* convert to the sector-based ATA addressing */
4113 len = (len + 511) / 512;
4116 tf->protocol = dma ? ATA_PROT_DMA : ATA_PROT_PIO;
4117 tf->flags |= ATA_TFLAG_DEVICE | ATA_TFLAG_ISADDR | ATA_TFLAG_LBA;
4119 tf->flags |= ATA_TFLAG_WRITE;
4120 tf->command = ata_scsi_trusted_op(len, send, dma);
4122 tf->lbam = spsp & 0xff;
4123 tf->lbah = spsp >> 8;
4126 tf->nsect = len & 0xff;
4127 tf->lbal = len >> 8;
4130 tf->lbah = (1 << 7);
4133 ata_qc_set_pc_nbytes(qc);
4138 * ata_scsi_var_len_cdb_xlat - SATL variable length CDB to Handler
4139 * @qc: Command to be translated
4141 * Translate a SCSI variable length CDB to specified commands.
4142 * It checks a service action value in CDB to call corresponding handler.
4145 * Zero on success, non-zero on failure
4148 static unsigned int ata_scsi_var_len_cdb_xlat(struct ata_queued_cmd *qc)
4150 struct scsi_cmnd *scmd = qc->scsicmd;
4151 const u8 *cdb = scmd->cmnd;
4152 const u16 sa = get_unaligned_be16(&cdb[8]);
4155 * if service action represents a ata pass-thru(32) command,
4156 * then pass it to ata_scsi_pass_thru handler.
4159 return ata_scsi_pass_thru(qc);
4161 /* unsupported service action */
4166 * ata_get_xlat_func - check if SCSI to ATA translation is possible
4168 * @cmd: SCSI command opcode to consider
4170 * Look up the SCSI command given, and determine whether the
4171 * SCSI command is to be translated or simulated.
4174 * Pointer to translation function if possible, %NULL if not.
4177 static inline ata_xlat_func_t ata_get_xlat_func(struct ata_device *dev, u8 cmd)
4187 return ata_scsi_rw_xlat;
4190 return ata_scsi_write_same_xlat;
4192 case SYNCHRONIZE_CACHE:
4193 case SYNCHRONIZE_CACHE_16:
4194 if (ata_try_flush_cache(dev))
4195 return ata_scsi_flush_xlat;
4200 return ata_scsi_verify_xlat;
4204 return ata_scsi_pass_thru;
4206 case VARIABLE_LENGTH_CMD:
4207 return ata_scsi_var_len_cdb_xlat;
4210 case MODE_SELECT_10:
4211 return ata_scsi_mode_select_xlat;
4214 return ata_scsi_zbc_in_xlat;
4217 return ata_scsi_zbc_out_xlat;
4219 case SECURITY_PROTOCOL_IN:
4220 case SECURITY_PROTOCOL_OUT:
4221 if (!(dev->flags & ATA_DFLAG_TRUSTED))
4223 return ata_scsi_security_inout_xlat;
4226 return ata_scsi_start_stop_xlat;
4232 int __ata_scsi_queuecmd(struct scsi_cmnd *scmd, struct ata_device *dev)
4234 struct ata_port *ap = dev->link->ap;
4235 u8 scsi_op = scmd->cmnd[0];
4236 ata_xlat_func_t xlat_func;
4239 * scsi_queue_rq() will defer commands if scsi_host_in_recovery().
4240 * However, this check is done without holding the ap->lock (a libata
4241 * specific lock), so we can have received an error irq since then,
4242 * therefore we must check if EH is pending, while holding ap->lock.
4244 if (ap->pflags & (ATA_PFLAG_EH_PENDING | ATA_PFLAG_EH_IN_PROGRESS))
4245 return SCSI_MLQUEUE_DEVICE_BUSY;
4247 if (unlikely(!scmd->cmd_len))
4250 if (dev->class == ATA_DEV_ATA || dev->class == ATA_DEV_ZAC) {
4251 if (unlikely(scmd->cmd_len > dev->cdb_len))
4254 xlat_func = ata_get_xlat_func(dev, scsi_op);
4255 } else if (likely((scsi_op != ATA_16) || !atapi_passthru16)) {
4256 /* relay SCSI command to ATAPI device */
4257 int len = COMMAND_SIZE(scsi_op);
4259 if (unlikely(len > scmd->cmd_len ||
4260 len > dev->cdb_len ||
4261 scmd->cmd_len > ATAPI_CDB_LEN))
4264 xlat_func = atapi_xlat;
4266 /* ATA_16 passthru, treat as an ATA command */
4267 if (unlikely(scmd->cmd_len > 16))
4270 xlat_func = ata_get_xlat_func(dev, scsi_op);
4274 return ata_scsi_translate(dev, scmd, xlat_func);
4276 ata_scsi_simulate(dev, scmd);
4281 scmd->result = DID_ERROR << 16;
4287 * ata_scsi_queuecmd - Issue SCSI cdb to libata-managed device
4288 * @shost: SCSI host of command to be sent
4289 * @cmd: SCSI command to be sent
4291 * In some cases, this function translates SCSI commands into
4292 * ATA taskfiles, and queues the taskfiles to be sent to
4293 * hardware. In other cases, this function simulates a
4294 * SCSI device by evaluating and responding to certain
4295 * SCSI commands. This creates the overall effect of
4296 * ATA and ATAPI devices appearing as SCSI devices.
4302 * Return value from __ata_scsi_queuecmd() if @cmd can be queued,
4305 int ata_scsi_queuecmd(struct Scsi_Host *shost, struct scsi_cmnd *cmd)
4307 struct ata_port *ap;
4308 struct ata_device *dev;
4309 struct scsi_device *scsidev = cmd->device;
4311 unsigned long irq_flags;
4313 ap = ata_shost_to_port(shost);
4315 spin_lock_irqsave(ap->lock, irq_flags);
4317 dev = ata_scsi_find_dev(ap, scsidev);
4319 rc = __ata_scsi_queuecmd(cmd, dev);
4321 cmd->result = (DID_BAD_TARGET << 16);
4325 spin_unlock_irqrestore(ap->lock, irq_flags);
4329 EXPORT_SYMBOL_GPL(ata_scsi_queuecmd);
4332 * ata_scsi_simulate - simulate SCSI command on ATA device
4333 * @dev: the target device
4334 * @cmd: SCSI command being sent to device.
4336 * Interprets and directly executes a select list of SCSI commands
4337 * that can be handled internally.
4340 * spin_lock_irqsave(host lock)
4343 void ata_scsi_simulate(struct ata_device *dev, struct scsi_cmnd *cmd)
4345 struct ata_scsi_args args;
4346 const u8 *scsicmd = cmd->cmnd;
4353 switch(scsicmd[0]) {
4355 if (scsicmd[1] & 2) /* is CmdDt set? */
4356 ata_scsi_set_invalid_field(dev, cmd, 1, 0xff);
4357 else if ((scsicmd[1] & 1) == 0) /* is EVPD clear? */
4358 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_std);
4359 else switch (scsicmd[2]) {
4361 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_00);
4364 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_80);
4367 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_83);
4370 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_89);
4373 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_b0);
4376 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_b1);
4379 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_b2);
4382 if (dev->flags & ATA_DFLAG_ZAC)
4383 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_b6);
4385 ata_scsi_set_invalid_field(dev, cmd, 2, 0xff);
4389 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_b9);
4391 ata_scsi_set_invalid_field(dev, cmd, 2, 0xff);
4394 ata_scsi_set_invalid_field(dev, cmd, 2, 0xff);
4401 ata_scsi_rbuf_fill(&args, ata_scsiop_mode_sense);
4405 ata_scsi_rbuf_fill(&args, ata_scsiop_read_cap);
4408 case SERVICE_ACTION_IN_16:
4409 if ((scsicmd[1] & 0x1f) == SAI_READ_CAPACITY_16)
4410 ata_scsi_rbuf_fill(&args, ata_scsiop_read_cap);
4412 ata_scsi_set_invalid_field(dev, cmd, 1, 0xff);
4416 ata_scsi_rbuf_fill(&args, ata_scsiop_report_luns);
4420 ata_scsi_set_sense(dev, cmd, 0, 0, 0);
4423 /* if we reach this, then writeback caching is disabled,
4424 * turning this into a no-op.
4426 case SYNCHRONIZE_CACHE:
4427 case SYNCHRONIZE_CACHE_16:
4430 /* no-op's, complete with success */
4434 case TEST_UNIT_READY:
4437 case SEND_DIAGNOSTIC:
4438 tmp8 = scsicmd[1] & ~(1 << 3);
4439 if (tmp8 != 0x4 || scsicmd[3] || scsicmd[4])
4440 ata_scsi_set_invalid_field(dev, cmd, 1, 0xff);
4443 case MAINTENANCE_IN:
4444 if (scsicmd[1] == MI_REPORT_SUPPORTED_OPERATION_CODES)
4445 ata_scsi_rbuf_fill(&args, ata_scsiop_maint_in);
4447 ata_scsi_set_invalid_field(dev, cmd, 1, 0xff);
4450 /* all other commands */
4452 ata_scsi_set_sense(dev, cmd, ILLEGAL_REQUEST, 0x20, 0x0);
4453 /* "Invalid command operation code" */
4460 int ata_scsi_add_hosts(struct ata_host *host, const struct scsi_host_template *sht)
4464 for (i = 0; i < host->n_ports; i++) {
4465 struct ata_port *ap = host->ports[i];
4466 struct Scsi_Host *shost;
4469 shost = scsi_host_alloc(sht, sizeof(struct ata_port *));
4473 shost->eh_noresume = 1;
4474 *(struct ata_port **)&shost->hostdata[0] = ap;
4475 ap->scsi_host = shost;
4477 shost->transportt = ata_scsi_transport_template;
4478 shost->unique_id = ap->print_id;
4481 shost->max_channel = 1;
4482 shost->max_cmd_len = 32;
4484 /* Schedule policy is determined by ->qc_defer()
4485 * callback and it needs to see every deferred qc.
4486 * Set host_blocked to 1 to prevent SCSI midlayer from
4487 * automatically deferring requests.
4489 shost->max_host_blocked = 1;
4491 rc = scsi_add_host_with_dma(shost, &ap->tdev, ap->host->dev);
4500 struct Scsi_Host *shost = host->ports[i]->scsi_host;
4502 /* scsi_host_put() is in ata_devres_release() */
4503 scsi_remove_host(shost);
4509 static void ata_scsi_assign_ofnode(struct ata_device *dev, struct ata_port *ap)
4511 struct scsi_device *sdev = dev->sdev;
4512 struct device *d = ap->host->dev;
4513 struct device_node *np = d->of_node;
4514 struct device_node *child;
4516 for_each_available_child_of_node(np, child) {
4520 ret = of_property_read_u32(child, "reg", &val);
4523 if (val == dev->devno) {
4524 dev_dbg(d, "found matching device node\n");
4525 sdev->sdev_gendev.of_node = child;
4531 static void ata_scsi_assign_ofnode(struct ata_device *dev, struct ata_port *ap)
4536 void ata_scsi_scan_host(struct ata_port *ap, int sync)
4539 struct ata_device *last_failed_dev = NULL;
4540 struct ata_link *link;
4541 struct ata_device *dev;
4544 ata_for_each_link(link, ap, EDGE) {
4545 ata_for_each_dev(dev, link, ENABLED) {
4546 struct scsi_device *sdev;
4547 int channel = 0, id = 0;
4552 if (ata_is_host_link(link))
4555 channel = link->pmp;
4557 sdev = __scsi_add_device(ap->scsi_host, channel, id, 0,
4559 if (!IS_ERR(sdev)) {
4561 ata_scsi_assign_ofnode(dev, ap);
4562 scsi_device_put(sdev);
4569 /* If we scanned while EH was in progress or allocation
4570 * failure occurred, scan would have failed silently. Check
4571 * whether all devices are attached.
4573 ata_for_each_link(link, ap, EDGE) {
4574 ata_for_each_dev(dev, link, ENABLED) {
4583 /* we're missing some SCSI devices */
4585 /* If caller requested synchrnous scan && we've made
4586 * any progress, sleep briefly and repeat.
4588 if (dev != last_failed_dev) {
4590 last_failed_dev = dev;
4594 /* We might be failing to detect boot device, give it
4595 * a few more chances.
4603 "WARNING: synchronous SCSI scan failed without making any progress, switching to async\n");
4606 queue_delayed_work(system_long_wq, &ap->hotplug_task,
4607 round_jiffies_relative(HZ));
4611 * ata_scsi_offline_dev - offline attached SCSI device
4612 * @dev: ATA device to offline attached SCSI device for
4614 * This function is called from ata_eh_hotplug() and responsible
4615 * for taking the SCSI device attached to @dev offline. This
4616 * function is called with host lock which protects dev->sdev
4620 * spin_lock_irqsave(host lock)
4623 * 1 if attached SCSI device exists, 0 otherwise.
4625 int ata_scsi_offline_dev(struct ata_device *dev)
4628 scsi_device_set_state(dev->sdev, SDEV_OFFLINE);
4635 * ata_scsi_remove_dev - remove attached SCSI device
4636 * @dev: ATA device to remove attached SCSI device for
4638 * This function is called from ata_eh_scsi_hotplug() and
4639 * responsible for removing the SCSI device attached to @dev.
4642 * Kernel thread context (may sleep).
4644 static void ata_scsi_remove_dev(struct ata_device *dev)
4646 struct ata_port *ap = dev->link->ap;
4647 struct scsi_device *sdev;
4648 unsigned long flags;
4650 /* Alas, we need to grab scan_mutex to ensure SCSI device
4651 * state doesn't change underneath us and thus
4652 * scsi_device_get() always succeeds. The mutex locking can
4653 * be removed if there is __scsi_device_get() interface which
4654 * increments reference counts regardless of device state.
4656 mutex_lock(&ap->scsi_host->scan_mutex);
4657 spin_lock_irqsave(ap->lock, flags);
4659 /* clearing dev->sdev is protected by host lock */
4664 /* If user initiated unplug races with us, sdev can go
4665 * away underneath us after the host lock and
4666 * scan_mutex are released. Hold onto it.
4668 if (scsi_device_get(sdev) == 0) {
4669 /* The following ensures the attached sdev is
4670 * offline on return from ata_scsi_offline_dev()
4671 * regardless it wins or loses the race
4672 * against this function.
4674 scsi_device_set_state(sdev, SDEV_OFFLINE);
4681 spin_unlock_irqrestore(ap->lock, flags);
4682 mutex_unlock(&ap->scsi_host->scan_mutex);
4685 ata_dev_info(dev, "detaching (SCSI %s)\n",
4686 dev_name(&sdev->sdev_gendev));
4688 scsi_remove_device(sdev);
4689 scsi_device_put(sdev);
4693 static void ata_scsi_handle_link_detach(struct ata_link *link)
4695 struct ata_port *ap = link->ap;
4696 struct ata_device *dev;
4698 ata_for_each_dev(dev, link, ALL) {
4699 unsigned long flags;
4701 if (!(dev->flags & ATA_DFLAG_DETACHED))
4704 spin_lock_irqsave(ap->lock, flags);
4705 dev->flags &= ~ATA_DFLAG_DETACHED;
4706 spin_unlock_irqrestore(ap->lock, flags);
4708 if (zpodd_dev_enabled(dev))
4711 ata_scsi_remove_dev(dev);
4716 * ata_scsi_media_change_notify - send media change event
4717 * @dev: Pointer to the disk device with media change event
4719 * Tell the block layer to send a media change notification
4723 * spin_lock_irqsave(host lock)
4725 void ata_scsi_media_change_notify(struct ata_device *dev)
4728 sdev_evt_send_simple(dev->sdev, SDEV_EVT_MEDIA_CHANGE,
4733 * ata_scsi_hotplug - SCSI part of hotplug
4734 * @work: Pointer to ATA port to perform SCSI hotplug on
4736 * Perform SCSI part of hotplug. It's executed from a separate
4737 * workqueue after EH completes. This is necessary because SCSI
4738 * hot plugging requires working EH and hot unplugging is
4739 * synchronized with hot plugging with a mutex.
4742 * Kernel thread context (may sleep).
4744 void ata_scsi_hotplug(struct work_struct *work)
4746 struct ata_port *ap =
4747 container_of(work, struct ata_port, hotplug_task.work);
4750 if (ap->pflags & ATA_PFLAG_UNLOADING)
4753 mutex_lock(&ap->scsi_scan_mutex);
4755 /* Unplug detached devices. We cannot use link iterator here
4756 * because PMP links have to be scanned even if PMP is
4757 * currently not attached. Iterate manually.
4759 ata_scsi_handle_link_detach(&ap->link);
4761 for (i = 0; i < SATA_PMP_MAX_PORTS; i++)
4762 ata_scsi_handle_link_detach(&ap->pmp_link[i]);
4764 /* scan for new ones */
4765 ata_scsi_scan_host(ap, 0);
4767 mutex_unlock(&ap->scsi_scan_mutex);
4771 * ata_scsi_user_scan - indication for user-initiated bus scan
4772 * @shost: SCSI host to scan
4773 * @channel: Channel to scan
4777 * This function is called when user explicitly requests bus
4778 * scan. Set probe pending flag and invoke EH.
4781 * SCSI layer (we don't care)
4786 int ata_scsi_user_scan(struct Scsi_Host *shost, unsigned int channel,
4787 unsigned int id, u64 lun)
4789 struct ata_port *ap = ata_shost_to_port(shost);
4790 unsigned long flags;
4793 if (!ap->ops->error_handler)
4796 if (lun != SCAN_WILD_CARD && lun)
4799 if (!sata_pmp_attached(ap)) {
4800 if (channel != SCAN_WILD_CARD && channel)
4804 if (id != SCAN_WILD_CARD && id)
4809 spin_lock_irqsave(ap->lock, flags);
4811 if (devno == SCAN_WILD_CARD) {
4812 struct ata_link *link;
4814 ata_for_each_link(link, ap, EDGE) {
4815 struct ata_eh_info *ehi = &link->eh_info;
4816 ehi->probe_mask |= ATA_ALL_DEVICES;
4817 ehi->action |= ATA_EH_RESET;
4820 struct ata_device *dev = ata_find_dev(ap, devno);
4823 struct ata_eh_info *ehi = &dev->link->eh_info;
4824 ehi->probe_mask |= 1 << dev->devno;
4825 ehi->action |= ATA_EH_RESET;
4831 ata_port_schedule_eh(ap);
4832 spin_unlock_irqrestore(ap->lock, flags);
4833 ata_port_wait_eh(ap);
4835 spin_unlock_irqrestore(ap->lock, flags);
4841 * ata_scsi_dev_rescan - initiate scsi_rescan_device()
4842 * @work: Pointer to ATA port to perform scsi_rescan_device()
4844 * After ATA pass thru (SAT) commands are executed successfully,
4845 * libata need to propagate the changes to SCSI layer.
4848 * Kernel thread context (may sleep).
4850 void ata_scsi_dev_rescan(struct work_struct *work)
4852 struct ata_port *ap =
4853 container_of(work, struct ata_port, scsi_rescan_task.work);
4854 struct ata_link *link;
4855 struct ata_device *dev;
4856 unsigned long flags;
4857 bool delay_rescan = false;
4859 mutex_lock(&ap->scsi_scan_mutex);
4860 spin_lock_irqsave(ap->lock, flags);
4862 ata_for_each_link(link, ap, EDGE) {
4863 ata_for_each_dev(dev, link, ENABLED) {
4864 struct scsi_device *sdev = dev->sdev;
4868 if (scsi_device_get(sdev))
4872 * If the rescan work was scheduled because of a resume
4873 * event, the port is already fully resumed, but the
4874 * SCSI device may not yet be fully resumed. In such
4875 * case, executing scsi_rescan_device() may cause a
4876 * deadlock with the PM code on device_lock(). Prevent
4877 * this by giving up and retrying rescan after a short
4880 delay_rescan = sdev->sdev_gendev.power.is_suspended;
4882 scsi_device_put(sdev);
4886 spin_unlock_irqrestore(ap->lock, flags);
4887 scsi_rescan_device(&(sdev->sdev_gendev));
4888 scsi_device_put(sdev);
4889 spin_lock_irqsave(ap->lock, flags);
4893 spin_unlock_irqrestore(ap->lock, flags);
4894 mutex_unlock(&ap->scsi_scan_mutex);
4897 schedule_delayed_work(&ap->scsi_rescan_task,
4898 msecs_to_jiffies(5));