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);
1104 * Stop the drive on suspend but do not issue START STOP UNIT
1105 * on resume as this is not necessary and may fail: the device
1106 * will be woken up by ata_port_pm_resume() with a port reset
1107 * and device revalidation.
1109 sdev->manage_start_stop = 1;
1110 sdev->no_start_on_resume = 1;
1114 * ata_pio_sectors() expects buffer for each sector to not cross
1115 * page boundary. Enforce it by requiring buffers to be sector
1116 * aligned, which works iff sector_size is not larger than
1117 * PAGE_SIZE. ATAPI devices also need the alignment as
1118 * IDENTIFY_PACKET is executed as ATA_PROT_PIO.
1120 if (sdev->sector_size > PAGE_SIZE)
1122 "sector_size=%u > PAGE_SIZE, PIO may malfunction\n",
1125 blk_queue_update_dma_alignment(q, sdev->sector_size - 1);
1127 if (dev->flags & ATA_DFLAG_AN)
1128 set_bit(SDEV_EVT_MEDIA_CHANGE, sdev->supported_events);
1130 if (ata_ncq_supported(dev))
1131 depth = min(sdev->host->can_queue, ata_id_queue_depth(dev->id));
1132 depth = min(ATA_MAX_QUEUE, depth);
1133 scsi_change_queue_depth(sdev, depth);
1135 if (dev->flags & ATA_DFLAG_TRUSTED)
1136 sdev->security_supported = 1;
1143 * ata_scsi_slave_config - Set SCSI device attributes
1144 * @sdev: SCSI device to examine
1146 * This is called before we actually start reading
1147 * and writing to the device, to configure certain
1148 * SCSI mid-layer behaviors.
1151 * Defined by SCSI layer. We don't really care.
1154 int ata_scsi_slave_config(struct scsi_device *sdev)
1156 struct ata_port *ap = ata_shost_to_port(sdev->host);
1157 struct ata_device *dev = __ata_scsi_find_dev(ap, sdev);
1160 ata_scsi_sdev_config(sdev);
1163 rc = ata_scsi_dev_config(sdev, dev);
1167 EXPORT_SYMBOL_GPL(ata_scsi_slave_config);
1170 * ata_scsi_slave_destroy - SCSI device is about to be destroyed
1171 * @sdev: SCSI device to be destroyed
1173 * @sdev is about to be destroyed for hot/warm unplugging. If
1174 * this unplugging was initiated by libata as indicated by NULL
1175 * dev->sdev, this function doesn't have to do anything.
1176 * Otherwise, SCSI layer initiated warm-unplug is in progress.
1177 * Clear dev->sdev, schedule the device for ATA detach and invoke
1181 * Defined by SCSI layer. We don't really care.
1183 void ata_scsi_slave_destroy(struct scsi_device *sdev)
1185 struct ata_port *ap = ata_shost_to_port(sdev->host);
1186 unsigned long flags;
1187 struct ata_device *dev;
1189 if (!ap->ops->error_handler)
1192 spin_lock_irqsave(ap->lock, flags);
1193 dev = __ata_scsi_find_dev(ap, sdev);
1194 if (dev && dev->sdev) {
1195 /* SCSI device already in CANCEL state, no need to offline it */
1197 dev->flags |= ATA_DFLAG_DETACH;
1198 ata_port_schedule_eh(ap);
1200 spin_unlock_irqrestore(ap->lock, flags);
1202 kfree(sdev->dma_drain_buf);
1204 EXPORT_SYMBOL_GPL(ata_scsi_slave_destroy);
1207 * ata_scsi_start_stop_xlat - Translate SCSI START STOP UNIT command
1208 * @qc: Storage for translated ATA taskfile
1210 * Sets up an ATA taskfile to issue STANDBY (to stop) or READ VERIFY
1211 * (to start). Perhaps these commands should be preceded by
1212 * CHECK POWER MODE to see what power mode the device is already in.
1213 * [See SAT revision 5 at www.t10.org]
1216 * spin_lock_irqsave(host lock)
1219 * Zero on success, non-zero on error.
1221 static unsigned int ata_scsi_start_stop_xlat(struct ata_queued_cmd *qc)
1223 struct scsi_cmnd *scmd = qc->scsicmd;
1224 struct ata_taskfile *tf = &qc->tf;
1225 const u8 *cdb = scmd->cmnd;
1229 if (scmd->cmd_len < 5) {
1234 tf->flags |= ATA_TFLAG_DEVICE | ATA_TFLAG_ISADDR;
1235 tf->protocol = ATA_PROT_NODATA;
1237 ; /* ignore IMMED bit, violates sat-r05 */
1242 goto invalid_fld; /* LOEJ bit set not supported */
1244 if (((cdb[4] >> 4) & 0xf) != 0) {
1247 goto invalid_fld; /* power conditions not supported */
1251 tf->nsect = 1; /* 1 sector, lba=0 */
1253 if (qc->dev->flags & ATA_DFLAG_LBA) {
1254 tf->flags |= ATA_TFLAG_LBA;
1259 tf->device |= ATA_LBA;
1262 tf->lbal = 0x1; /* sect */
1263 tf->lbam = 0x0; /* cyl low */
1264 tf->lbah = 0x0; /* cyl high */
1267 tf->command = ATA_CMD_VERIFY; /* READ VERIFY */
1269 /* Some odd clown BIOSen issue spindown on power off (ACPI S4
1270 * or S5) causing some drives to spin up and down again.
1272 if ((qc->ap->flags & ATA_FLAG_NO_POWEROFF_SPINDOWN) &&
1273 system_state == SYSTEM_POWER_OFF)
1276 if ((qc->ap->flags & ATA_FLAG_NO_HIBERNATE_SPINDOWN) &&
1277 system_entering_hibernation())
1280 /* Issue ATA STANDBY IMMEDIATE command */
1281 tf->command = ATA_CMD_STANDBYNOW1;
1285 * Standby and Idle condition timers could be implemented but that
1286 * would require libata to implement the Power condition mode page
1287 * and allow the user to change it. Changing mode pages requires
1288 * MODE SELECT to be implemented.
1294 ata_scsi_set_invalid_field(qc->dev, scmd, fp, bp);
1297 scmd->result = SAM_STAT_GOOD;
1303 * ata_scsi_flush_xlat - Translate SCSI SYNCHRONIZE CACHE command
1304 * @qc: Storage for translated ATA taskfile
1306 * Sets up an ATA taskfile to issue FLUSH CACHE or
1310 * spin_lock_irqsave(host lock)
1313 * Zero on success, non-zero on error.
1315 static unsigned int ata_scsi_flush_xlat(struct ata_queued_cmd *qc)
1317 struct ata_taskfile *tf = &qc->tf;
1319 tf->flags |= ATA_TFLAG_DEVICE;
1320 tf->protocol = ATA_PROT_NODATA;
1322 if (qc->dev->flags & ATA_DFLAG_FLUSH_EXT)
1323 tf->command = ATA_CMD_FLUSH_EXT;
1325 tf->command = ATA_CMD_FLUSH;
1327 /* flush is critical for IO integrity, consider it an IO command */
1328 qc->flags |= ATA_QCFLAG_IO;
1334 * scsi_6_lba_len - Get LBA and transfer length
1335 * @cdb: SCSI command to translate
1337 * Calculate LBA and transfer length for 6-byte commands.
1341 * @plen: the transfer length
1343 static void scsi_6_lba_len(const u8 *cdb, u64 *plba, u32 *plen)
1348 lba |= ((u64)(cdb[1] & 0x1f)) << 16;
1349 lba |= ((u64)cdb[2]) << 8;
1350 lba |= ((u64)cdb[3]);
1359 * scsi_10_lba_len - Get LBA and transfer length
1360 * @cdb: SCSI command to translate
1362 * Calculate LBA and transfer length for 10-byte commands.
1366 * @plen: the transfer length
1368 static inline void scsi_10_lba_len(const u8 *cdb, u64 *plba, u32 *plen)
1370 *plba = get_unaligned_be32(&cdb[2]);
1371 *plen = get_unaligned_be16(&cdb[7]);
1375 * scsi_16_lba_len - Get LBA and transfer length
1376 * @cdb: SCSI command to translate
1378 * Calculate LBA and transfer length for 16-byte commands.
1382 * @plen: the transfer length
1384 static inline void scsi_16_lba_len(const u8 *cdb, u64 *plba, u32 *plen)
1386 *plba = get_unaligned_be64(&cdb[2]);
1387 *plen = get_unaligned_be32(&cdb[10]);
1391 * scsi_dld - Get duration limit descriptor index
1392 * @cdb: SCSI command to translate
1394 * Returns the dld bits indicating the index of a command duration limit
1397 static inline int scsi_dld(const u8 *cdb)
1399 return ((cdb[1] & 0x01) << 2) | ((cdb[14] >> 6) & 0x03);
1403 * ata_scsi_verify_xlat - Translate SCSI VERIFY command into an ATA one
1404 * @qc: Storage for translated ATA taskfile
1406 * Converts SCSI VERIFY command to an ATA READ VERIFY command.
1409 * spin_lock_irqsave(host lock)
1412 * Zero on success, non-zero on error.
1414 static unsigned int ata_scsi_verify_xlat(struct ata_queued_cmd *qc)
1416 struct scsi_cmnd *scmd = qc->scsicmd;
1417 struct ata_taskfile *tf = &qc->tf;
1418 struct ata_device *dev = qc->dev;
1419 u64 dev_sectors = qc->dev->n_sectors;
1420 const u8 *cdb = scmd->cmnd;
1425 tf->flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
1426 tf->protocol = ATA_PROT_NODATA;
1430 if (scmd->cmd_len < 10) {
1434 scsi_10_lba_len(cdb, &block, &n_block);
1437 if (scmd->cmd_len < 16) {
1441 scsi_16_lba_len(cdb, &block, &n_block);
1450 if (block >= dev_sectors)
1452 if ((block + n_block) > dev_sectors)
1455 if (dev->flags & ATA_DFLAG_LBA) {
1456 tf->flags |= ATA_TFLAG_LBA;
1458 if (lba_28_ok(block, n_block)) {
1460 tf->command = ATA_CMD_VERIFY;
1461 tf->device |= (block >> 24) & 0xf;
1462 } else if (lba_48_ok(block, n_block)) {
1463 if (!(dev->flags & ATA_DFLAG_LBA48))
1467 tf->flags |= ATA_TFLAG_LBA48;
1468 tf->command = ATA_CMD_VERIFY_EXT;
1470 tf->hob_nsect = (n_block >> 8) & 0xff;
1472 tf->hob_lbah = (block >> 40) & 0xff;
1473 tf->hob_lbam = (block >> 32) & 0xff;
1474 tf->hob_lbal = (block >> 24) & 0xff;
1476 /* request too large even for LBA48 */
1479 tf->nsect = n_block & 0xff;
1481 tf->lbah = (block >> 16) & 0xff;
1482 tf->lbam = (block >> 8) & 0xff;
1483 tf->lbal = block & 0xff;
1485 tf->device |= ATA_LBA;
1488 u32 sect, head, cyl, track;
1490 if (!lba_28_ok(block, n_block))
1493 /* Convert LBA to CHS */
1494 track = (u32)block / dev->sectors;
1495 cyl = track / dev->heads;
1496 head = track % dev->heads;
1497 sect = (u32)block % dev->sectors + 1;
1499 /* Check whether the converted CHS can fit.
1503 if ((cyl >> 16) || (head >> 4) || (sect >> 8) || (!sect))
1506 tf->command = ATA_CMD_VERIFY;
1507 tf->nsect = n_block & 0xff; /* Sector count 0 means 256 sectors */
1510 tf->lbah = cyl >> 8;
1517 ata_scsi_set_invalid_field(qc->dev, scmd, fp, 0xff);
1521 ata_scsi_set_sense(qc->dev, scmd, ILLEGAL_REQUEST, 0x21, 0x0);
1522 /* "Logical Block Address out of range" */
1526 scmd->result = SAM_STAT_GOOD;
1530 static bool ata_check_nblocks(struct scsi_cmnd *scmd, u32 n_blocks)
1532 struct request *rq = scsi_cmd_to_rq(scmd);
1535 if (!blk_rq_is_passthrough(rq))
1538 req_blocks = blk_rq_bytes(rq) / scmd->device->sector_size;
1539 if (n_blocks > req_blocks)
1546 * ata_scsi_rw_xlat - Translate SCSI r/w command into an ATA one
1547 * @qc: Storage for translated ATA taskfile
1549 * Converts any of six SCSI read/write commands into the
1550 * ATA counterpart, including starting sector (LBA),
1551 * sector count, and taking into account the device's LBA48
1554 * Commands %READ_6, %READ_10, %READ_16, %WRITE_6, %WRITE_10, and
1555 * %WRITE_16 are currently supported.
1558 * spin_lock_irqsave(host lock)
1561 * Zero on success, non-zero on error.
1563 static unsigned int ata_scsi_rw_xlat(struct ata_queued_cmd *qc)
1565 struct scsi_cmnd *scmd = qc->scsicmd;
1566 const u8 *cdb = scmd->cmnd;
1567 struct request *rq = scsi_cmd_to_rq(scmd);
1568 int class = IOPRIO_PRIO_CLASS(req_get_ioprio(rq));
1569 unsigned int tf_flags = 0;
1580 tf_flags |= ATA_TFLAG_WRITE;
1584 /* Calculate the SCSI LBA, transfer length and FUA. */
1588 if (unlikely(scmd->cmd_len < 10)) {
1592 scsi_10_lba_len(cdb, &block, &n_block);
1593 if (cdb[1] & (1 << 3))
1594 tf_flags |= ATA_TFLAG_FUA;
1595 if (!ata_check_nblocks(scmd, n_block))
1600 if (unlikely(scmd->cmd_len < 6)) {
1604 scsi_6_lba_len(cdb, &block, &n_block);
1606 /* for 6-byte r/w commands, transfer length 0
1607 * means 256 blocks of data, not 0 block.
1611 if (!ata_check_nblocks(scmd, n_block))
1616 if (unlikely(scmd->cmd_len < 16)) {
1620 scsi_16_lba_len(cdb, &block, &n_block);
1621 dld = scsi_dld(cdb);
1622 if (cdb[1] & (1 << 3))
1623 tf_flags |= ATA_TFLAG_FUA;
1624 if (!ata_check_nblocks(scmd, n_block))
1632 /* Check and compose ATA command */
1634 /* For 10-byte and 16-byte SCSI R/W commands, transfer
1635 * length 0 means transfer 0 block of data.
1636 * However, for ATA R/W commands, sector count 0 means
1637 * 256 or 65536 sectors, not 0 sectors as in SCSI.
1639 * WARNING: one or two older ATA drives treat 0 as 0...
1643 qc->flags |= ATA_QCFLAG_IO;
1644 qc->nbytes = n_block * scmd->device->sector_size;
1646 rc = ata_build_rw_tf(qc, block, n_block, tf_flags, dld, class);
1647 if (likely(rc == 0))
1652 /* treat all other errors as -EINVAL, fall through */
1654 ata_scsi_set_invalid_field(qc->dev, scmd, fp, 0xff);
1658 ata_scsi_set_sense(qc->dev, scmd, ILLEGAL_REQUEST, 0x21, 0x0);
1659 /* "Logical Block Address out of range" */
1663 scmd->result = SAM_STAT_GOOD;
1667 static void ata_qc_done(struct ata_queued_cmd *qc)
1669 struct scsi_cmnd *cmd = qc->scsicmd;
1670 void (*done)(struct scsi_cmnd *) = qc->scsidone;
1676 static void ata_scsi_qc_complete(struct ata_queued_cmd *qc)
1678 struct ata_port *ap = qc->ap;
1679 struct scsi_cmnd *cmd = qc->scsicmd;
1680 u8 *cdb = cmd->cmnd;
1681 int need_sense = (qc->err_mask != 0) &&
1682 !(qc->flags & ATA_QCFLAG_SENSE_VALID);
1684 /* For ATA pass thru (SAT) commands, generate a sense block if
1685 * user mandated it or if there's an error. Note that if we
1686 * generate because the user forced us to [CK_COND =1], a check
1687 * condition is generated and the ATA register values are returned
1688 * whether the command completed successfully or not. If there
1689 * was no error, we use the following sense data:
1690 * sk = RECOVERED ERROR
1691 * asc,ascq = ATA PASS-THROUGH INFORMATION AVAILABLE
1693 if (((cdb[0] == ATA_16) || (cdb[0] == ATA_12)) &&
1694 ((cdb[2] & 0x20) || need_sense))
1695 ata_gen_passthru_sense(qc);
1696 else if (need_sense)
1697 ata_gen_ata_sense(qc);
1699 /* Keep the SCSI ML and status byte, clear host byte. */
1700 cmd->result &= 0x0000ffff;
1702 if (need_sense && !ap->ops->error_handler)
1703 ata_dump_status(ap, &qc->result_tf);
1709 * ata_scsi_translate - Translate then issue SCSI command to ATA device
1710 * @dev: ATA device to which the command is addressed
1711 * @cmd: SCSI command to execute
1712 * @xlat_func: Actor which translates @cmd to an ATA taskfile
1714 * Our ->queuecommand() function has decided that the SCSI
1715 * command issued can be directly translated into an ATA
1716 * command, rather than handled internally.
1718 * This function sets up an ata_queued_cmd structure for the
1719 * SCSI command, and sends that ata_queued_cmd to the hardware.
1721 * The xlat_func argument (actor) returns 0 if ready to execute
1722 * ATA command, else 1 to finish translation. If 1 is returned
1723 * then cmd->result (and possibly cmd->sense_buffer) are assumed
1724 * to be set reflecting an error condition or clean (early)
1728 * spin_lock_irqsave(host lock)
1731 * 0 on success, SCSI_ML_QUEUE_DEVICE_BUSY if the command
1732 * needs to be deferred.
1734 static int ata_scsi_translate(struct ata_device *dev, struct scsi_cmnd *cmd,
1735 ata_xlat_func_t xlat_func)
1737 struct ata_port *ap = dev->link->ap;
1738 struct ata_queued_cmd *qc;
1741 qc = ata_scsi_qc_new(dev, cmd);
1745 /* data is present; dma-map it */
1746 if (cmd->sc_data_direction == DMA_FROM_DEVICE ||
1747 cmd->sc_data_direction == DMA_TO_DEVICE) {
1748 if (unlikely(scsi_bufflen(cmd) < 1)) {
1749 ata_dev_warn(dev, "WARNING: zero len r/w req\n");
1753 ata_sg_init(qc, scsi_sglist(cmd), scsi_sg_count(cmd));
1755 qc->dma_dir = cmd->sc_data_direction;
1758 qc->complete_fn = ata_scsi_qc_complete;
1763 if (ap->ops->qc_defer) {
1764 if ((rc = ap->ops->qc_defer(qc)))
1768 /* select device, send command to hardware */
1780 cmd->result = (DID_ERROR << 16);
1787 if (rc == ATA_DEFER_LINK)
1788 return SCSI_MLQUEUE_DEVICE_BUSY;
1790 return SCSI_MLQUEUE_HOST_BUSY;
1793 struct ata_scsi_args {
1794 struct ata_device *dev;
1796 struct scsi_cmnd *cmd;
1800 * ata_scsi_rbuf_fill - wrapper for SCSI command simulators
1801 * @args: device IDENTIFY data / SCSI command of interest.
1802 * @actor: Callback hook for desired SCSI command simulator
1804 * Takes care of the hard work of simulating a SCSI command...
1805 * Mapping the response buffer, calling the command's handler,
1806 * and handling the handler's return value. This return value
1807 * indicates whether the handler wishes the SCSI command to be
1808 * completed successfully (0), or not (in which case cmd->result
1809 * and sense buffer are assumed to be set).
1812 * spin_lock_irqsave(host lock)
1814 static void ata_scsi_rbuf_fill(struct ata_scsi_args *args,
1815 unsigned int (*actor)(struct ata_scsi_args *args, u8 *rbuf))
1818 struct scsi_cmnd *cmd = args->cmd;
1819 unsigned long flags;
1821 spin_lock_irqsave(&ata_scsi_rbuf_lock, flags);
1823 memset(ata_scsi_rbuf, 0, ATA_SCSI_RBUF_SIZE);
1824 rc = actor(args, ata_scsi_rbuf);
1826 sg_copy_from_buffer(scsi_sglist(cmd), scsi_sg_count(cmd),
1827 ata_scsi_rbuf, ATA_SCSI_RBUF_SIZE);
1829 spin_unlock_irqrestore(&ata_scsi_rbuf_lock, flags);
1832 cmd->result = SAM_STAT_GOOD;
1836 * ata_scsiop_inq_std - Simulate INQUIRY command
1837 * @args: device IDENTIFY data / SCSI command of interest.
1838 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1840 * Returns standard device identification data associated
1841 * with non-VPD INQUIRY command output.
1844 * spin_lock_irqsave(host lock)
1846 static unsigned int ata_scsiop_inq_std(struct ata_scsi_args *args, u8 *rbuf)
1848 static const u8 versions[] = {
1850 0x60, /* SAM-3 (no version claimed) */
1853 0x20, /* SBC-2 (no version claimed) */
1856 0x00 /* SPC-3 (no version claimed) */
1858 static const u8 versions_zbc[] = {
1860 0xA0, /* SAM-5 (no version claimed) */
1863 0x00, /* SBC-4 (no version claimed) */
1866 0xC0, /* SPC-5 (no version claimed) */
1875 0x5, /* claim SPC-3 version compatibility */
1883 /* set scsi removable (RMB) bit per ata bit, or if the
1884 * AHCI port says it's external (Hotplug-capable, eSATA).
1886 if (ata_id_removable(args->id) ||
1887 (args->dev->link->ap->pflags & ATA_PFLAG_EXTERNAL))
1890 if (args->dev->class == ATA_DEV_ZAC) {
1892 hdr[2] = 0x7; /* claim SPC-5 version compatibility */
1895 memcpy(rbuf, hdr, sizeof(hdr));
1896 memcpy(&rbuf[8], "ATA ", 8);
1897 ata_id_string(args->id, &rbuf[16], ATA_ID_PROD, 16);
1899 /* From SAT, use last 2 words from fw rev unless they are spaces */
1900 ata_id_string(args->id, &rbuf[32], ATA_ID_FW_REV + 2, 4);
1901 if (strncmp(&rbuf[32], " ", 4) == 0)
1902 ata_id_string(args->id, &rbuf[32], ATA_ID_FW_REV, 4);
1904 if (rbuf[32] == 0 || rbuf[32] == ' ')
1905 memcpy(&rbuf[32], "n/a ", 4);
1907 if (ata_id_zoned_cap(args->id) || args->dev->class == ATA_DEV_ZAC)
1908 memcpy(rbuf + 58, versions_zbc, sizeof(versions_zbc));
1910 memcpy(rbuf + 58, versions, sizeof(versions));
1916 * ata_scsiop_inq_00 - Simulate INQUIRY VPD page 0, list of pages
1917 * @args: device IDENTIFY data / SCSI command of interest.
1918 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1920 * Returns list of inquiry VPD pages available.
1923 * spin_lock_irqsave(host lock)
1925 static unsigned int ata_scsiop_inq_00(struct ata_scsi_args *args, u8 *rbuf)
1927 int i, num_pages = 0;
1928 static const u8 pages[] = {
1929 0x00, /* page 0x00, this page */
1930 0x80, /* page 0x80, unit serial no page */
1931 0x83, /* page 0x83, device ident page */
1932 0x89, /* page 0x89, ata info page */
1933 0xb0, /* page 0xb0, block limits page */
1934 0xb1, /* page 0xb1, block device characteristics page */
1935 0xb2, /* page 0xb2, thin provisioning page */
1936 0xb6, /* page 0xb6, zoned block device characteristics */
1937 0xb9, /* page 0xb9, concurrent positioning ranges */
1940 for (i = 0; i < sizeof(pages); i++) {
1941 if (pages[i] == 0xb6 &&
1942 !(args->dev->flags & ATA_DFLAG_ZAC))
1944 rbuf[num_pages + 4] = pages[i];
1947 rbuf[3] = num_pages; /* number of supported VPD pages */
1952 * ata_scsiop_inq_80 - Simulate INQUIRY VPD page 80, device serial number
1953 * @args: device IDENTIFY data / SCSI command of interest.
1954 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1956 * Returns ATA device serial number.
1959 * spin_lock_irqsave(host lock)
1961 static unsigned int ata_scsiop_inq_80(struct ata_scsi_args *args, u8 *rbuf)
1963 static const u8 hdr[] = {
1965 0x80, /* this page code */
1967 ATA_ID_SERNO_LEN, /* page len */
1970 memcpy(rbuf, hdr, sizeof(hdr));
1971 ata_id_string(args->id, (unsigned char *) &rbuf[4],
1972 ATA_ID_SERNO, ATA_ID_SERNO_LEN);
1977 * ata_scsiop_inq_83 - Simulate INQUIRY VPD page 83, device identity
1978 * @args: device IDENTIFY data / SCSI command of interest.
1979 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1981 * Yields two logical unit device identification designators:
1982 * - vendor specific ASCII containing the ATA serial number
1983 * - SAT defined "t10 vendor id based" containing ASCII vendor
1984 * name ("ATA "), model and serial numbers.
1987 * spin_lock_irqsave(host lock)
1989 static unsigned int ata_scsiop_inq_83(struct ata_scsi_args *args, u8 *rbuf)
1991 const int sat_model_serial_desc_len = 68;
1994 rbuf[1] = 0x83; /* this page code */
1997 /* piv=0, assoc=lu, code_set=ACSII, designator=vendor */
1999 rbuf[num + 3] = ATA_ID_SERNO_LEN;
2001 ata_id_string(args->id, (unsigned char *) rbuf + num,
2002 ATA_ID_SERNO, ATA_ID_SERNO_LEN);
2003 num += ATA_ID_SERNO_LEN;
2005 /* SAT defined lu model and serial numbers descriptor */
2006 /* piv=0, assoc=lu, code_set=ACSII, designator=t10 vendor id */
2009 rbuf[num + 3] = sat_model_serial_desc_len;
2011 memcpy(rbuf + num, "ATA ", 8);
2013 ata_id_string(args->id, (unsigned char *) rbuf + num, ATA_ID_PROD,
2015 num += ATA_ID_PROD_LEN;
2016 ata_id_string(args->id, (unsigned char *) rbuf + num, ATA_ID_SERNO,
2018 num += ATA_ID_SERNO_LEN;
2020 if (ata_id_has_wwn(args->id)) {
2021 /* SAT defined lu world wide name */
2022 /* piv=0, assoc=lu, code_set=binary, designator=NAA */
2025 rbuf[num + 3] = ATA_ID_WWN_LEN;
2027 ata_id_string(args->id, (unsigned char *) rbuf + num,
2028 ATA_ID_WWN, ATA_ID_WWN_LEN);
2029 num += ATA_ID_WWN_LEN;
2031 rbuf[3] = num - 4; /* page len (assume less than 256 bytes) */
2036 * ata_scsiop_inq_89 - Simulate INQUIRY VPD page 89, ATA info
2037 * @args: device IDENTIFY data / SCSI command of interest.
2038 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2040 * Yields SAT-specified ATA VPD page.
2043 * spin_lock_irqsave(host lock)
2045 static unsigned int ata_scsiop_inq_89(struct ata_scsi_args *args, u8 *rbuf)
2047 rbuf[1] = 0x89; /* our page code */
2048 rbuf[2] = (0x238 >> 8); /* page size fixed at 238h */
2049 rbuf[3] = (0x238 & 0xff);
2051 memcpy(&rbuf[8], "linux ", 8);
2052 memcpy(&rbuf[16], "libata ", 16);
2053 memcpy(&rbuf[32], DRV_VERSION, 4);
2055 rbuf[36] = 0x34; /* force D2H Reg FIS (34h) */
2056 rbuf[37] = (1 << 7); /* bit 7 indicates Command FIS */
2059 /* we don't store the ATA device signature, so we fake it */
2060 rbuf[38] = ATA_DRDY; /* really, this is Status reg */
2064 rbuf[56] = ATA_CMD_ID_ATA;
2066 memcpy(&rbuf[60], &args->id[0], 512);
2070 static unsigned int ata_scsiop_inq_b0(struct ata_scsi_args *args, u8 *rbuf)
2072 struct ata_device *dev = args->dev;
2076 rbuf[3] = 0x3c; /* required VPD size with unmap support */
2079 * Optimal transfer length granularity.
2081 * This is always one physical block, but for disks with a smaller
2082 * logical than physical sector size we need to figure out what the
2085 min_io_sectors = 1 << ata_id_log2_per_physical_sector(args->id);
2086 put_unaligned_be16(min_io_sectors, &rbuf[6]);
2089 * Optimal unmap granularity.
2091 * The ATA spec doesn't even know about a granularity or alignment
2092 * for the TRIM command. We can leave away most of the unmap related
2093 * VPD page entries, but we have specifify a granularity to signal
2094 * that we support some form of unmap - in thise case via WRITE SAME
2095 * with the unmap bit set.
2097 if (ata_id_has_trim(args->id)) {
2098 u64 max_blocks = 65535 * ATA_MAX_TRIM_RNUM;
2100 if (dev->horkage & ATA_HORKAGE_MAX_TRIM_128M)
2101 max_blocks = 128 << (20 - SECTOR_SHIFT);
2103 put_unaligned_be64(max_blocks, &rbuf[36]);
2104 put_unaligned_be32(1, &rbuf[28]);
2110 static unsigned int ata_scsiop_inq_b1(struct ata_scsi_args *args, u8 *rbuf)
2112 int form_factor = ata_id_form_factor(args->id);
2113 int media_rotation_rate = ata_id_rotation_rate(args->id);
2114 u8 zoned = ata_id_zoned_cap(args->id);
2118 rbuf[4] = media_rotation_rate >> 8;
2119 rbuf[5] = media_rotation_rate;
2120 rbuf[7] = form_factor;
2122 rbuf[8] = (zoned << 4);
2127 static unsigned int ata_scsiop_inq_b2(struct ata_scsi_args *args, u8 *rbuf)
2129 /* SCSI Thin Provisioning VPD page: SBC-3 rev 22 or later */
2132 rbuf[5] = 1 << 6; /* TPWS */
2137 static unsigned int ata_scsiop_inq_b6(struct ata_scsi_args *args, u8 *rbuf)
2140 * zbc-r05 SCSI Zoned Block device characteristics VPD page
2146 * URSWRZ bit is only meaningful for host-managed ZAC drives
2148 if (args->dev->zac_zoned_cap & 1)
2150 put_unaligned_be32(args->dev->zac_zones_optimal_open, &rbuf[8]);
2151 put_unaligned_be32(args->dev->zac_zones_optimal_nonseq, &rbuf[12]);
2152 put_unaligned_be32(args->dev->zac_zones_max_open, &rbuf[16]);
2157 static unsigned int ata_scsiop_inq_b9(struct ata_scsi_args *args, u8 *rbuf)
2159 struct ata_cpr_log *cpr_log = args->dev->cpr_log;
2160 u8 *desc = &rbuf[64];
2163 /* SCSI Concurrent Positioning Ranges VPD page: SBC-5 rev 1 or later */
2165 put_unaligned_be16(64 + (int)cpr_log->nr_cpr * 32 - 4, &rbuf[2]);
2167 for (i = 0; i < cpr_log->nr_cpr; i++, desc += 32) {
2168 desc[0] = cpr_log->cpr[i].num;
2169 desc[1] = cpr_log->cpr[i].num_storage_elements;
2170 put_unaligned_be64(cpr_log->cpr[i].start_lba, &desc[8]);
2171 put_unaligned_be64(cpr_log->cpr[i].num_lbas, &desc[16]);
2178 * modecpy - Prepare response for MODE SENSE
2179 * @dest: output buffer
2180 * @src: data being copied
2181 * @n: length of mode page
2182 * @changeable: whether changeable parameters are requested
2184 * Generate a generic MODE SENSE page for either current or changeable
2190 static void modecpy(u8 *dest, const u8 *src, int n, bool changeable)
2193 memcpy(dest, src, 2);
2194 memset(dest + 2, 0, n - 2);
2196 memcpy(dest, src, n);
2201 * ata_msense_caching - Simulate MODE SENSE caching info page
2202 * @id: device IDENTIFY data
2203 * @buf: output buffer
2204 * @changeable: whether changeable parameters are requested
2206 * Generate a caching info page, which conditionally indicates
2207 * write caching to the SCSI layer, depending on device
2213 static unsigned int ata_msense_caching(u16 *id, u8 *buf, bool changeable)
2215 modecpy(buf, def_cache_mpage, sizeof(def_cache_mpage), changeable);
2217 buf[2] |= (1 << 2); /* ata_mselect_caching() */
2219 buf[2] |= (ata_id_wcache_enabled(id) << 2); /* write cache enable */
2220 buf[12] |= (!ata_id_rahead_enabled(id) << 5); /* disable read ahead */
2222 return sizeof(def_cache_mpage);
2226 * Simulate MODE SENSE control mode page, sub-page 0.
2228 static unsigned int ata_msense_control_spg0(struct ata_device *dev, u8 *buf,
2231 modecpy(buf, def_control_mpage,
2232 sizeof(def_control_mpage), changeable);
2234 /* ata_mselect_control() */
2237 bool d_sense = (dev->flags & ATA_DFLAG_D_SENSE);
2239 /* descriptor format sense data */
2240 buf[2] |= (d_sense << 2);
2243 return sizeof(def_control_mpage);
2247 * Translate an ATA duration limit in microseconds to a SCSI duration limit
2248 * using the t2cdlunits 0xa (10ms). Since the SCSI duration limits are 2-bytes
2249 * only, take care of overflows.
2251 static inline u16 ata_xlat_cdl_limit(u8 *buf)
2253 u32 limit = get_unaligned_le32(buf);
2255 return min_t(u32, limit / 10000, 65535);
2259 * Simulate MODE SENSE control mode page, sub-pages 07h and 08h
2260 * (command duration limits T2A and T2B mode pages).
2262 static unsigned int ata_msense_control_spgt2(struct ata_device *dev, u8 *buf,
2265 u8 *b, *cdl = dev->cdl, *desc;
2270 * Fill the subpage. The first four bytes of the T2A/T2B mode pages
2271 * are a header. The PAGE LENGTH field is the size of the page
2272 * excluding the header.
2274 buf[0] = CONTROL_MPAGE;
2276 put_unaligned_be16(CDL_T2_SUB_MPAGE_LEN - 4, &buf[2]);
2277 if (spg == CDL_T2A_SUB_MPAGE) {
2279 * Read descriptors map to the T2A page:
2280 * set perf_vs_duration_guidleine.
2282 buf[7] = (cdl[0] & 0x03) << 4;
2285 /* Write descriptors map to the T2B page */
2289 /* Fill the T2 page descriptors */
2291 policy = get_unaligned_le32(&cdl[0]);
2292 for (i = 0; i < 7; i++, b += 32, desc += 32) {
2293 /* t2cdlunits: fixed to 10ms */
2296 /* Max inactive time and its policy */
2297 put_unaligned_be16(ata_xlat_cdl_limit(&desc[8]), &b[2]);
2298 b[6] = ((policy >> 8) & 0x0f) << 4;
2300 /* Max active time and its policy */
2301 put_unaligned_be16(ata_xlat_cdl_limit(&desc[4]), &b[4]);
2302 b[6] |= (policy >> 4) & 0x0f;
2304 /* Command duration guideline and its policy */
2305 put_unaligned_be16(ata_xlat_cdl_limit(&desc[16]), &b[10]);
2306 b[14] = policy & 0x0f;
2309 return CDL_T2_SUB_MPAGE_LEN;
2313 * Simulate MODE SENSE control mode page, sub-page f2h
2314 * (ATA feature control mode page).
2316 static unsigned int ata_msense_control_ata_feature(struct ata_device *dev,
2320 buf[0] = CONTROL_MPAGE | (1 << 6);
2321 buf[1] = ATA_FEATURE_SUB_MPAGE;
2324 * The first four bytes of ATA Feature Control mode page are a header.
2325 * The PAGE LENGTH field is the size of the page excluding the header.
2327 put_unaligned_be16(ATA_FEATURE_SUB_MPAGE_LEN - 4, &buf[2]);
2329 if (dev->flags & ATA_DFLAG_CDL)
2330 buf[4] = 0x02; /* Support T2A and T2B pages */
2334 return ATA_FEATURE_SUB_MPAGE_LEN;
2338 * ata_msense_control - Simulate MODE SENSE control mode page
2339 * @dev: ATA device of interest
2340 * @buf: output buffer
2341 * @spg: sub-page code
2342 * @changeable: whether changeable parameters are requested
2344 * Generate a generic MODE SENSE control mode page.
2349 static unsigned int ata_msense_control(struct ata_device *dev, u8 *buf,
2350 u8 spg, bool changeable)
2356 return ata_msense_control_spg0(dev, buf, changeable);
2357 case CDL_T2A_SUB_MPAGE:
2358 case CDL_T2B_SUB_MPAGE:
2359 return ata_msense_control_spgt2(dev, buf, spg);
2360 case ATA_FEATURE_SUB_MPAGE:
2361 return ata_msense_control_ata_feature(dev, buf);
2362 case ALL_SUB_MPAGES:
2363 n = ata_msense_control_spg0(dev, buf, changeable);
2364 n += ata_msense_control_spgt2(dev, buf + n, CDL_T2A_SUB_MPAGE);
2365 n += ata_msense_control_spgt2(dev, buf + n, CDL_T2A_SUB_MPAGE);
2366 n += ata_msense_control_ata_feature(dev, buf + n);
2374 * ata_msense_rw_recovery - Simulate MODE SENSE r/w error recovery page
2375 * @buf: output buffer
2376 * @changeable: whether changeable parameters are requested
2378 * Generate a generic MODE SENSE r/w error recovery page.
2383 static unsigned int ata_msense_rw_recovery(u8 *buf, bool changeable)
2385 modecpy(buf, def_rw_recovery_mpage, sizeof(def_rw_recovery_mpage),
2387 return sizeof(def_rw_recovery_mpage);
2391 * ata_scsiop_mode_sense - Simulate MODE SENSE 6, 10 commands
2392 * @args: device IDENTIFY data / SCSI command of interest.
2393 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2395 * Simulate MODE SENSE commands. Assume this is invoked for direct
2396 * access devices (e.g. disks) only. There should be no block
2397 * descriptor for other device types.
2400 * spin_lock_irqsave(host lock)
2402 static unsigned int ata_scsiop_mode_sense(struct ata_scsi_args *args, u8 *rbuf)
2404 struct ata_device *dev = args->dev;
2405 u8 *scsicmd = args->cmd->cmnd, *p = rbuf;
2406 static const u8 sat_blk_desc[] = {
2407 0, 0, 0, 0, /* number of blocks: sat unspecified */
2409 0, 0x2, 0x0 /* block length: 512 bytes */
2412 unsigned int ebd, page_control, six_byte;
2413 u8 dpofua = 0, bp = 0xff;
2416 six_byte = (scsicmd[0] == MODE_SENSE);
2417 ebd = !(scsicmd[1] & 0x8); /* dbd bit inverted == edb */
2419 * LLBA bit in msense(10) ignored (compliant)
2422 page_control = scsicmd[2] >> 6;
2423 switch (page_control) {
2424 case 0: /* current */
2425 case 1: /* changeable */
2426 case 2: /* defaults */
2427 break; /* supported */
2429 goto saving_not_supp;
2437 p += 4 + (ebd ? 8 : 0);
2439 p += 8 + (ebd ? 8 : 0);
2441 pg = scsicmd[2] & 0x3f;
2445 * Supported subpages: all subpages and sub-pages 07h, 08h and f2h of
2450 case ALL_SUB_MPAGES:
2452 case CDL_T2A_SUB_MPAGE:
2453 case CDL_T2B_SUB_MPAGE:
2454 case ATA_FEATURE_SUB_MPAGE:
2455 if (dev->flags & ATA_DFLAG_CDL && pg == CONTROL_MPAGE)
2465 case RW_RECOVERY_MPAGE:
2466 p += ata_msense_rw_recovery(p, page_control == 1);
2470 p += ata_msense_caching(args->id, p, page_control == 1);
2474 p += ata_msense_control(args->dev, p, spg, page_control == 1);
2478 p += ata_msense_rw_recovery(p, page_control == 1);
2479 p += ata_msense_caching(args->id, p, page_control == 1);
2480 p += ata_msense_control(args->dev, p, spg, page_control == 1);
2483 default: /* invalid page code */
2488 if (dev->flags & ATA_DFLAG_FUA)
2492 rbuf[0] = p - rbuf - 1;
2495 rbuf[3] = sizeof(sat_blk_desc);
2496 memcpy(rbuf + 4, sat_blk_desc, sizeof(sat_blk_desc));
2499 put_unaligned_be16(p - rbuf - 2, &rbuf[0]);
2502 rbuf[7] = sizeof(sat_blk_desc);
2503 memcpy(rbuf + 8, sat_blk_desc, sizeof(sat_blk_desc));
2509 ata_scsi_set_invalid_field(dev, args->cmd, fp, bp);
2513 ata_scsi_set_sense(dev, args->cmd, ILLEGAL_REQUEST, 0x39, 0x0);
2514 /* "Saving parameters not supported" */
2519 * ata_scsiop_read_cap - Simulate READ CAPACITY[ 16] commands
2520 * @args: device IDENTIFY data / SCSI command of interest.
2521 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2523 * Simulate READ CAPACITY commands.
2528 static unsigned int ata_scsiop_read_cap(struct ata_scsi_args *args, u8 *rbuf)
2530 struct ata_device *dev = args->dev;
2531 u64 last_lba = dev->n_sectors - 1; /* LBA of the last block */
2532 u32 sector_size; /* physical sector size in bytes */
2536 sector_size = ata_id_logical_sector_size(dev->id);
2537 log2_per_phys = ata_id_log2_per_physical_sector(dev->id);
2538 lowest_aligned = ata_id_logical_sector_offset(dev->id, log2_per_phys);
2540 if (args->cmd->cmnd[0] == READ_CAPACITY) {
2541 if (last_lba >= 0xffffffffULL)
2542 last_lba = 0xffffffff;
2544 /* sector count, 32-bit */
2545 rbuf[0] = last_lba >> (8 * 3);
2546 rbuf[1] = last_lba >> (8 * 2);
2547 rbuf[2] = last_lba >> (8 * 1);
2551 rbuf[4] = sector_size >> (8 * 3);
2552 rbuf[5] = sector_size >> (8 * 2);
2553 rbuf[6] = sector_size >> (8 * 1);
2554 rbuf[7] = sector_size;
2556 /* sector count, 64-bit */
2557 rbuf[0] = last_lba >> (8 * 7);
2558 rbuf[1] = last_lba >> (8 * 6);
2559 rbuf[2] = last_lba >> (8 * 5);
2560 rbuf[3] = last_lba >> (8 * 4);
2561 rbuf[4] = last_lba >> (8 * 3);
2562 rbuf[5] = last_lba >> (8 * 2);
2563 rbuf[6] = last_lba >> (8 * 1);
2567 rbuf[ 8] = sector_size >> (8 * 3);
2568 rbuf[ 9] = sector_size >> (8 * 2);
2569 rbuf[10] = sector_size >> (8 * 1);
2570 rbuf[11] = sector_size;
2573 rbuf[13] = log2_per_phys;
2574 rbuf[14] = (lowest_aligned >> 8) & 0x3f;
2575 rbuf[15] = lowest_aligned;
2577 if (ata_id_has_trim(args->id) &&
2578 !(dev->horkage & ATA_HORKAGE_NOTRIM)) {
2579 rbuf[14] |= 0x80; /* LBPME */
2581 if (ata_id_has_zero_after_trim(args->id) &&
2582 dev->horkage & ATA_HORKAGE_ZERO_AFTER_TRIM) {
2583 ata_dev_info(dev, "Enabling discard_zeroes_data\n");
2584 rbuf[14] |= 0x40; /* LBPRZ */
2587 if (ata_id_zoned_cap(args->id) ||
2588 args->dev->class == ATA_DEV_ZAC)
2589 rbuf[12] = (1 << 4); /* RC_BASIS */
2595 * ata_scsiop_report_luns - Simulate REPORT LUNS command
2596 * @args: device IDENTIFY data / SCSI command of interest.
2597 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2599 * Simulate REPORT LUNS command.
2602 * spin_lock_irqsave(host lock)
2604 static unsigned int ata_scsiop_report_luns(struct ata_scsi_args *args, u8 *rbuf)
2606 rbuf[3] = 8; /* just one lun, LUN 0, size 8 bytes */
2611 static void atapi_sense_complete(struct ata_queued_cmd *qc)
2613 if (qc->err_mask && ((qc->err_mask & AC_ERR_DEV) == 0)) {
2614 /* FIXME: not quite right; we don't want the
2615 * translation of taskfile registers into
2616 * a sense descriptors, since that's only
2617 * correct for ATA, not ATAPI
2619 ata_gen_passthru_sense(qc);
2625 /* is it pointless to prefer PIO for "safety reasons"? */
2626 static inline int ata_pio_use_silly(struct ata_port *ap)
2628 return (ap->flags & ATA_FLAG_PIO_DMA);
2631 static void atapi_request_sense(struct ata_queued_cmd *qc)
2633 struct ata_port *ap = qc->ap;
2634 struct scsi_cmnd *cmd = qc->scsicmd;
2636 memset(cmd->sense_buffer, 0, SCSI_SENSE_BUFFERSIZE);
2638 #ifdef CONFIG_ATA_SFF
2639 if (ap->ops->sff_tf_read)
2640 ap->ops->sff_tf_read(ap, &qc->tf);
2643 /* fill these in, for the case where they are -not- overwritten */
2644 cmd->sense_buffer[0] = 0x70;
2645 cmd->sense_buffer[2] = qc->tf.error >> 4;
2649 /* setup sg table and init transfer direction */
2650 sg_init_one(&qc->sgent, cmd->sense_buffer, SCSI_SENSE_BUFFERSIZE);
2651 ata_sg_init(qc, &qc->sgent, 1);
2652 qc->dma_dir = DMA_FROM_DEVICE;
2654 memset(&qc->cdb, 0, qc->dev->cdb_len);
2655 qc->cdb[0] = REQUEST_SENSE;
2656 qc->cdb[4] = SCSI_SENSE_BUFFERSIZE;
2658 qc->tf.flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
2659 qc->tf.command = ATA_CMD_PACKET;
2661 if (ata_pio_use_silly(ap)) {
2662 qc->tf.protocol = ATAPI_PROT_DMA;
2663 qc->tf.feature |= ATAPI_PKT_DMA;
2665 qc->tf.protocol = ATAPI_PROT_PIO;
2666 qc->tf.lbam = SCSI_SENSE_BUFFERSIZE;
2669 qc->nbytes = SCSI_SENSE_BUFFERSIZE;
2671 qc->complete_fn = atapi_sense_complete;
2677 * ATAPI devices typically report zero for their SCSI version, and sometimes
2678 * deviate from the spec WRT response data format. If SCSI version is
2679 * reported as zero like normal, then we make the following fixups:
2680 * 1) Fake MMC-5 version, to indicate to the Linux scsi midlayer this is a
2682 * 2) Ensure response data format / ATAPI information are always correct.
2684 static void atapi_fixup_inquiry(struct scsi_cmnd *cmd)
2688 sg_copy_to_buffer(scsi_sglist(cmd), scsi_sg_count(cmd), buf, 4);
2693 sg_copy_from_buffer(scsi_sglist(cmd), scsi_sg_count(cmd), buf, 4);
2696 static void atapi_qc_complete(struct ata_queued_cmd *qc)
2698 struct scsi_cmnd *cmd = qc->scsicmd;
2699 unsigned int err_mask = qc->err_mask;
2701 /* handle completion from new EH */
2702 if (unlikely(qc->ap->ops->error_handler &&
2703 (err_mask || qc->flags & ATA_QCFLAG_SENSE_VALID))) {
2705 if (!(qc->flags & ATA_QCFLAG_SENSE_VALID)) {
2706 /* FIXME: not quite right; we don't want the
2707 * translation of taskfile registers into a
2708 * sense descriptors, since that's only
2709 * correct for ATA, not ATAPI
2711 ata_gen_passthru_sense(qc);
2714 /* SCSI EH automatically locks door if sdev->locked is
2715 * set. Sometimes door lock request continues to
2716 * fail, for example, when no media is present. This
2717 * creates a loop - SCSI EH issues door lock which
2718 * fails and gets invoked again to acquire sense data
2719 * for the failed command.
2721 * If door lock fails, always clear sdev->locked to
2722 * avoid this infinite loop.
2724 * This may happen before SCSI scan is complete. Make
2725 * sure qc->dev->sdev isn't NULL before dereferencing.
2727 if (qc->cdb[0] == ALLOW_MEDIUM_REMOVAL && qc->dev->sdev)
2728 qc->dev->sdev->locked = 0;
2730 qc->scsicmd->result = SAM_STAT_CHECK_CONDITION;
2735 /* successful completion or old EH failure path */
2736 if (unlikely(err_mask & AC_ERR_DEV)) {
2737 cmd->result = SAM_STAT_CHECK_CONDITION;
2738 atapi_request_sense(qc);
2740 } else if (unlikely(err_mask)) {
2741 /* FIXME: not quite right; we don't want the
2742 * translation of taskfile registers into
2743 * a sense descriptors, since that's only
2744 * correct for ATA, not ATAPI
2746 ata_gen_passthru_sense(qc);
2748 if (cmd->cmnd[0] == INQUIRY && (cmd->cmnd[1] & 0x03) == 0)
2749 atapi_fixup_inquiry(cmd);
2750 cmd->result = SAM_STAT_GOOD;
2756 * atapi_xlat - Initialize PACKET taskfile
2757 * @qc: command structure to be initialized
2760 * spin_lock_irqsave(host lock)
2763 * Zero on success, non-zero on failure.
2765 static unsigned int atapi_xlat(struct ata_queued_cmd *qc)
2767 struct scsi_cmnd *scmd = qc->scsicmd;
2768 struct ata_device *dev = qc->dev;
2769 int nodata = (scmd->sc_data_direction == DMA_NONE);
2770 int using_pio = !nodata && (dev->flags & ATA_DFLAG_PIO);
2771 unsigned int nbytes;
2773 memset(qc->cdb, 0, dev->cdb_len);
2774 memcpy(qc->cdb, scmd->cmnd, scmd->cmd_len);
2776 qc->complete_fn = atapi_qc_complete;
2778 qc->tf.flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
2779 if (scmd->sc_data_direction == DMA_TO_DEVICE) {
2780 qc->tf.flags |= ATA_TFLAG_WRITE;
2783 qc->tf.command = ATA_CMD_PACKET;
2784 ata_qc_set_pc_nbytes(qc);
2786 /* check whether ATAPI DMA is safe */
2787 if (!nodata && !using_pio && atapi_check_dma(qc))
2790 /* Some controller variants snoop this value for Packet
2791 * transfers to do state machine and FIFO management. Thus we
2792 * want to set it properly, and for DMA where it is
2793 * effectively meaningless.
2795 nbytes = min(ata_qc_raw_nbytes(qc), (unsigned int)63 * 1024);
2797 /* Most ATAPI devices which honor transfer chunk size don't
2798 * behave according to the spec when odd chunk size which
2799 * matches the transfer length is specified. If the number of
2800 * bytes to transfer is 2n+1. According to the spec, what
2801 * should happen is to indicate that 2n+1 is going to be
2802 * transferred and transfer 2n+2 bytes where the last byte is
2805 * In practice, this doesn't happen. ATAPI devices first
2806 * indicate and transfer 2n bytes and then indicate and
2807 * transfer 2 bytes where the last byte is padding.
2809 * This inconsistency confuses several controllers which
2810 * perform PIO using DMA such as Intel AHCIs and sil3124/32.
2811 * These controllers use actual number of transferred bytes to
2812 * update DMA pointer and transfer of 4n+2 bytes make those
2813 * controller push DMA pointer by 4n+4 bytes because SATA data
2814 * FISes are aligned to 4 bytes. This causes data corruption
2815 * and buffer overrun.
2817 * Always setting nbytes to even number solves this problem
2818 * because then ATAPI devices don't have to split data at 2n
2824 qc->tf.lbam = (nbytes & 0xFF);
2825 qc->tf.lbah = (nbytes >> 8);
2828 qc->tf.protocol = ATAPI_PROT_NODATA;
2830 qc->tf.protocol = ATAPI_PROT_PIO;
2833 qc->tf.protocol = ATAPI_PROT_DMA;
2834 qc->tf.feature |= ATAPI_PKT_DMA;
2836 if ((dev->flags & ATA_DFLAG_DMADIR) &&
2837 (scmd->sc_data_direction != DMA_TO_DEVICE))
2838 /* some SATA bridges need us to indicate data xfer direction */
2839 qc->tf.feature |= ATAPI_DMADIR;
2843 /* FIXME: We need to translate 0x05 READ_BLOCK_LIMITS to a MODE_SENSE
2844 as ATAPI tape drives don't get this right otherwise */
2848 static struct ata_device *ata_find_dev(struct ata_port *ap, unsigned int devno)
2851 * For the non-PMP case, ata_link_max_devices() returns 1 (SATA case),
2852 * or 2 (IDE master + slave case). However, the former case includes
2853 * libsas hosted devices which are numbered per scsi host, leading
2854 * to devno potentially being larger than 0 but with each struct
2855 * ata_device having its own struct ata_port and struct ata_link.
2856 * To accommodate these, ignore devno and always use device number 0.
2858 if (likely(!sata_pmp_attached(ap))) {
2859 int link_max_devices = ata_link_max_devices(&ap->link);
2861 if (link_max_devices == 1)
2862 return &ap->link.device[0];
2864 if (devno < link_max_devices)
2865 return &ap->link.device[devno];
2871 * For PMP-attached devices, the device number corresponds to C
2872 * (channel) of SCSI [H:C:I:L], indicating the port pmp link
2875 if (devno < ap->nr_pmp_links)
2876 return &ap->pmp_link[devno].device[0];
2881 static struct ata_device *__ata_scsi_find_dev(struct ata_port *ap,
2882 const struct scsi_device *scsidev)
2886 /* skip commands not addressed to targets we simulate */
2887 if (!sata_pmp_attached(ap)) {
2888 if (unlikely(scsidev->channel || scsidev->lun))
2890 devno = scsidev->id;
2892 if (unlikely(scsidev->id || scsidev->lun))
2894 devno = scsidev->channel;
2897 return ata_find_dev(ap, devno);
2901 * ata_scsi_find_dev - lookup ata_device from scsi_cmnd
2902 * @ap: ATA port to which the device is attached
2903 * @scsidev: SCSI device from which we derive the ATA device
2905 * Given various information provided in struct scsi_cmnd,
2906 * map that onto an ATA bus, and using that mapping
2907 * determine which ata_device is associated with the
2908 * SCSI command to be sent.
2911 * spin_lock_irqsave(host lock)
2914 * Associated ATA device, or %NULL if not found.
2917 ata_scsi_find_dev(struct ata_port *ap, const struct scsi_device *scsidev)
2919 struct ata_device *dev = __ata_scsi_find_dev(ap, scsidev);
2921 if (unlikely(!dev || !ata_dev_enabled(dev)))
2928 * ata_scsi_map_proto - Map pass-thru protocol value to taskfile value.
2929 * @byte1: Byte 1 from pass-thru CDB.
2932 * ATA_PROT_UNKNOWN if mapping failed/unimplemented, protocol otherwise.
2935 ata_scsi_map_proto(u8 byte1)
2937 switch((byte1 & 0x1e) >> 1) {
2938 case 3: /* Non-data */
2939 return ATA_PROT_NODATA;
2942 case 10: /* UDMA Data-in */
2943 case 11: /* UDMA Data-Out */
2944 return ATA_PROT_DMA;
2946 case 4: /* PIO Data-in */
2947 case 5: /* PIO Data-out */
2948 return ATA_PROT_PIO;
2950 case 12: /* FPDMA */
2951 return ATA_PROT_NCQ;
2953 case 0: /* Hard Reset */
2955 case 8: /* Device Diagnostic */
2956 case 9: /* Device Reset */
2957 case 7: /* DMA Queued */
2958 case 15: /* Return Response Info */
2959 default: /* Reserved */
2963 return ATA_PROT_UNKNOWN;
2967 * ata_scsi_pass_thru - convert ATA pass-thru CDB to taskfile
2968 * @qc: command structure to be initialized
2970 * Handles either 12, 16, or 32-byte versions of the CDB.
2973 * Zero on success, non-zero on failure.
2975 static unsigned int ata_scsi_pass_thru(struct ata_queued_cmd *qc)
2977 struct ata_taskfile *tf = &(qc->tf);
2978 struct scsi_cmnd *scmd = qc->scsicmd;
2979 struct ata_device *dev = qc->dev;
2980 const u8 *cdb = scmd->cmnd;
2984 /* 7Fh variable length cmd means a ata pass-thru(32) */
2985 if (cdb[0] == VARIABLE_LENGTH_CMD)
2988 tf->protocol = ata_scsi_map_proto(cdb[1 + cdb_offset]);
2989 if (tf->protocol == ATA_PROT_UNKNOWN) {
2994 if ((cdb[2 + cdb_offset] & 0x3) == 0) {
2996 * When T_LENGTH is zero (No data is transferred), dir should
2999 if (scmd->sc_data_direction != DMA_NONE) {
3000 fp = 2 + cdb_offset;
3004 if (ata_is_ncq(tf->protocol))
3005 tf->protocol = ATA_PROT_NCQ_NODATA;
3009 tf->flags |= ATA_TFLAG_LBA;
3012 * 12 and 16 byte CDBs use different offsets to
3013 * provide the various register values.
3018 * 16-byte CDB - may contain extended commands.
3020 * If that is the case, copy the upper byte register values.
3022 if (cdb[1] & 0x01) {
3023 tf->hob_feature = cdb[3];
3024 tf->hob_nsect = cdb[5];
3025 tf->hob_lbal = cdb[7];
3026 tf->hob_lbam = cdb[9];
3027 tf->hob_lbah = cdb[11];
3028 tf->flags |= ATA_TFLAG_LBA48;
3030 tf->flags &= ~ATA_TFLAG_LBA48;
3033 * Always copy low byte, device and command registers.
3035 tf->feature = cdb[4];
3040 tf->device = cdb[13];
3041 tf->command = cdb[14];
3045 * 12-byte CDB - incapable of extended commands.
3047 tf->flags &= ~ATA_TFLAG_LBA48;
3049 tf->feature = cdb[3];
3054 tf->device = cdb[8];
3055 tf->command = cdb[9];
3059 * 32-byte CDB - may contain extended command fields.
3061 * If that is the case, copy the upper byte register values.
3063 if (cdb[10] & 0x01) {
3064 tf->hob_feature = cdb[20];
3065 tf->hob_nsect = cdb[22];
3066 tf->hob_lbal = cdb[16];
3067 tf->hob_lbam = cdb[15];
3068 tf->hob_lbah = cdb[14];
3069 tf->flags |= ATA_TFLAG_LBA48;
3071 tf->flags &= ~ATA_TFLAG_LBA48;
3073 tf->feature = cdb[21];
3074 tf->nsect = cdb[23];
3078 tf->device = cdb[24];
3079 tf->command = cdb[25];
3080 tf->auxiliary = get_unaligned_be32(&cdb[28]);
3084 /* For NCQ commands copy the tag value */
3085 if (ata_is_ncq(tf->protocol))
3086 tf->nsect = qc->hw_tag << 3;
3088 /* enforce correct master/slave bit */
3089 tf->device = dev->devno ?
3090 tf->device | ATA_DEV1 : tf->device & ~ATA_DEV1;
3092 switch (tf->command) {
3093 /* READ/WRITE LONG use a non-standard sect_size */
3094 case ATA_CMD_READ_LONG:
3095 case ATA_CMD_READ_LONG_ONCE:
3096 case ATA_CMD_WRITE_LONG:
3097 case ATA_CMD_WRITE_LONG_ONCE:
3098 if (tf->protocol != ATA_PROT_PIO || tf->nsect != 1) {
3102 qc->sect_size = scsi_bufflen(scmd);
3105 /* commands using reported Logical Block size (e.g. 512 or 4K) */
3106 case ATA_CMD_CFA_WRITE_NE:
3107 case ATA_CMD_CFA_TRANS_SECT:
3108 case ATA_CMD_CFA_WRITE_MULT_NE:
3109 /* XXX: case ATA_CMD_CFA_WRITE_SECTORS_WITHOUT_ERASE: */
3111 case ATA_CMD_READ_EXT:
3112 case ATA_CMD_READ_QUEUED:
3113 /* XXX: case ATA_CMD_READ_QUEUED_EXT: */
3114 case ATA_CMD_FPDMA_READ:
3115 case ATA_CMD_READ_MULTI:
3116 case ATA_CMD_READ_MULTI_EXT:
3117 case ATA_CMD_PIO_READ:
3118 case ATA_CMD_PIO_READ_EXT:
3119 case ATA_CMD_READ_STREAM_DMA_EXT:
3120 case ATA_CMD_READ_STREAM_EXT:
3121 case ATA_CMD_VERIFY:
3122 case ATA_CMD_VERIFY_EXT:
3124 case ATA_CMD_WRITE_EXT:
3125 case ATA_CMD_WRITE_FUA_EXT:
3126 case ATA_CMD_WRITE_QUEUED:
3127 case ATA_CMD_WRITE_QUEUED_FUA_EXT:
3128 case ATA_CMD_FPDMA_WRITE:
3129 case ATA_CMD_WRITE_MULTI:
3130 case ATA_CMD_WRITE_MULTI_EXT:
3131 case ATA_CMD_WRITE_MULTI_FUA_EXT:
3132 case ATA_CMD_PIO_WRITE:
3133 case ATA_CMD_PIO_WRITE_EXT:
3134 case ATA_CMD_WRITE_STREAM_DMA_EXT:
3135 case ATA_CMD_WRITE_STREAM_EXT:
3136 qc->sect_size = scmd->device->sector_size;
3139 /* Everything else uses 512 byte "sectors" */
3141 qc->sect_size = ATA_SECT_SIZE;
3145 * Set flags so that all registers will be written, pass on
3146 * write indication (used for PIO/DMA setup), result TF is
3147 * copied back and we don't whine too much about its failure.
3149 tf->flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
3150 if (scmd->sc_data_direction == DMA_TO_DEVICE)
3151 tf->flags |= ATA_TFLAG_WRITE;
3153 qc->flags |= ATA_QCFLAG_RESULT_TF | ATA_QCFLAG_QUIET;
3156 * Set transfer length.
3158 * TODO: find out if we need to do more here to
3159 * cover scatter/gather case.
3161 ata_qc_set_pc_nbytes(qc);
3163 /* We may not issue DMA commands if no DMA mode is set */
3164 if (tf->protocol == ATA_PROT_DMA && !ata_dma_enabled(dev)) {
3169 /* We may not issue NCQ commands to devices not supporting NCQ */
3170 if (ata_is_ncq(tf->protocol) && !ata_ncq_enabled(dev)) {
3175 /* sanity check for pio multi commands */
3176 if ((cdb[1] & 0xe0) && !is_multi_taskfile(tf)) {
3181 if (is_multi_taskfile(tf)) {
3182 unsigned int multi_count = 1 << (cdb[1] >> 5);
3184 /* compare the passed through multi_count
3185 * with the cached multi_count of libata
3187 if (multi_count != dev->multi_count)
3188 ata_dev_warn(dev, "invalid multi_count %u ignored\n",
3193 * Filter SET_FEATURES - XFER MODE command -- otherwise,
3194 * SET_FEATURES - XFER MODE must be preceded/succeeded
3195 * by an update to hardware-specific registers for each
3196 * controller (i.e. the reason for ->set_piomode(),
3197 * ->set_dmamode(), and ->post_set_mode() hooks).
3199 if (tf->command == ATA_CMD_SET_FEATURES &&
3200 tf->feature == SETFEATURES_XFER) {
3201 fp = (cdb[0] == ATA_16) ? 4 : 3;
3206 * Filter TPM commands by default. These provide an
3207 * essentially uncontrolled encrypted "back door" between
3208 * applications and the disk. Set libata.allow_tpm=1 if you
3209 * have a real reason for wanting to use them. This ensures
3210 * that installed software cannot easily mess stuff up without
3211 * user intent. DVR type users will probably ship with this enabled
3212 * for movie content management.
3214 * Note that for ATA8 we can issue a DCS change and DCS freeze lock
3215 * for this and should do in future but that it is not sufficient as
3216 * DCS is an optional feature set. Thus we also do the software filter
3217 * so that we comply with the TC consortium stated goal that the user
3218 * can turn off TC features of their system.
3220 if (tf->command >= 0x5C && tf->command <= 0x5F && !libata_allow_tpm) {
3221 fp = (cdb[0] == ATA_16) ? 14 : 9;
3228 ata_scsi_set_invalid_field(dev, scmd, fp, 0xff);
3233 * ata_format_dsm_trim_descr() - SATL Write Same to DSM Trim
3234 * @cmd: SCSI command being translated
3235 * @trmax: Maximum number of entries that will fit in sector_size bytes.
3236 * @sector: Starting sector
3237 * @count: Total Range of request in logical sectors
3239 * Rewrite the WRITE SAME descriptor to be a DSM TRIM little-endian formatted
3242 * Upto 64 entries of the format:
3243 * 63:48 Range Length
3246 * Range Length of 0 is ignored.
3247 * LBA's should be sorted order and not overlap.
3249 * NOTE: this is the same format as ADD LBA(S) TO NV CACHE PINNED SET
3251 * Return: Number of bytes copied into sglist.
3253 static size_t ata_format_dsm_trim_descr(struct scsi_cmnd *cmd, u32 trmax,
3254 u64 sector, u32 count)
3256 struct scsi_device *sdp = cmd->device;
3257 size_t len = sdp->sector_size;
3261 unsigned long flags;
3263 WARN_ON(len > ATA_SCSI_RBUF_SIZE);
3265 if (len > ATA_SCSI_RBUF_SIZE)
3266 len = ATA_SCSI_RBUF_SIZE;
3268 spin_lock_irqsave(&ata_scsi_rbuf_lock, flags);
3269 buf = ((void *)ata_scsi_rbuf);
3270 memset(buf, 0, len);
3272 u64 entry = sector |
3273 ((u64)(count > 0xffff ? 0xffff : count) << 48);
3274 buf[i++] = __cpu_to_le64(entry);
3275 if (count <= 0xffff)
3280 r = sg_copy_from_buffer(scsi_sglist(cmd), scsi_sg_count(cmd), buf, len);
3281 spin_unlock_irqrestore(&ata_scsi_rbuf_lock, flags);
3287 * ata_scsi_write_same_xlat() - SATL Write Same to ATA SCT Write Same
3288 * @qc: Command to be translated
3290 * Translate a SCSI WRITE SAME command to be either a DSM TRIM command or
3291 * an SCT Write Same command.
3292 * Based on WRITE SAME has the UNMAP flag:
3294 * - When set translate to DSM TRIM
3295 * - When clear translate to SCT Write Same
3297 static unsigned int ata_scsi_write_same_xlat(struct ata_queued_cmd *qc)
3299 struct ata_taskfile *tf = &qc->tf;
3300 struct scsi_cmnd *scmd = qc->scsicmd;
3301 struct scsi_device *sdp = scmd->device;
3302 size_t len = sdp->sector_size;
3303 struct ata_device *dev = qc->dev;
3304 const u8 *cdb = scmd->cmnd;
3307 const u32 trmax = len >> 3;
3311 u8 unmap = cdb[1] & 0x8;
3313 /* we may not issue DMA commands if no DMA mode is set */
3314 if (unlikely(!ata_dma_enabled(dev)))
3315 goto invalid_opcode;
3318 * We only allow sending this command through the block layer,
3319 * as it modifies the DATA OUT buffer, which would corrupt user
3320 * memory for SG_IO commands.
3322 if (unlikely(blk_rq_is_passthrough(scsi_cmd_to_rq(scmd))))
3323 goto invalid_opcode;
3325 if (unlikely(scmd->cmd_len < 16)) {
3329 scsi_16_lba_len(cdb, &block, &n_block);
3332 (dev->horkage & ATA_HORKAGE_NOTRIM) ||
3333 !ata_id_has_trim(dev->id)) {
3338 /* If the request is too large the cmd is invalid */
3339 if (n_block > 0xffff * trmax) {
3345 * WRITE SAME always has a sector sized buffer as payload, this
3346 * should never be a multiple entry S/G list.
3348 if (!scsi_sg_count(scmd))
3349 goto invalid_param_len;
3352 * size must match sector size in bytes
3353 * For DATA SET MANAGEMENT TRIM in ACS-2 nsect (aka count)
3354 * is defined as number of 512 byte blocks to be transferred.
3357 size = ata_format_dsm_trim_descr(scmd, trmax, block, n_block);
3359 goto invalid_param_len;
3361 if (ata_ncq_enabled(dev) && ata_fpdma_dsm_supported(dev)) {
3362 /* Newer devices support queued TRIM commands */
3363 tf->protocol = ATA_PROT_NCQ;
3364 tf->command = ATA_CMD_FPDMA_SEND;
3365 tf->hob_nsect = ATA_SUBCMD_FPDMA_SEND_DSM & 0x1f;
3366 tf->nsect = qc->hw_tag << 3;
3367 tf->hob_feature = (size / 512) >> 8;
3368 tf->feature = size / 512;
3372 tf->protocol = ATA_PROT_DMA;
3373 tf->hob_feature = 0;
3374 tf->feature = ATA_DSM_TRIM;
3375 tf->hob_nsect = (size / 512) >> 8;
3376 tf->nsect = size / 512;
3377 tf->command = ATA_CMD_DSM;
3380 tf->flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE | ATA_TFLAG_LBA48 |
3383 ata_qc_set_pc_nbytes(qc);
3388 ata_scsi_set_invalid_field(dev, scmd, fp, bp);
3391 /* "Parameter list length error" */
3392 ata_scsi_set_sense(dev, scmd, ILLEGAL_REQUEST, 0x1a, 0x0);
3395 /* "Invalid command operation code" */
3396 ata_scsi_set_sense(dev, scmd, ILLEGAL_REQUEST, 0x20, 0x0);
3401 * ata_scsiop_maint_in - Simulate a subset of MAINTENANCE_IN
3402 * @args: device MAINTENANCE_IN data / SCSI command of interest.
3403 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
3405 * Yields a subset to satisfy scsi_report_opcode()
3408 * spin_lock_irqsave(host lock)
3410 static unsigned int ata_scsiop_maint_in(struct ata_scsi_args *args, u8 *rbuf)
3412 struct ata_device *dev = args->dev;
3413 u8 *cdb = args->cmd->cmnd;
3414 u8 supported = 0, cdlp = 0, rwcdlp = 0;
3415 unsigned int err = 0;
3417 if (cdb[2] != 1 && cdb[2] != 3) {
3418 ata_dev_warn(dev, "invalid command format %d\n", cdb[2]);
3428 case SERVICE_ACTION_IN_16:
3431 case SYNCHRONIZE_CACHE:
3432 case SYNCHRONIZE_CACHE_16:
3436 case TEST_UNIT_READY:
3437 case SEND_DIAGNOSTIC:
3438 case MAINTENANCE_IN:
3448 case MODE_SELECT_10:
3454 if (dev->flags & ATA_DFLAG_CDL) {
3456 * CDL read descriptors map to the T2A page, that is,
3457 * rwcdlp = 0x01 and cdlp = 0x01
3465 if (dev->flags & ATA_DFLAG_CDL) {
3467 * CDL write descriptors map to the T2B page, that is,
3468 * rwcdlp = 0x01 and cdlp = 0x02
3476 if (ata_id_zoned_cap(dev->id) ||
3477 dev->class == ATA_DEV_ZAC)
3480 case SECURITY_PROTOCOL_IN:
3481 case SECURITY_PROTOCOL_OUT:
3482 if (dev->flags & ATA_DFLAG_TRUSTED)
3489 /* One command format */
3491 rbuf[1] = cdlp | supported;
3496 * ata_scsi_report_zones_complete - convert ATA output
3497 * @qc: command structure returning the data
3499 * Convert T-13 little-endian field representation into
3500 * T-10 big-endian field representation.
3503 static void ata_scsi_report_zones_complete(struct ata_queued_cmd *qc)
3505 struct scsi_cmnd *scmd = qc->scsicmd;
3506 struct sg_mapping_iter miter;
3507 unsigned long flags;
3508 unsigned int bytes = 0;
3510 sg_miter_start(&miter, scsi_sglist(scmd), scsi_sg_count(scmd),
3511 SG_MITER_TO_SG | SG_MITER_ATOMIC);
3513 local_irq_save(flags);
3514 while (sg_miter_next(&miter)) {
3515 unsigned int offset = 0;
3520 u64 max_lba, opt_lba;
3523 /* Swizzle header */
3525 list_length = get_unaligned_le32(&hdr[0]);
3526 same = get_unaligned_le16(&hdr[4]);
3527 max_lba = get_unaligned_le64(&hdr[8]);
3528 opt_lba = get_unaligned_le64(&hdr[16]);
3529 put_unaligned_be32(list_length, &hdr[0]);
3530 hdr[4] = same & 0xf;
3531 put_unaligned_be64(max_lba, &hdr[8]);
3532 put_unaligned_be64(opt_lba, &hdr[16]);
3536 while (offset < miter.length) {
3538 u8 cond, type, non_seq, reset;
3539 u64 size, start, wp;
3541 /* Swizzle zone descriptor */
3542 rec = miter.addr + offset;
3543 type = rec[0] & 0xf;
3544 cond = (rec[1] >> 4) & 0xf;
3545 non_seq = (rec[1] & 2);
3546 reset = (rec[1] & 1);
3547 size = get_unaligned_le64(&rec[8]);
3548 start = get_unaligned_le64(&rec[16]);
3549 wp = get_unaligned_le64(&rec[24]);
3551 rec[1] = (cond << 4) | non_seq | reset;
3552 put_unaligned_be64(size, &rec[8]);
3553 put_unaligned_be64(start, &rec[16]);
3554 put_unaligned_be64(wp, &rec[24]);
3555 WARN_ON(offset + 64 > miter.length);
3560 sg_miter_stop(&miter);
3561 local_irq_restore(flags);
3563 ata_scsi_qc_complete(qc);
3566 static unsigned int ata_scsi_zbc_in_xlat(struct ata_queued_cmd *qc)
3568 struct ata_taskfile *tf = &qc->tf;
3569 struct scsi_cmnd *scmd = qc->scsicmd;
3570 const u8 *cdb = scmd->cmnd;
3571 u16 sect, fp = (u16)-1;
3572 u8 sa, options, bp = 0xff;
3576 if (unlikely(scmd->cmd_len < 16)) {
3577 ata_dev_warn(qc->dev, "invalid cdb length %d\n",
3582 scsi_16_lba_len(cdb, &block, &n_block);
3583 if (n_block != scsi_bufflen(scmd)) {
3584 ata_dev_warn(qc->dev, "non-matching transfer count (%d/%d)\n",
3585 n_block, scsi_bufflen(scmd));
3586 goto invalid_param_len;
3589 if (sa != ZI_REPORT_ZONES) {
3590 ata_dev_warn(qc->dev, "invalid service action %d\n", sa);
3595 * ZAC allows only for transfers in 512 byte blocks,
3596 * and uses a 16 bit value for the transfer count.
3598 if ((n_block / 512) > 0xffff || n_block < 512 || (n_block % 512)) {
3599 ata_dev_warn(qc->dev, "invalid transfer count %d\n", n_block);
3600 goto invalid_param_len;
3602 sect = n_block / 512;
3603 options = cdb[14] & 0xbf;
3605 if (ata_ncq_enabled(qc->dev) &&
3606 ata_fpdma_zac_mgmt_in_supported(qc->dev)) {
3607 tf->protocol = ATA_PROT_NCQ;
3608 tf->command = ATA_CMD_FPDMA_RECV;
3609 tf->hob_nsect = ATA_SUBCMD_FPDMA_RECV_ZAC_MGMT_IN & 0x1f;
3610 tf->nsect = qc->hw_tag << 3;
3611 tf->feature = sect & 0xff;
3612 tf->hob_feature = (sect >> 8) & 0xff;
3613 tf->auxiliary = ATA_SUBCMD_ZAC_MGMT_IN_REPORT_ZONES | (options << 8);
3615 tf->command = ATA_CMD_ZAC_MGMT_IN;
3616 tf->feature = ATA_SUBCMD_ZAC_MGMT_IN_REPORT_ZONES;
3617 tf->protocol = ATA_PROT_DMA;
3618 tf->hob_feature = options;
3619 tf->hob_nsect = (sect >> 8) & 0xff;
3620 tf->nsect = sect & 0xff;
3622 tf->device = ATA_LBA;
3623 tf->lbah = (block >> 16) & 0xff;
3624 tf->lbam = (block >> 8) & 0xff;
3625 tf->lbal = block & 0xff;
3626 tf->hob_lbah = (block >> 40) & 0xff;
3627 tf->hob_lbam = (block >> 32) & 0xff;
3628 tf->hob_lbal = (block >> 24) & 0xff;
3630 tf->flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE | ATA_TFLAG_LBA48;
3631 qc->flags |= ATA_QCFLAG_RESULT_TF;
3633 ata_qc_set_pc_nbytes(qc);
3635 qc->complete_fn = ata_scsi_report_zones_complete;
3640 ata_scsi_set_invalid_field(qc->dev, scmd, fp, bp);
3644 /* "Parameter list length error" */
3645 ata_scsi_set_sense(qc->dev, scmd, ILLEGAL_REQUEST, 0x1a, 0x0);
3649 static unsigned int ata_scsi_zbc_out_xlat(struct ata_queued_cmd *qc)
3651 struct ata_taskfile *tf = &qc->tf;
3652 struct scsi_cmnd *scmd = qc->scsicmd;
3653 struct ata_device *dev = qc->dev;
3654 const u8 *cdb = scmd->cmnd;
3660 if (unlikely(scmd->cmd_len < 16)) {
3666 if ((sa != ZO_CLOSE_ZONE) && (sa != ZO_FINISH_ZONE) &&
3667 (sa != ZO_OPEN_ZONE) && (sa != ZO_RESET_WRITE_POINTER)) {
3672 scsi_16_lba_len(cdb, &block, &n_block);
3675 * ZAC MANAGEMENT OUT doesn't define any length
3677 goto invalid_param_len;
3680 all = cdb[14] & 0x1;
3683 * Ignore the block address (zone ID) as defined by ZBC.
3686 } else if (block >= dev->n_sectors) {
3688 * Block must be a valid zone ID (a zone start LBA).
3694 if (ata_ncq_enabled(qc->dev) &&
3695 ata_fpdma_zac_mgmt_out_supported(qc->dev)) {
3696 tf->protocol = ATA_PROT_NCQ_NODATA;
3697 tf->command = ATA_CMD_NCQ_NON_DATA;
3698 tf->feature = ATA_SUBCMD_NCQ_NON_DATA_ZAC_MGMT_OUT;
3699 tf->nsect = qc->hw_tag << 3;
3700 tf->auxiliary = sa | ((u16)all << 8);
3702 tf->protocol = ATA_PROT_NODATA;
3703 tf->command = ATA_CMD_ZAC_MGMT_OUT;
3705 tf->hob_feature = all;
3707 tf->lbah = (block >> 16) & 0xff;
3708 tf->lbam = (block >> 8) & 0xff;
3709 tf->lbal = block & 0xff;
3710 tf->hob_lbah = (block >> 40) & 0xff;
3711 tf->hob_lbam = (block >> 32) & 0xff;
3712 tf->hob_lbal = (block >> 24) & 0xff;
3713 tf->device = ATA_LBA;
3714 tf->flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE | ATA_TFLAG_LBA48;
3719 ata_scsi_set_invalid_field(qc->dev, scmd, fp, 0xff);
3722 /* "Parameter list length error" */
3723 ata_scsi_set_sense(qc->dev, scmd, ILLEGAL_REQUEST, 0x1a, 0x0);
3728 * ata_mselect_caching - Simulate MODE SELECT for caching info page
3729 * @qc: Storage for translated ATA taskfile
3730 * @buf: input buffer
3731 * @len: number of valid bytes in the input buffer
3732 * @fp: out parameter for the failed field on error
3734 * Prepare a taskfile to modify caching information for the device.
3739 static int ata_mselect_caching(struct ata_queued_cmd *qc,
3740 const u8 *buf, int len, u16 *fp)
3742 struct ata_taskfile *tf = &qc->tf;
3743 struct ata_device *dev = qc->dev;
3744 u8 mpage[CACHE_MPAGE_LEN];
3749 * The first two bytes of def_cache_mpage are a header, so offsets
3750 * in mpage are off by 2 compared to buf. Same for len.
3753 if (len != CACHE_MPAGE_LEN - 2) {
3754 *fp = min(len, CACHE_MPAGE_LEN - 2);
3758 wce = buf[0] & (1 << 2);
3761 * Check that read-only bits are not modified.
3763 ata_msense_caching(dev->id, mpage, false);
3764 for (i = 0; i < CACHE_MPAGE_LEN - 2; i++) {
3767 if (mpage[i + 2] != buf[i]) {
3773 tf->flags |= ATA_TFLAG_DEVICE | ATA_TFLAG_ISADDR;
3774 tf->protocol = ATA_PROT_NODATA;
3776 tf->command = ATA_CMD_SET_FEATURES;
3777 tf->feature = wce ? SETFEATURES_WC_ON : SETFEATURES_WC_OFF;
3782 * Simulate MODE SELECT control mode page, sub-page 0.
3784 static int ata_mselect_control_spg0(struct ata_queued_cmd *qc,
3785 const u8 *buf, int len, u16 *fp)
3787 struct ata_device *dev = qc->dev;
3788 u8 mpage[CONTROL_MPAGE_LEN];
3793 * The first two bytes of def_control_mpage are a header, so offsets
3794 * in mpage are off by 2 compared to buf. Same for len.
3797 if (len != CONTROL_MPAGE_LEN - 2) {
3798 *fp = min(len, CONTROL_MPAGE_LEN - 2);
3802 d_sense = buf[0] & (1 << 2);
3805 * Check that read-only bits are not modified.
3807 ata_msense_control_spg0(dev, mpage, false);
3808 for (i = 0; i < CONTROL_MPAGE_LEN - 2; i++) {
3811 if (mpage[2 + i] != buf[i]) {
3816 if (d_sense & (1 << 2))
3817 dev->flags |= ATA_DFLAG_D_SENSE;
3819 dev->flags &= ~ATA_DFLAG_D_SENSE;
3824 * Translate MODE SELECT control mode page, sub-pages f2h (ATA feature mode
3825 * page) into a SET FEATURES command.
3827 static unsigned int ata_mselect_control_ata_feature(struct ata_queued_cmd *qc,
3828 const u8 *buf, int len,
3831 struct ata_device *dev = qc->dev;
3832 struct ata_taskfile *tf = &qc->tf;
3836 * The first four bytes of ATA Feature Control mode page are a header,
3837 * so offsets in mpage are off by 4 compared to buf. Same for len.
3839 if (len != ATA_FEATURE_SUB_MPAGE_LEN - 4) {
3840 *fp = min(len, ATA_FEATURE_SUB_MPAGE_LEN - 4);
3844 /* Check cdl_ctrl */
3845 switch (buf[0] & 0x03) {
3849 dev->flags &= ~ATA_DFLAG_CDL_ENABLED;
3852 /* Enable CDL T2A/T2B: NCQ priority must be disabled */
3853 if (dev->flags & ATA_DFLAG_NCQ_PRIO_ENABLED) {
3855 "NCQ priority must be disabled to enable CDL\n");
3859 dev->flags |= ATA_DFLAG_CDL_ENABLED;
3866 tf->flags |= ATA_TFLAG_DEVICE | ATA_TFLAG_ISADDR;
3867 tf->protocol = ATA_PROT_NODATA;
3868 tf->command = ATA_CMD_SET_FEATURES;
3869 tf->feature = SETFEATURES_CDL;
3870 tf->nsect = cdl_action;
3876 * ata_mselect_control - Simulate MODE SELECT for control page
3877 * @qc: Storage for translated ATA taskfile
3878 * @spg: target sub-page of the control page
3879 * @buf: input buffer
3880 * @len: number of valid bytes in the input buffer
3881 * @fp: out parameter for the failed field on error
3883 * Prepare a taskfile to modify caching information for the device.
3888 static int ata_mselect_control(struct ata_queued_cmd *qc, u8 spg,
3889 const u8 *buf, int len, u16 *fp)
3893 return ata_mselect_control_spg0(qc, buf, len, fp);
3894 case ATA_FEATURE_SUB_MPAGE:
3895 return ata_mselect_control_ata_feature(qc, buf, len, fp);
3902 * ata_scsi_mode_select_xlat - Simulate MODE SELECT 6, 10 commands
3903 * @qc: Storage for translated ATA taskfile
3905 * Converts a MODE SELECT command to an ATA SET FEATURES taskfile.
3906 * Assume this is invoked for direct access devices (e.g. disks) only.
3907 * There should be no block descriptor for other device types.
3910 * spin_lock_irqsave(host lock)
3912 static unsigned int ata_scsi_mode_select_xlat(struct ata_queued_cmd *qc)
3914 struct scsi_cmnd *scmd = qc->scsicmd;
3915 const u8 *cdb = scmd->cmnd;
3917 unsigned six_byte, pg_len, hdr_len, bd_len;
3922 const u8 *p = buffer;
3924 six_byte = (cdb[0] == MODE_SELECT);
3926 if (scmd->cmd_len < 5) {
3934 if (scmd->cmd_len < 9) {
3939 len = get_unaligned_be16(&cdb[7]);
3943 /* We only support PF=1, SP=0. */
3944 if ((cdb[1] & 0x11) != 0x10) {
3946 bp = (cdb[1] & 0x01) ? 1 : 5;
3950 /* Test early for possible overrun. */
3951 if (!scsi_sg_count(scmd) || scsi_sglist(scmd)->length < len)
3952 goto invalid_param_len;
3954 /* Move past header and block descriptors. */
3956 goto invalid_param_len;
3958 if (!sg_copy_to_buffer(scsi_sglist(scmd), scsi_sg_count(scmd),
3959 buffer, sizeof(buffer)))
3960 goto invalid_param_len;
3965 bd_len = get_unaligned_be16(&p[6]);
3970 goto invalid_param_len;
3971 if (bd_len != 0 && bd_len != 8) {
3972 fp = (six_byte) ? 3 : 6;
3973 fp += bd_len + hdr_len;
3982 /* Parse both possible formats for the mode page headers. */
3986 goto invalid_param_len;
3989 pg_len = get_unaligned_be16(&p[2]);
3994 goto invalid_param_len;
4003 * Supported subpages: all subpages and ATA feature sub-page f2h of
4008 case ALL_SUB_MPAGES:
4009 /* All subpages is not supported for the control page */
4010 if (pg == CONTROL_MPAGE) {
4011 fp = (p[0] & 0x40) ? 1 : 0;
4012 fp += hdr_len + bd_len;
4016 case ATA_FEATURE_SUB_MPAGE:
4017 if (qc->dev->flags & ATA_DFLAG_CDL &&
4018 pg == CONTROL_MPAGE)
4022 fp = (p[0] & 0x40) ? 1 : 0;
4023 fp += hdr_len + bd_len;
4028 goto invalid_param_len;
4032 if (ata_mselect_caching(qc, p, pg_len, &fp) < 0) {
4033 fp += hdr_len + bd_len;
4038 ret = ata_mselect_control(qc, spg, p, pg_len, &fp);
4040 fp += hdr_len + bd_len;
4044 goto skip; /* No ATA command to send */
4047 /* Invalid page code */
4048 fp = bd_len + hdr_len;
4053 * Only one page has changeable data, so we only support setting one
4062 ata_scsi_set_invalid_field(qc->dev, scmd, fp, bp);
4066 ata_scsi_set_invalid_parameter(qc->dev, scmd, fp);
4070 /* "Parameter list length error" */
4071 ata_scsi_set_sense(qc->dev, scmd, ILLEGAL_REQUEST, 0x1a, 0x0);
4075 scmd->result = SAM_STAT_GOOD;
4079 static u8 ata_scsi_trusted_op(u32 len, bool send, bool dma)
4082 return ATA_CMD_TRUSTED_NONDATA;
4084 return dma ? ATA_CMD_TRUSTED_SND_DMA : ATA_CMD_TRUSTED_SND;
4086 return dma ? ATA_CMD_TRUSTED_RCV_DMA : ATA_CMD_TRUSTED_RCV;
4089 static unsigned int ata_scsi_security_inout_xlat(struct ata_queued_cmd *qc)
4091 struct scsi_cmnd *scmd = qc->scsicmd;
4092 const u8 *cdb = scmd->cmnd;
4093 struct ata_taskfile *tf = &qc->tf;
4095 bool send = (cdb[0] == SECURITY_PROTOCOL_OUT);
4096 u16 spsp = get_unaligned_be16(&cdb[2]);
4097 u32 len = get_unaligned_be32(&cdb[6]);
4098 bool dma = !(qc->dev->flags & ATA_DFLAG_PIO);
4101 * We don't support the ATA "security" protocol.
4104 ata_scsi_set_invalid_field(qc->dev, scmd, 1, 0);
4108 if (cdb[4] & 7) { /* INC_512 */
4110 ata_scsi_set_invalid_field(qc->dev, scmd, 6, 0);
4114 if (len > 0x01fffe00) {
4115 ata_scsi_set_invalid_field(qc->dev, scmd, 6, 0);
4119 /* convert to the sector-based ATA addressing */
4120 len = (len + 511) / 512;
4123 tf->protocol = dma ? ATA_PROT_DMA : ATA_PROT_PIO;
4124 tf->flags |= ATA_TFLAG_DEVICE | ATA_TFLAG_ISADDR | ATA_TFLAG_LBA;
4126 tf->flags |= ATA_TFLAG_WRITE;
4127 tf->command = ata_scsi_trusted_op(len, send, dma);
4129 tf->lbam = spsp & 0xff;
4130 tf->lbah = spsp >> 8;
4133 tf->nsect = len & 0xff;
4134 tf->lbal = len >> 8;
4137 tf->lbah = (1 << 7);
4140 ata_qc_set_pc_nbytes(qc);
4145 * ata_scsi_var_len_cdb_xlat - SATL variable length CDB to Handler
4146 * @qc: Command to be translated
4148 * Translate a SCSI variable length CDB to specified commands.
4149 * It checks a service action value in CDB to call corresponding handler.
4152 * Zero on success, non-zero on failure
4155 static unsigned int ata_scsi_var_len_cdb_xlat(struct ata_queued_cmd *qc)
4157 struct scsi_cmnd *scmd = qc->scsicmd;
4158 const u8 *cdb = scmd->cmnd;
4159 const u16 sa = get_unaligned_be16(&cdb[8]);
4162 * if service action represents a ata pass-thru(32) command,
4163 * then pass it to ata_scsi_pass_thru handler.
4166 return ata_scsi_pass_thru(qc);
4168 /* unsupported service action */
4173 * ata_get_xlat_func - check if SCSI to ATA translation is possible
4175 * @cmd: SCSI command opcode to consider
4177 * Look up the SCSI command given, and determine whether the
4178 * SCSI command is to be translated or simulated.
4181 * Pointer to translation function if possible, %NULL if not.
4184 static inline ata_xlat_func_t ata_get_xlat_func(struct ata_device *dev, u8 cmd)
4194 return ata_scsi_rw_xlat;
4197 return ata_scsi_write_same_xlat;
4199 case SYNCHRONIZE_CACHE:
4200 case SYNCHRONIZE_CACHE_16:
4201 if (ata_try_flush_cache(dev))
4202 return ata_scsi_flush_xlat;
4207 return ata_scsi_verify_xlat;
4211 return ata_scsi_pass_thru;
4213 case VARIABLE_LENGTH_CMD:
4214 return ata_scsi_var_len_cdb_xlat;
4217 case MODE_SELECT_10:
4218 return ata_scsi_mode_select_xlat;
4221 return ata_scsi_zbc_in_xlat;
4224 return ata_scsi_zbc_out_xlat;
4226 case SECURITY_PROTOCOL_IN:
4227 case SECURITY_PROTOCOL_OUT:
4228 if (!(dev->flags & ATA_DFLAG_TRUSTED))
4230 return ata_scsi_security_inout_xlat;
4233 return ata_scsi_start_stop_xlat;
4239 int __ata_scsi_queuecmd(struct scsi_cmnd *scmd, struct ata_device *dev)
4241 struct ata_port *ap = dev->link->ap;
4242 u8 scsi_op = scmd->cmnd[0];
4243 ata_xlat_func_t xlat_func;
4246 * scsi_queue_rq() will defer commands if scsi_host_in_recovery().
4247 * However, this check is done without holding the ap->lock (a libata
4248 * specific lock), so we can have received an error irq since then,
4249 * therefore we must check if EH is pending, while holding ap->lock.
4251 if (ap->pflags & (ATA_PFLAG_EH_PENDING | ATA_PFLAG_EH_IN_PROGRESS))
4252 return SCSI_MLQUEUE_DEVICE_BUSY;
4254 if (unlikely(!scmd->cmd_len))
4257 if (dev->class == ATA_DEV_ATA || dev->class == ATA_DEV_ZAC) {
4258 if (unlikely(scmd->cmd_len > dev->cdb_len))
4261 xlat_func = ata_get_xlat_func(dev, scsi_op);
4262 } else if (likely((scsi_op != ATA_16) || !atapi_passthru16)) {
4263 /* relay SCSI command to ATAPI device */
4264 int len = COMMAND_SIZE(scsi_op);
4266 if (unlikely(len > scmd->cmd_len ||
4267 len > dev->cdb_len ||
4268 scmd->cmd_len > ATAPI_CDB_LEN))
4271 xlat_func = atapi_xlat;
4273 /* ATA_16 passthru, treat as an ATA command */
4274 if (unlikely(scmd->cmd_len > 16))
4277 xlat_func = ata_get_xlat_func(dev, scsi_op);
4281 return ata_scsi_translate(dev, scmd, xlat_func);
4283 ata_scsi_simulate(dev, scmd);
4288 scmd->result = DID_ERROR << 16;
4294 * ata_scsi_queuecmd - Issue SCSI cdb to libata-managed device
4295 * @shost: SCSI host of command to be sent
4296 * @cmd: SCSI command to be sent
4298 * In some cases, this function translates SCSI commands into
4299 * ATA taskfiles, and queues the taskfiles to be sent to
4300 * hardware. In other cases, this function simulates a
4301 * SCSI device by evaluating and responding to certain
4302 * SCSI commands. This creates the overall effect of
4303 * ATA and ATAPI devices appearing as SCSI devices.
4309 * Return value from __ata_scsi_queuecmd() if @cmd can be queued,
4312 int ata_scsi_queuecmd(struct Scsi_Host *shost, struct scsi_cmnd *cmd)
4314 struct ata_port *ap;
4315 struct ata_device *dev;
4316 struct scsi_device *scsidev = cmd->device;
4318 unsigned long irq_flags;
4320 ap = ata_shost_to_port(shost);
4322 spin_lock_irqsave(ap->lock, irq_flags);
4324 dev = ata_scsi_find_dev(ap, scsidev);
4326 rc = __ata_scsi_queuecmd(cmd, dev);
4328 cmd->result = (DID_BAD_TARGET << 16);
4332 spin_unlock_irqrestore(ap->lock, irq_flags);
4336 EXPORT_SYMBOL_GPL(ata_scsi_queuecmd);
4339 * ata_scsi_simulate - simulate SCSI command on ATA device
4340 * @dev: the target device
4341 * @cmd: SCSI command being sent to device.
4343 * Interprets and directly executes a select list of SCSI commands
4344 * that can be handled internally.
4347 * spin_lock_irqsave(host lock)
4350 void ata_scsi_simulate(struct ata_device *dev, struct scsi_cmnd *cmd)
4352 struct ata_scsi_args args;
4353 const u8 *scsicmd = cmd->cmnd;
4360 switch(scsicmd[0]) {
4362 if (scsicmd[1] & 2) /* is CmdDt set? */
4363 ata_scsi_set_invalid_field(dev, cmd, 1, 0xff);
4364 else if ((scsicmd[1] & 1) == 0) /* is EVPD clear? */
4365 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_std);
4366 else switch (scsicmd[2]) {
4368 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_00);
4371 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_80);
4374 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_83);
4377 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_89);
4380 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_b0);
4383 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_b1);
4386 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_b2);
4389 if (dev->flags & ATA_DFLAG_ZAC)
4390 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_b6);
4392 ata_scsi_set_invalid_field(dev, cmd, 2, 0xff);
4396 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_b9);
4398 ata_scsi_set_invalid_field(dev, cmd, 2, 0xff);
4401 ata_scsi_set_invalid_field(dev, cmd, 2, 0xff);
4408 ata_scsi_rbuf_fill(&args, ata_scsiop_mode_sense);
4412 ata_scsi_rbuf_fill(&args, ata_scsiop_read_cap);
4415 case SERVICE_ACTION_IN_16:
4416 if ((scsicmd[1] & 0x1f) == SAI_READ_CAPACITY_16)
4417 ata_scsi_rbuf_fill(&args, ata_scsiop_read_cap);
4419 ata_scsi_set_invalid_field(dev, cmd, 1, 0xff);
4423 ata_scsi_rbuf_fill(&args, ata_scsiop_report_luns);
4427 ata_scsi_set_sense(dev, cmd, 0, 0, 0);
4430 /* if we reach this, then writeback caching is disabled,
4431 * turning this into a no-op.
4433 case SYNCHRONIZE_CACHE:
4434 case SYNCHRONIZE_CACHE_16:
4437 /* no-op's, complete with success */
4441 case TEST_UNIT_READY:
4444 case SEND_DIAGNOSTIC:
4445 tmp8 = scsicmd[1] & ~(1 << 3);
4446 if (tmp8 != 0x4 || scsicmd[3] || scsicmd[4])
4447 ata_scsi_set_invalid_field(dev, cmd, 1, 0xff);
4450 case MAINTENANCE_IN:
4451 if (scsicmd[1] == MI_REPORT_SUPPORTED_OPERATION_CODES)
4452 ata_scsi_rbuf_fill(&args, ata_scsiop_maint_in);
4454 ata_scsi_set_invalid_field(dev, cmd, 1, 0xff);
4457 /* all other commands */
4459 ata_scsi_set_sense(dev, cmd, ILLEGAL_REQUEST, 0x20, 0x0);
4460 /* "Invalid command operation code" */
4467 int ata_scsi_add_hosts(struct ata_host *host, const struct scsi_host_template *sht)
4471 for (i = 0; i < host->n_ports; i++) {
4472 struct ata_port *ap = host->ports[i];
4473 struct Scsi_Host *shost;
4476 shost = scsi_host_alloc(sht, sizeof(struct ata_port *));
4480 shost->eh_noresume = 1;
4481 *(struct ata_port **)&shost->hostdata[0] = ap;
4482 ap->scsi_host = shost;
4484 shost->transportt = ata_scsi_transport_template;
4485 shost->unique_id = ap->print_id;
4488 shost->max_channel = 1;
4489 shost->max_cmd_len = 32;
4491 /* Schedule policy is determined by ->qc_defer()
4492 * callback and it needs to see every deferred qc.
4493 * Set host_blocked to 1 to prevent SCSI midlayer from
4494 * automatically deferring requests.
4496 shost->max_host_blocked = 1;
4498 rc = scsi_add_host_with_dma(shost, &ap->tdev, ap->host->dev);
4507 struct Scsi_Host *shost = host->ports[i]->scsi_host;
4509 /* scsi_host_put() is in ata_devres_release() */
4510 scsi_remove_host(shost);
4516 static void ata_scsi_assign_ofnode(struct ata_device *dev, struct ata_port *ap)
4518 struct scsi_device *sdev = dev->sdev;
4519 struct device *d = ap->host->dev;
4520 struct device_node *np = d->of_node;
4521 struct device_node *child;
4523 for_each_available_child_of_node(np, child) {
4527 ret = of_property_read_u32(child, "reg", &val);
4530 if (val == dev->devno) {
4531 dev_dbg(d, "found matching device node\n");
4532 sdev->sdev_gendev.of_node = child;
4538 static void ata_scsi_assign_ofnode(struct ata_device *dev, struct ata_port *ap)
4543 void ata_scsi_scan_host(struct ata_port *ap, int sync)
4546 struct ata_device *last_failed_dev = NULL;
4547 struct ata_link *link;
4548 struct ata_device *dev;
4551 ata_for_each_link(link, ap, EDGE) {
4552 ata_for_each_dev(dev, link, ENABLED) {
4553 struct scsi_device *sdev;
4554 int channel = 0, id = 0;
4559 if (ata_is_host_link(link))
4562 channel = link->pmp;
4564 sdev = __scsi_add_device(ap->scsi_host, channel, id, 0,
4566 if (!IS_ERR(sdev)) {
4568 ata_scsi_assign_ofnode(dev, ap);
4569 scsi_device_put(sdev);
4576 /* If we scanned while EH was in progress or allocation
4577 * failure occurred, scan would have failed silently. Check
4578 * whether all devices are attached.
4580 ata_for_each_link(link, ap, EDGE) {
4581 ata_for_each_dev(dev, link, ENABLED) {
4590 /* we're missing some SCSI devices */
4592 /* If caller requested synchrnous scan && we've made
4593 * any progress, sleep briefly and repeat.
4595 if (dev != last_failed_dev) {
4597 last_failed_dev = dev;
4601 /* We might be failing to detect boot device, give it
4602 * a few more chances.
4610 "WARNING: synchronous SCSI scan failed without making any progress, switching to async\n");
4613 queue_delayed_work(system_long_wq, &ap->hotplug_task,
4614 round_jiffies_relative(HZ));
4618 * ata_scsi_offline_dev - offline attached SCSI device
4619 * @dev: ATA device to offline attached SCSI device for
4621 * This function is called from ata_eh_hotplug() and responsible
4622 * for taking the SCSI device attached to @dev offline. This
4623 * function is called with host lock which protects dev->sdev
4627 * spin_lock_irqsave(host lock)
4630 * 1 if attached SCSI device exists, 0 otherwise.
4632 int ata_scsi_offline_dev(struct ata_device *dev)
4635 scsi_device_set_state(dev->sdev, SDEV_OFFLINE);
4642 * ata_scsi_remove_dev - remove attached SCSI device
4643 * @dev: ATA device to remove attached SCSI device for
4645 * This function is called from ata_eh_scsi_hotplug() and
4646 * responsible for removing the SCSI device attached to @dev.
4649 * Kernel thread context (may sleep).
4651 static void ata_scsi_remove_dev(struct ata_device *dev)
4653 struct ata_port *ap = dev->link->ap;
4654 struct scsi_device *sdev;
4655 unsigned long flags;
4657 /* Alas, we need to grab scan_mutex to ensure SCSI device
4658 * state doesn't change underneath us and thus
4659 * scsi_device_get() always succeeds. The mutex locking can
4660 * be removed if there is __scsi_device_get() interface which
4661 * increments reference counts regardless of device state.
4663 mutex_lock(&ap->scsi_host->scan_mutex);
4664 spin_lock_irqsave(ap->lock, flags);
4666 /* clearing dev->sdev is protected by host lock */
4671 /* If user initiated unplug races with us, sdev can go
4672 * away underneath us after the host lock and
4673 * scan_mutex are released. Hold onto it.
4675 if (scsi_device_get(sdev) == 0) {
4676 /* The following ensures the attached sdev is
4677 * offline on return from ata_scsi_offline_dev()
4678 * regardless it wins or loses the race
4679 * against this function.
4681 scsi_device_set_state(sdev, SDEV_OFFLINE);
4688 spin_unlock_irqrestore(ap->lock, flags);
4689 mutex_unlock(&ap->scsi_host->scan_mutex);
4692 ata_dev_info(dev, "detaching (SCSI %s)\n",
4693 dev_name(&sdev->sdev_gendev));
4695 scsi_remove_device(sdev);
4696 scsi_device_put(sdev);
4700 static void ata_scsi_handle_link_detach(struct ata_link *link)
4702 struct ata_port *ap = link->ap;
4703 struct ata_device *dev;
4705 ata_for_each_dev(dev, link, ALL) {
4706 unsigned long flags;
4708 if (!(dev->flags & ATA_DFLAG_DETACHED))
4711 spin_lock_irqsave(ap->lock, flags);
4712 dev->flags &= ~ATA_DFLAG_DETACHED;
4713 spin_unlock_irqrestore(ap->lock, flags);
4715 if (zpodd_dev_enabled(dev))
4718 ata_scsi_remove_dev(dev);
4723 * ata_scsi_media_change_notify - send media change event
4724 * @dev: Pointer to the disk device with media change event
4726 * Tell the block layer to send a media change notification
4730 * spin_lock_irqsave(host lock)
4732 void ata_scsi_media_change_notify(struct ata_device *dev)
4735 sdev_evt_send_simple(dev->sdev, SDEV_EVT_MEDIA_CHANGE,
4740 * ata_scsi_hotplug - SCSI part of hotplug
4741 * @work: Pointer to ATA port to perform SCSI hotplug on
4743 * Perform SCSI part of hotplug. It's executed from a separate
4744 * workqueue after EH completes. This is necessary because SCSI
4745 * hot plugging requires working EH and hot unplugging is
4746 * synchronized with hot plugging with a mutex.
4749 * Kernel thread context (may sleep).
4751 void ata_scsi_hotplug(struct work_struct *work)
4753 struct ata_port *ap =
4754 container_of(work, struct ata_port, hotplug_task.work);
4757 if (ap->pflags & ATA_PFLAG_UNLOADING)
4760 mutex_lock(&ap->scsi_scan_mutex);
4762 /* Unplug detached devices. We cannot use link iterator here
4763 * because PMP links have to be scanned even if PMP is
4764 * currently not attached. Iterate manually.
4766 ata_scsi_handle_link_detach(&ap->link);
4768 for (i = 0; i < SATA_PMP_MAX_PORTS; i++)
4769 ata_scsi_handle_link_detach(&ap->pmp_link[i]);
4771 /* scan for new ones */
4772 ata_scsi_scan_host(ap, 0);
4774 mutex_unlock(&ap->scsi_scan_mutex);
4778 * ata_scsi_user_scan - indication for user-initiated bus scan
4779 * @shost: SCSI host to scan
4780 * @channel: Channel to scan
4784 * This function is called when user explicitly requests bus
4785 * scan. Set probe pending flag and invoke EH.
4788 * SCSI layer (we don't care)
4793 int ata_scsi_user_scan(struct Scsi_Host *shost, unsigned int channel,
4794 unsigned int id, u64 lun)
4796 struct ata_port *ap = ata_shost_to_port(shost);
4797 unsigned long flags;
4800 if (!ap->ops->error_handler)
4803 if (lun != SCAN_WILD_CARD && lun)
4806 if (!sata_pmp_attached(ap)) {
4807 if (channel != SCAN_WILD_CARD && channel)
4811 if (id != SCAN_WILD_CARD && id)
4816 spin_lock_irqsave(ap->lock, flags);
4818 if (devno == SCAN_WILD_CARD) {
4819 struct ata_link *link;
4821 ata_for_each_link(link, ap, EDGE) {
4822 struct ata_eh_info *ehi = &link->eh_info;
4823 ehi->probe_mask |= ATA_ALL_DEVICES;
4824 ehi->action |= ATA_EH_RESET;
4827 struct ata_device *dev = ata_find_dev(ap, devno);
4830 struct ata_eh_info *ehi = &dev->link->eh_info;
4831 ehi->probe_mask |= 1 << dev->devno;
4832 ehi->action |= ATA_EH_RESET;
4838 ata_port_schedule_eh(ap);
4839 spin_unlock_irqrestore(ap->lock, flags);
4840 ata_port_wait_eh(ap);
4842 spin_unlock_irqrestore(ap->lock, flags);
4848 * ata_scsi_dev_rescan - initiate scsi_rescan_device()
4849 * @work: Pointer to ATA port to perform scsi_rescan_device()
4851 * After ATA pass thru (SAT) commands are executed successfully,
4852 * libata need to propagate the changes to SCSI layer.
4855 * Kernel thread context (may sleep).
4857 void ata_scsi_dev_rescan(struct work_struct *work)
4859 struct ata_port *ap =
4860 container_of(work, struct ata_port, scsi_rescan_task.work);
4861 struct ata_link *link;
4862 struct ata_device *dev;
4863 unsigned long flags;
4864 bool delay_rescan = false;
4866 mutex_lock(&ap->scsi_scan_mutex);
4867 spin_lock_irqsave(ap->lock, flags);
4869 ata_for_each_link(link, ap, EDGE) {
4870 ata_for_each_dev(dev, link, ENABLED) {
4871 struct scsi_device *sdev = dev->sdev;
4875 if (scsi_device_get(sdev))
4879 * If the rescan work was scheduled because of a resume
4880 * event, the port is already fully resumed, but the
4881 * SCSI device may not yet be fully resumed. In such
4882 * case, executing scsi_rescan_device() may cause a
4883 * deadlock with the PM code on device_lock(). Prevent
4884 * this by giving up and retrying rescan after a short
4887 delay_rescan = sdev->sdev_gendev.power.is_suspended;
4889 scsi_device_put(sdev);
4893 spin_unlock_irqrestore(ap->lock, flags);
4894 scsi_rescan_device(&(sdev->sdev_gendev));
4895 scsi_device_put(sdev);
4896 spin_lock_irqsave(ap->lock, flags);
4900 spin_unlock_irqrestore(ap->lock, flags);
4901 mutex_unlock(&ap->scsi_scan_mutex);
4904 schedule_delayed_work(&ap->scsi_rescan_task,
4905 msecs_to_jiffies(5));