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 576
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
60 static const u8 def_rw_recovery_mpage[RW_RECOVERY_MPAGE_LEN] = {
62 RW_RECOVERY_MPAGE_LEN - 2,
64 0, /* read retry count */
66 0, /* write retry count */
70 static const u8 def_cache_mpage[CACHE_MPAGE_LEN] = {
73 0, /* contains WCE, needs to be 0 for logic */
74 0, 0, 0, 0, 0, 0, 0, 0, 0,
75 0, /* contains DRA, needs to be 0 for logic */
79 static const u8 def_control_mpage[CONTROL_MPAGE_LEN] = {
81 CONTROL_MPAGE_LEN - 2,
82 2, /* DSENSE=0, GLTSD=1 */
83 0, /* [QAM+QERR may be 1, see 05-359r1] */
84 0, 0, 0, 0, 0xff, 0xff,
85 0, 30 /* extended self test time, see 05-359r1 */
88 static ssize_t ata_scsi_park_show(struct device *device,
89 struct device_attribute *attr, char *buf)
91 struct scsi_device *sdev = to_scsi_device(device);
93 struct ata_link *link;
94 struct ata_device *dev;
99 ap = ata_shost_to_port(sdev->host);
101 spin_lock_irq(ap->lock);
102 dev = ata_scsi_find_dev(ap, sdev);
107 if (dev->flags & ATA_DFLAG_NO_UNLOAD) {
114 if (ap->pflags & ATA_PFLAG_EH_IN_PROGRESS &&
115 link->eh_context.unloaded_mask & (1 << dev->devno) &&
116 time_after(dev->unpark_deadline, now))
117 msecs = jiffies_to_msecs(dev->unpark_deadline - now);
122 spin_unlock_irq(ap->lock);
124 return rc ? rc : snprintf(buf, 20, "%u\n", msecs);
127 static ssize_t ata_scsi_park_store(struct device *device,
128 struct device_attribute *attr,
129 const char *buf, size_t len)
131 struct scsi_device *sdev = to_scsi_device(device);
133 struct ata_device *dev;
138 rc = kstrtol(buf, 10, &input);
143 if (input > ATA_TMOUT_MAX_PARK) {
145 input = ATA_TMOUT_MAX_PARK;
148 ap = ata_shost_to_port(sdev->host);
150 spin_lock_irqsave(ap->lock, flags);
151 dev = ata_scsi_find_dev(ap, sdev);
152 if (unlikely(!dev)) {
156 if (dev->class != ATA_DEV_ATA &&
157 dev->class != ATA_DEV_ZAC) {
163 if (dev->flags & ATA_DFLAG_NO_UNLOAD) {
168 dev->unpark_deadline = ata_deadline(jiffies, input);
169 dev->link->eh_info.dev_action[dev->devno] |= ATA_EH_PARK;
170 ata_port_schedule_eh(ap);
171 complete(&ap->park_req_pending);
175 dev->flags &= ~ATA_DFLAG_NO_UNLOAD;
178 dev->flags |= ATA_DFLAG_NO_UNLOAD;
183 spin_unlock_irqrestore(ap->lock, flags);
185 return rc ? rc : len;
187 DEVICE_ATTR(unload_heads, S_IRUGO | S_IWUSR,
188 ata_scsi_park_show, ata_scsi_park_store);
189 EXPORT_SYMBOL_GPL(dev_attr_unload_heads);
191 void ata_scsi_set_sense(struct ata_device *dev, struct scsi_cmnd *cmd,
192 u8 sk, u8 asc, u8 ascq)
194 bool d_sense = (dev->flags & ATA_DFLAG_D_SENSE);
199 scsi_build_sense(cmd, d_sense, sk, asc, ascq);
202 void ata_scsi_set_sense_information(struct ata_device *dev,
203 struct scsi_cmnd *cmd,
204 const struct ata_taskfile *tf)
211 information = ata_tf_read_block(tf, dev);
212 if (information == U64_MAX)
215 scsi_set_sense_information(cmd->sense_buffer,
216 SCSI_SENSE_BUFFERSIZE, information);
219 static void ata_scsi_set_invalid_field(struct ata_device *dev,
220 struct scsi_cmnd *cmd, u16 field, u8 bit)
222 ata_scsi_set_sense(dev, cmd, ILLEGAL_REQUEST, 0x24, 0x0);
223 /* "Invalid field in CDB" */
224 scsi_set_sense_field_pointer(cmd->sense_buffer, SCSI_SENSE_BUFFERSIZE,
228 static void ata_scsi_set_invalid_parameter(struct ata_device *dev,
229 struct scsi_cmnd *cmd, u16 field)
231 /* "Invalid field in parameter list" */
232 ata_scsi_set_sense(dev, cmd, ILLEGAL_REQUEST, 0x26, 0x0);
233 scsi_set_sense_field_pointer(cmd->sense_buffer, SCSI_SENSE_BUFFERSIZE,
237 struct device_attribute *ata_common_sdev_attrs[] = {
238 &dev_attr_unload_heads,
241 EXPORT_SYMBOL_GPL(ata_common_sdev_attrs);
244 * ata_std_bios_param - generic bios head/sector/cylinder calculator used by sd.
245 * @sdev: SCSI device for which BIOS geometry is to be determined
246 * @bdev: block device associated with @sdev
247 * @capacity: capacity of SCSI device
248 * @geom: location to which geometry will be output
250 * Generic bios head/sector/cylinder calculator
251 * used by sd. Most BIOSes nowadays expect a XXX/255/16 (CHS)
252 * mapping. Some situations may arise where the disk is not
253 * bootable if this is not used.
256 * Defined by the SCSI layer. We don't really care.
261 int ata_std_bios_param(struct scsi_device *sdev, struct block_device *bdev,
262 sector_t capacity, int geom[])
266 sector_div(capacity, 255*63);
271 EXPORT_SYMBOL_GPL(ata_std_bios_param);
274 * ata_scsi_unlock_native_capacity - unlock native capacity
275 * @sdev: SCSI device to adjust device capacity for
277 * This function is called if a partition on @sdev extends beyond
278 * the end of the device. It requests EH to unlock HPA.
281 * Defined by the SCSI layer. Might sleep.
283 void ata_scsi_unlock_native_capacity(struct scsi_device *sdev)
285 struct ata_port *ap = ata_shost_to_port(sdev->host);
286 struct ata_device *dev;
289 spin_lock_irqsave(ap->lock, flags);
291 dev = ata_scsi_find_dev(ap, sdev);
292 if (dev && dev->n_sectors < dev->n_native_sectors) {
293 dev->flags |= ATA_DFLAG_UNLOCK_HPA;
294 dev->link->eh_info.action |= ATA_EH_RESET;
295 ata_port_schedule_eh(ap);
298 spin_unlock_irqrestore(ap->lock, flags);
299 ata_port_wait_eh(ap);
301 EXPORT_SYMBOL_GPL(ata_scsi_unlock_native_capacity);
304 * ata_get_identity - Handler for HDIO_GET_IDENTITY ioctl
306 * @sdev: SCSI device to get identify data for
307 * @arg: User buffer area for identify data
310 * Defined by the SCSI layer. We don't really care.
313 * Zero on success, negative errno on error.
315 static int ata_get_identity(struct ata_port *ap, struct scsi_device *sdev,
318 struct ata_device *dev = ata_scsi_find_dev(ap, sdev);
319 u16 __user *dst = arg;
325 if (copy_to_user(dst, dev->id, ATA_ID_WORDS * sizeof(u16)))
328 ata_id_string(dev->id, buf, ATA_ID_PROD, ATA_ID_PROD_LEN);
329 if (copy_to_user(dst + ATA_ID_PROD, buf, ATA_ID_PROD_LEN))
332 ata_id_string(dev->id, buf, ATA_ID_FW_REV, ATA_ID_FW_REV_LEN);
333 if (copy_to_user(dst + ATA_ID_FW_REV, buf, ATA_ID_FW_REV_LEN))
336 ata_id_string(dev->id, buf, ATA_ID_SERNO, ATA_ID_SERNO_LEN);
337 if (copy_to_user(dst + ATA_ID_SERNO, buf, ATA_ID_SERNO_LEN))
344 * ata_cmd_ioctl - Handler for HDIO_DRIVE_CMD ioctl
345 * @scsidev: Device to which we are issuing command
346 * @arg: User provided data for issuing command
349 * Defined by the SCSI layer. We don't really care.
352 * Zero on success, negative errno on error.
354 int ata_cmd_ioctl(struct scsi_device *scsidev, void __user *arg)
357 u8 sensebuf[SCSI_SENSE_BUFFERSIZE];
358 u8 scsi_cmd[MAX_COMMAND_SIZE];
359 u8 args[4], *argbuf = NULL;
361 enum dma_data_direction data_dir;
362 struct scsi_sense_hdr sshdr;
368 if (copy_from_user(args, arg, sizeof(args)))
371 memset(sensebuf, 0, sizeof(sensebuf));
372 memset(scsi_cmd, 0, sizeof(scsi_cmd));
375 argsize = ATA_SECT_SIZE * args[3];
376 argbuf = kmalloc(argsize, GFP_KERNEL);
377 if (argbuf == NULL) {
382 scsi_cmd[1] = (4 << 1); /* PIO Data-in */
383 scsi_cmd[2] = 0x0e; /* no off.line or cc, read from dev,
384 block count in sector count field */
385 data_dir = DMA_FROM_DEVICE;
387 scsi_cmd[1] = (3 << 1); /* Non-data */
388 scsi_cmd[2] = 0x20; /* cc but no off.line or data xfer */
392 scsi_cmd[0] = ATA_16;
394 scsi_cmd[4] = args[2];
395 if (args[0] == ATA_CMD_SMART) { /* hack -- ide driver does this too */
396 scsi_cmd[6] = args[3];
397 scsi_cmd[8] = args[1];
398 scsi_cmd[10] = ATA_SMART_LBAM_PASS;
399 scsi_cmd[12] = ATA_SMART_LBAH_PASS;
401 scsi_cmd[6] = args[1];
403 scsi_cmd[14] = args[0];
405 /* Good values for timeout and retries? Values below
406 from scsi_ioctl_send_command() for default case... */
407 cmd_result = scsi_execute(scsidev, scsi_cmd, data_dir, argbuf, argsize,
408 sensebuf, &sshdr, (10*HZ), 5, 0, 0, NULL);
410 if (cmd_result < 0) {
414 if (scsi_sense_valid(&sshdr)) {/* sense data available */
415 u8 *desc = sensebuf + 8;
417 /* If we set cc then ATA pass-through will cause a
418 * check condition even if no error. Filter that. */
419 if (scsi_status_is_check_condition(cmd_result)) {
420 if (sshdr.sense_key == RECOVERED_ERROR &&
421 sshdr.asc == 0 && sshdr.ascq == 0x1d)
422 cmd_result &= ~SAM_STAT_CHECK_CONDITION;
425 /* Send userspace a few ATA registers (same as drivers/ide) */
426 if (sensebuf[0] == 0x72 && /* format is "descriptor" */
427 desc[0] == 0x09) { /* code is "ATA Descriptor" */
428 args[0] = desc[13]; /* status */
429 args[1] = desc[3]; /* error */
430 args[2] = desc[5]; /* sector count (0:7) */
431 if (copy_to_user(arg, args, sizeof(args)))
443 && copy_to_user(arg + sizeof(args), argbuf, argsize))
451 * ata_task_ioctl - Handler for HDIO_DRIVE_TASK ioctl
452 * @scsidev: Device to which we are issuing command
453 * @arg: User provided data for issuing command
456 * Defined by the SCSI layer. We don't really care.
459 * Zero on success, negative errno on error.
461 int ata_task_ioctl(struct scsi_device *scsidev, void __user *arg)
464 u8 sensebuf[SCSI_SENSE_BUFFERSIZE];
465 u8 scsi_cmd[MAX_COMMAND_SIZE];
467 struct scsi_sense_hdr sshdr;
473 if (copy_from_user(args, arg, sizeof(args)))
476 memset(sensebuf, 0, sizeof(sensebuf));
477 memset(scsi_cmd, 0, sizeof(scsi_cmd));
478 scsi_cmd[0] = ATA_16;
479 scsi_cmd[1] = (3 << 1); /* Non-data */
480 scsi_cmd[2] = 0x20; /* cc but no off.line or data xfer */
481 scsi_cmd[4] = args[1];
482 scsi_cmd[6] = args[2];
483 scsi_cmd[8] = args[3];
484 scsi_cmd[10] = args[4];
485 scsi_cmd[12] = args[5];
486 scsi_cmd[13] = args[6] & 0x4f;
487 scsi_cmd[14] = args[0];
489 /* Good values for timeout and retries? Values below
490 from scsi_ioctl_send_command() for default case... */
491 cmd_result = scsi_execute(scsidev, scsi_cmd, DMA_NONE, NULL, 0,
492 sensebuf, &sshdr, (10*HZ), 5, 0, 0, NULL);
494 if (cmd_result < 0) {
498 if (scsi_sense_valid(&sshdr)) {/* sense data available */
499 u8 *desc = sensebuf + 8;
501 /* If we set cc then ATA pass-through will cause a
502 * check condition even if no error. Filter that. */
503 if (cmd_result & SAM_STAT_CHECK_CONDITION) {
504 if (sshdr.sense_key == RECOVERED_ERROR &&
505 sshdr.asc == 0 && sshdr.ascq == 0x1d)
506 cmd_result &= ~SAM_STAT_CHECK_CONDITION;
509 /* Send userspace ATA registers */
510 if (sensebuf[0] == 0x72 && /* format is "descriptor" */
511 desc[0] == 0x09) {/* code is "ATA Descriptor" */
512 args[0] = desc[13]; /* status */
513 args[1] = desc[3]; /* error */
514 args[2] = desc[5]; /* sector count (0:7) */
515 args[3] = desc[7]; /* lbal */
516 args[4] = desc[9]; /* lbam */
517 args[5] = desc[11]; /* lbah */
518 args[6] = desc[12]; /* select */
519 if (copy_to_user(arg, args, sizeof(args)))
533 static int ata_ioc32(struct ata_port *ap)
535 if (ap->flags & ATA_FLAG_PIO_DMA)
537 if (ap->pflags & ATA_PFLAG_PIO32)
543 * This handles both native and compat commands, so anything added
544 * here must have a compatible argument, or check in_compat_syscall()
546 int ata_sas_scsi_ioctl(struct ata_port *ap, struct scsi_device *scsidev,
547 unsigned int cmd, void __user *arg)
555 spin_lock_irqsave(ap->lock, flags);
557 spin_unlock_irqrestore(ap->lock, flags);
559 if (in_compat_syscall())
560 return put_user(val, (compat_ulong_t __user *)arg);
562 return put_user(val, (unsigned long __user *)arg);
565 val = (unsigned long) arg;
567 spin_lock_irqsave(ap->lock, flags);
568 if (ap->pflags & ATA_PFLAG_PIO32CHANGE) {
570 ap->pflags |= ATA_PFLAG_PIO32;
572 ap->pflags &= ~ATA_PFLAG_PIO32;
574 if (val != ata_ioc32(ap))
577 spin_unlock_irqrestore(ap->lock, flags);
580 case HDIO_GET_IDENTITY:
581 return ata_get_identity(ap, scsidev, arg);
584 if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
586 return ata_cmd_ioctl(scsidev, arg);
588 case HDIO_DRIVE_TASK:
589 if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
591 return ata_task_ioctl(scsidev, arg);
600 EXPORT_SYMBOL_GPL(ata_sas_scsi_ioctl);
602 int ata_scsi_ioctl(struct scsi_device *scsidev, unsigned int cmd,
605 return ata_sas_scsi_ioctl(ata_shost_to_port(scsidev->host),
608 EXPORT_SYMBOL_GPL(ata_scsi_ioctl);
611 * ata_scsi_qc_new - acquire new ata_queued_cmd reference
612 * @dev: ATA device to which the new command is attached
613 * @cmd: SCSI command that originated this ATA command
615 * Obtain a reference to an unused ata_queued_cmd structure,
616 * which is the basic libata structure representing a single
617 * ATA command sent to the hardware.
619 * If a command was available, fill in the SCSI-specific
620 * portions of the structure with information on the
624 * spin_lock_irqsave(host lock)
627 * Command allocated, or %NULL if none available.
629 static struct ata_queued_cmd *ata_scsi_qc_new(struct ata_device *dev,
630 struct scsi_cmnd *cmd)
632 struct ata_queued_cmd *qc;
634 qc = ata_qc_new_init(dev, cmd->request->tag);
637 qc->scsidone = cmd->scsi_done;
639 qc->sg = scsi_sglist(cmd);
640 qc->n_elem = scsi_sg_count(cmd);
642 if (cmd->request->rq_flags & RQF_QUIET)
643 qc->flags |= ATA_QCFLAG_QUIET;
645 cmd->result = (DID_OK << 16) | SAM_STAT_TASK_SET_FULL;
652 static void ata_qc_set_pc_nbytes(struct ata_queued_cmd *qc)
654 struct scsi_cmnd *scmd = qc->scsicmd;
656 qc->extrabytes = scmd->extra_len;
657 qc->nbytes = scsi_bufflen(scmd) + qc->extrabytes;
661 * ata_dump_status - user friendly display of error info
662 * @id: id of the port in question
663 * @tf: ptr to filled out taskfile
665 * Decode and dump the ATA error/status registers for the user so
666 * that they have some idea what really happened at the non
667 * make-believe layer.
670 * inherited from caller
672 static void ata_dump_status(unsigned id, struct ata_taskfile *tf)
674 u8 stat = tf->command, err = tf->feature;
676 pr_warn("ata%u: status=0x%02x { ", id, stat);
677 if (stat & ATA_BUSY) {
678 pr_cont("Busy }\n"); /* Data is not valid in this case */
680 if (stat & ATA_DRDY) pr_cont("DriveReady ");
681 if (stat & ATA_DF) pr_cont("DeviceFault ");
682 if (stat & ATA_DSC) pr_cont("SeekComplete ");
683 if (stat & ATA_DRQ) pr_cont("DataRequest ");
684 if (stat & ATA_CORR) pr_cont("CorrectedError ");
685 if (stat & ATA_SENSE) pr_cont("Sense ");
686 if (stat & ATA_ERR) pr_cont("Error ");
690 pr_warn("ata%u: error=0x%02x { ", id, err);
691 if (err & ATA_ABORTED) pr_cont("DriveStatusError ");
692 if (err & ATA_ICRC) {
693 if (err & ATA_ABORTED)
695 else pr_cont("Sector ");
697 if (err & ATA_UNC) pr_cont("UncorrectableError ");
698 if (err & ATA_IDNF) pr_cont("SectorIdNotFound ");
699 if (err & ATA_TRK0NF) pr_cont("TrackZeroNotFound ");
700 if (err & ATA_AMNF) pr_cont("AddrMarkNotFound ");
707 * ata_to_sense_error - convert ATA error to SCSI error
708 * @id: ATA device number
709 * @drv_stat: value contained in ATA status register
710 * @drv_err: value contained in ATA error register
711 * @sk: the sense key we'll fill out
712 * @asc: the additional sense code we'll fill out
713 * @ascq: the additional sense code qualifier we'll fill out
714 * @verbose: be verbose
716 * Converts an ATA error into a SCSI error. Fill out pointers to
717 * SK, ASC, and ASCQ bytes for later use in fixed or descriptor
718 * format sense blocks.
721 * spin_lock_irqsave(host lock)
723 static void ata_to_sense_error(unsigned id, u8 drv_stat, u8 drv_err, u8 *sk,
724 u8 *asc, u8 *ascq, int verbose)
728 /* Based on the 3ware driver translation table */
729 static const unsigned char sense_table[][4] = {
731 {0xd1, ABORTED_COMMAND, 0x00, 0x00},
732 // Device busy Aborted command
734 {0xd0, ABORTED_COMMAND, 0x00, 0x00},
735 // Device busy Aborted command
737 {0x61, HARDWARE_ERROR, 0x00, 0x00},
738 // Device fault Hardware error
739 /* ICRC|ABRT */ /* NB: ICRC & !ABRT is BBD */
740 {0x84, ABORTED_COMMAND, 0x47, 0x00},
741 // Data CRC error SCSI parity error
742 /* MC|ID|ABRT|TRK0|MARK */
743 {0x37, NOT_READY, 0x04, 0x00},
744 // Unit offline Not ready
746 {0x09, NOT_READY, 0x04, 0x00},
747 // Unrecovered disk error Not ready
748 /* Bad address mark */
749 {0x01, MEDIUM_ERROR, 0x13, 0x00},
750 // Address mark not found for data field
751 /* TRK0 - Track 0 not found */
752 {0x02, HARDWARE_ERROR, 0x00, 0x00},
754 /* Abort: 0x04 is not translated here, see below */
755 /* Media change request */
756 {0x08, NOT_READY, 0x04, 0x00},
757 // FIXME: faking offline
758 /* SRV/IDNF - ID not found */
759 {0x10, ILLEGAL_REQUEST, 0x21, 0x00},
760 // Logical address out of range
761 /* MC - Media Changed */
762 {0x20, UNIT_ATTENTION, 0x28, 0x00},
763 // Not ready to ready change, medium may have changed
764 /* ECC - Uncorrectable ECC error */
765 {0x40, MEDIUM_ERROR, 0x11, 0x04},
766 // Unrecovered read error
767 /* BBD - block marked bad */
768 {0x80, MEDIUM_ERROR, 0x11, 0x04},
769 // Block marked bad Medium error, unrecovered read error
770 {0xFF, 0xFF, 0xFF, 0xFF}, // END mark
772 static const unsigned char stat_table[][4] = {
773 /* Must be first because BUSY means no other bits valid */
774 {0x80, ABORTED_COMMAND, 0x47, 0x00},
775 // Busy, fake parity for now
776 {0x40, ILLEGAL_REQUEST, 0x21, 0x04},
777 // Device ready, unaligned write command
778 {0x20, HARDWARE_ERROR, 0x44, 0x00},
779 // Device fault, internal target failure
780 {0x08, ABORTED_COMMAND, 0x47, 0x00},
781 // Timed out in xfer, fake parity for now
782 {0x04, RECOVERED_ERROR, 0x11, 0x00},
783 // Recovered ECC error Medium error, recovered
784 {0xFF, 0xFF, 0xFF, 0xFF}, // END mark
788 * Is this an error we can process/parse
790 if (drv_stat & ATA_BUSY) {
791 drv_err = 0; /* Ignore the err bits, they're invalid */
795 /* Look for drv_err */
796 for (i = 0; sense_table[i][0] != 0xFF; i++) {
797 /* Look for best matches first */
798 if ((sense_table[i][0] & drv_err) ==
800 *sk = sense_table[i][1];
801 *asc = sense_table[i][2];
802 *ascq = sense_table[i][3];
809 * Fall back to interpreting status bits. Note that if the drv_err
810 * has only the ABRT bit set, we decode drv_stat. ABRT by itself
811 * is not descriptive enough.
813 for (i = 0; stat_table[i][0] != 0xFF; i++) {
814 if (stat_table[i][0] & drv_stat) {
815 *sk = stat_table[i][1];
816 *asc = stat_table[i][2];
817 *ascq = stat_table[i][3];
823 * We need a sensible error return here, which is tricky, and one
824 * that won't cause people to do things like return a disk wrongly.
826 *sk = ABORTED_COMMAND;
832 pr_err("ata%u: translated ATA stat/err 0x%02x/%02x to SCSI SK/ASC/ASCQ 0x%x/%02x/%02x\n",
833 id, drv_stat, drv_err, *sk, *asc, *ascq);
838 * ata_gen_passthru_sense - Generate check condition sense block.
839 * @qc: Command that completed.
841 * This function is specific to the ATA descriptor format sense
842 * block specified for the ATA pass through commands. Regardless
843 * of whether the command errored or not, return a sense
844 * block. Copy all controller registers into the sense
845 * block. If there was no error, we get the request from an ATA
846 * passthrough command, so we use the following sense data:
847 * sk = RECOVERED ERROR
848 * asc,ascq = ATA PASS-THROUGH INFORMATION AVAILABLE
854 static void ata_gen_passthru_sense(struct ata_queued_cmd *qc)
856 struct scsi_cmnd *cmd = qc->scsicmd;
857 struct ata_taskfile *tf = &qc->result_tf;
858 unsigned char *sb = cmd->sense_buffer;
859 unsigned char *desc = sb + 8;
860 int verbose = qc->ap->ops->error_handler == NULL;
861 u8 sense_key, asc, ascq;
863 memset(sb, 0, SCSI_SENSE_BUFFERSIZE);
866 * Use ata_to_sense_error() to map status register bits
867 * onto sense key, asc & ascq.
870 tf->command & (ATA_BUSY | ATA_DF | ATA_ERR | ATA_DRQ)) {
871 ata_to_sense_error(qc->ap->print_id, tf->command, tf->feature,
872 &sense_key, &asc, &ascq, verbose);
873 ata_scsi_set_sense(qc->dev, cmd, sense_key, asc, ascq);
876 * ATA PASS-THROUGH INFORMATION AVAILABLE
877 * Always in descriptor format sense.
879 scsi_build_sense(cmd, 1, RECOVERED_ERROR, 0, 0x1D);
882 if ((cmd->sense_buffer[0] & 0x7f) >= 0x72) {
885 /* descriptor format */
887 desc = (char *)scsi_sense_desc_find(sb, len + 8, 9);
889 if (SCSI_SENSE_BUFFERSIZE < len + 14)
897 * Copy registers into sense buffer.
900 desc[3] = tf->feature; /* == error reg */
905 desc[12] = tf->device;
906 desc[13] = tf->command; /* == status reg */
909 * Fill in Extend bit, and the high order bytes
912 if (tf->flags & ATA_TFLAG_LBA48) {
914 desc[4] = tf->hob_nsect;
915 desc[6] = tf->hob_lbal;
916 desc[8] = tf->hob_lbam;
917 desc[10] = tf->hob_lbah;
920 /* Fixed sense format */
921 desc[0] = tf->feature;
922 desc[1] = tf->command; /* status */
923 desc[2] = tf->device;
926 if (tf->flags & ATA_TFLAG_LBA48) {
930 if (tf->hob_lbal || tf->hob_lbam || tf->hob_lbah)
940 * ata_gen_ata_sense - generate a SCSI fixed sense block
941 * @qc: Command that we are erroring out
943 * Generate sense block for a failed ATA command @qc. Descriptor
944 * format is used to accommodate LBA48 block address.
949 static void ata_gen_ata_sense(struct ata_queued_cmd *qc)
951 struct ata_device *dev = qc->dev;
952 struct scsi_cmnd *cmd = qc->scsicmd;
953 struct ata_taskfile *tf = &qc->result_tf;
954 unsigned char *sb = cmd->sense_buffer;
955 int verbose = qc->ap->ops->error_handler == NULL;
957 u8 sense_key, asc, ascq;
959 memset(sb, 0, SCSI_SENSE_BUFFERSIZE);
961 if (ata_dev_disabled(dev)) {
962 /* Device disabled after error recovery */
963 /* LOGICAL UNIT NOT READY, HARD RESET REQUIRED */
964 ata_scsi_set_sense(dev, cmd, NOT_READY, 0x04, 0x21);
967 /* Use ata_to_sense_error() to map status register bits
968 * onto sense key, asc & ascq.
971 tf->command & (ATA_BUSY | ATA_DF | ATA_ERR | ATA_DRQ)) {
972 ata_to_sense_error(qc->ap->print_id, tf->command, tf->feature,
973 &sense_key, &asc, &ascq, verbose);
974 ata_scsi_set_sense(dev, cmd, sense_key, asc, ascq);
976 /* Could not decode error */
977 ata_dev_warn(dev, "could not decode error status 0x%x err_mask 0x%x\n",
978 tf->command, qc->err_mask);
979 ata_scsi_set_sense(dev, cmd, ABORTED_COMMAND, 0, 0);
983 block = ata_tf_read_block(&qc->result_tf, dev);
984 if (block == U64_MAX)
987 scsi_set_sense_information(sb, SCSI_SENSE_BUFFERSIZE, block);
990 void ata_scsi_sdev_config(struct scsi_device *sdev)
992 sdev->use_10_for_rw = 1;
993 sdev->use_10_for_ms = 1;
994 sdev->no_write_same = 1;
996 /* Schedule policy is determined by ->qc_defer() callback and
997 * it needs to see every deferred qc. Set dev_blocked to 1 to
998 * prevent SCSI midlayer from automatically deferring
1001 sdev->max_device_blocked = 1;
1005 * ata_scsi_dma_need_drain - Check whether data transfer may overflow
1006 * @rq: request to be checked
1008 * ATAPI commands which transfer variable length data to host
1009 * might overflow due to application error or hardware bug. This
1010 * function checks whether overflow should be drained and ignored
1017 * 1 if ; otherwise, 0.
1019 bool ata_scsi_dma_need_drain(struct request *rq)
1021 return atapi_cmd_type(scsi_req(rq)->cmd[0]) == ATAPI_MISC;
1023 EXPORT_SYMBOL_GPL(ata_scsi_dma_need_drain);
1025 int ata_scsi_dev_config(struct scsi_device *sdev, struct ata_device *dev)
1027 struct request_queue *q = sdev->request_queue;
1029 if (!ata_id_has_unload(dev->id))
1030 dev->flags |= ATA_DFLAG_NO_UNLOAD;
1032 /* configure max sectors */
1033 blk_queue_max_hw_sectors(q, dev->max_sectors);
1035 if (dev->class == ATA_DEV_ATAPI) {
1036 sdev->sector_size = ATA_SECT_SIZE;
1038 /* set DMA padding */
1039 blk_queue_update_dma_pad(q, ATA_DMA_PAD_SZ - 1);
1041 /* make room for appending the drain */
1042 blk_queue_max_segments(q, queue_max_segments(q) - 1);
1044 sdev->dma_drain_len = ATAPI_MAX_DRAIN;
1045 sdev->dma_drain_buf = kmalloc(sdev->dma_drain_len, GFP_NOIO);
1046 if (!sdev->dma_drain_buf) {
1047 ata_dev_err(dev, "drain buffer allocation failed\n");
1051 sdev->sector_size = ata_id_logical_sector_size(dev->id);
1052 sdev->manage_start_stop = 1;
1056 * ata_pio_sectors() expects buffer for each sector to not cross
1057 * page boundary. Enforce it by requiring buffers to be sector
1058 * aligned, which works iff sector_size is not larger than
1059 * PAGE_SIZE. ATAPI devices also need the alignment as
1060 * IDENTIFY_PACKET is executed as ATA_PROT_PIO.
1062 if (sdev->sector_size > PAGE_SIZE)
1064 "sector_size=%u > PAGE_SIZE, PIO may malfunction\n",
1067 blk_queue_update_dma_alignment(q, sdev->sector_size - 1);
1069 if (dev->flags & ATA_DFLAG_AN)
1070 set_bit(SDEV_EVT_MEDIA_CHANGE, sdev->supported_events);
1072 if (dev->flags & ATA_DFLAG_NCQ) {
1075 depth = min(sdev->host->can_queue, ata_id_queue_depth(dev->id));
1076 depth = min(ATA_MAX_QUEUE, depth);
1077 scsi_change_queue_depth(sdev, depth);
1080 if (dev->flags & ATA_DFLAG_TRUSTED)
1081 sdev->security_supported = 1;
1088 * ata_scsi_slave_config - Set SCSI device attributes
1089 * @sdev: SCSI device to examine
1091 * This is called before we actually start reading
1092 * and writing to the device, to configure certain
1093 * SCSI mid-layer behaviors.
1096 * Defined by SCSI layer. We don't really care.
1099 int ata_scsi_slave_config(struct scsi_device *sdev)
1101 struct ata_port *ap = ata_shost_to_port(sdev->host);
1102 struct ata_device *dev = __ata_scsi_find_dev(ap, sdev);
1105 ata_scsi_sdev_config(sdev);
1108 rc = ata_scsi_dev_config(sdev, dev);
1112 EXPORT_SYMBOL_GPL(ata_scsi_slave_config);
1115 * ata_scsi_slave_destroy - SCSI device is about to be destroyed
1116 * @sdev: SCSI device to be destroyed
1118 * @sdev is about to be destroyed for hot/warm unplugging. If
1119 * this unplugging was initiated by libata as indicated by NULL
1120 * dev->sdev, this function doesn't have to do anything.
1121 * Otherwise, SCSI layer initiated warm-unplug is in progress.
1122 * Clear dev->sdev, schedule the device for ATA detach and invoke
1126 * Defined by SCSI layer. We don't really care.
1128 void ata_scsi_slave_destroy(struct scsi_device *sdev)
1130 struct ata_port *ap = ata_shost_to_port(sdev->host);
1131 unsigned long flags;
1132 struct ata_device *dev;
1134 if (!ap->ops->error_handler)
1137 spin_lock_irqsave(ap->lock, flags);
1138 dev = __ata_scsi_find_dev(ap, sdev);
1139 if (dev && dev->sdev) {
1140 /* SCSI device already in CANCEL state, no need to offline it */
1142 dev->flags |= ATA_DFLAG_DETACH;
1143 ata_port_schedule_eh(ap);
1145 spin_unlock_irqrestore(ap->lock, flags);
1147 kfree(sdev->dma_drain_buf);
1149 EXPORT_SYMBOL_GPL(ata_scsi_slave_destroy);
1152 * ata_scsi_start_stop_xlat - Translate SCSI START STOP UNIT command
1153 * @qc: Storage for translated ATA taskfile
1155 * Sets up an ATA taskfile to issue STANDBY (to stop) or READ VERIFY
1156 * (to start). Perhaps these commands should be preceded by
1157 * CHECK POWER MODE to see what power mode the device is already in.
1158 * [See SAT revision 5 at www.t10.org]
1161 * spin_lock_irqsave(host lock)
1164 * Zero on success, non-zero on error.
1166 static unsigned int ata_scsi_start_stop_xlat(struct ata_queued_cmd *qc)
1168 struct scsi_cmnd *scmd = qc->scsicmd;
1169 struct ata_taskfile *tf = &qc->tf;
1170 const u8 *cdb = scmd->cmnd;
1174 if (scmd->cmd_len < 5) {
1179 tf->flags |= ATA_TFLAG_DEVICE | ATA_TFLAG_ISADDR;
1180 tf->protocol = ATA_PROT_NODATA;
1182 ; /* ignore IMMED bit, violates sat-r05 */
1187 goto invalid_fld; /* LOEJ bit set not supported */
1189 if (((cdb[4] >> 4) & 0xf) != 0) {
1192 goto invalid_fld; /* power conditions not supported */
1196 tf->nsect = 1; /* 1 sector, lba=0 */
1198 if (qc->dev->flags & ATA_DFLAG_LBA) {
1199 tf->flags |= ATA_TFLAG_LBA;
1204 tf->device |= ATA_LBA;
1207 tf->lbal = 0x1; /* sect */
1208 tf->lbam = 0x0; /* cyl low */
1209 tf->lbah = 0x0; /* cyl high */
1212 tf->command = ATA_CMD_VERIFY; /* READ VERIFY */
1214 /* Some odd clown BIOSen issue spindown on power off (ACPI S4
1215 * or S5) causing some drives to spin up and down again.
1217 if ((qc->ap->flags & ATA_FLAG_NO_POWEROFF_SPINDOWN) &&
1218 system_state == SYSTEM_POWER_OFF)
1221 if ((qc->ap->flags & ATA_FLAG_NO_HIBERNATE_SPINDOWN) &&
1222 system_entering_hibernation())
1225 /* Issue ATA STANDBY IMMEDIATE command */
1226 tf->command = ATA_CMD_STANDBYNOW1;
1230 * Standby and Idle condition timers could be implemented but that
1231 * would require libata to implement the Power condition mode page
1232 * and allow the user to change it. Changing mode pages requires
1233 * MODE SELECT to be implemented.
1239 ata_scsi_set_invalid_field(qc->dev, scmd, fp, bp);
1242 scmd->result = SAM_STAT_GOOD;
1248 * ata_scsi_flush_xlat - Translate SCSI SYNCHRONIZE CACHE command
1249 * @qc: Storage for translated ATA taskfile
1251 * Sets up an ATA taskfile to issue FLUSH CACHE or
1255 * spin_lock_irqsave(host lock)
1258 * Zero on success, non-zero on error.
1260 static unsigned int ata_scsi_flush_xlat(struct ata_queued_cmd *qc)
1262 struct ata_taskfile *tf = &qc->tf;
1264 tf->flags |= ATA_TFLAG_DEVICE;
1265 tf->protocol = ATA_PROT_NODATA;
1267 if (qc->dev->flags & ATA_DFLAG_FLUSH_EXT)
1268 tf->command = ATA_CMD_FLUSH_EXT;
1270 tf->command = ATA_CMD_FLUSH;
1272 /* flush is critical for IO integrity, consider it an IO command */
1273 qc->flags |= ATA_QCFLAG_IO;
1279 * scsi_6_lba_len - Get LBA and transfer length
1280 * @cdb: SCSI command to translate
1282 * Calculate LBA and transfer length for 6-byte commands.
1286 * @plen: the transfer length
1288 static void scsi_6_lba_len(const u8 *cdb, u64 *plba, u32 *plen)
1293 VPRINTK("six-byte command\n");
1295 lba |= ((u64)(cdb[1] & 0x1f)) << 16;
1296 lba |= ((u64)cdb[2]) << 8;
1297 lba |= ((u64)cdb[3]);
1306 * scsi_10_lba_len - Get LBA and transfer length
1307 * @cdb: SCSI command to translate
1309 * Calculate LBA and transfer length for 10-byte commands.
1313 * @plen: the transfer length
1315 static void scsi_10_lba_len(const u8 *cdb, u64 *plba, u32 *plen)
1320 VPRINTK("ten-byte command\n");
1322 lba |= ((u64)cdb[2]) << 24;
1323 lba |= ((u64)cdb[3]) << 16;
1324 lba |= ((u64)cdb[4]) << 8;
1325 lba |= ((u64)cdb[5]);
1327 len |= ((u32)cdb[7]) << 8;
1328 len |= ((u32)cdb[8]);
1335 * scsi_16_lba_len - Get LBA and transfer length
1336 * @cdb: SCSI command to translate
1338 * Calculate LBA and transfer length for 16-byte commands.
1342 * @plen: the transfer length
1344 static void scsi_16_lba_len(const u8 *cdb, u64 *plba, u32 *plen)
1349 VPRINTK("sixteen-byte command\n");
1351 lba |= ((u64)cdb[2]) << 56;
1352 lba |= ((u64)cdb[3]) << 48;
1353 lba |= ((u64)cdb[4]) << 40;
1354 lba |= ((u64)cdb[5]) << 32;
1355 lba |= ((u64)cdb[6]) << 24;
1356 lba |= ((u64)cdb[7]) << 16;
1357 lba |= ((u64)cdb[8]) << 8;
1358 lba |= ((u64)cdb[9]);
1360 len |= ((u32)cdb[10]) << 24;
1361 len |= ((u32)cdb[11]) << 16;
1362 len |= ((u32)cdb[12]) << 8;
1363 len |= ((u32)cdb[13]);
1370 * ata_scsi_verify_xlat - Translate SCSI VERIFY command into an ATA one
1371 * @qc: Storage for translated ATA taskfile
1373 * Converts SCSI VERIFY command to an ATA READ VERIFY command.
1376 * spin_lock_irqsave(host lock)
1379 * Zero on success, non-zero on error.
1381 static unsigned int ata_scsi_verify_xlat(struct ata_queued_cmd *qc)
1383 struct scsi_cmnd *scmd = qc->scsicmd;
1384 struct ata_taskfile *tf = &qc->tf;
1385 struct ata_device *dev = qc->dev;
1386 u64 dev_sectors = qc->dev->n_sectors;
1387 const u8 *cdb = scmd->cmnd;
1392 tf->flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
1393 tf->protocol = ATA_PROT_NODATA;
1395 if (cdb[0] == VERIFY) {
1396 if (scmd->cmd_len < 10) {
1400 scsi_10_lba_len(cdb, &block, &n_block);
1401 } else if (cdb[0] == VERIFY_16) {
1402 if (scmd->cmd_len < 16) {
1406 scsi_16_lba_len(cdb, &block, &n_block);
1414 if (block >= dev_sectors)
1416 if ((block + n_block) > dev_sectors)
1419 if (dev->flags & ATA_DFLAG_LBA) {
1420 tf->flags |= ATA_TFLAG_LBA;
1422 if (lba_28_ok(block, n_block)) {
1424 tf->command = ATA_CMD_VERIFY;
1425 tf->device |= (block >> 24) & 0xf;
1426 } else if (lba_48_ok(block, n_block)) {
1427 if (!(dev->flags & ATA_DFLAG_LBA48))
1431 tf->flags |= ATA_TFLAG_LBA48;
1432 tf->command = ATA_CMD_VERIFY_EXT;
1434 tf->hob_nsect = (n_block >> 8) & 0xff;
1436 tf->hob_lbah = (block >> 40) & 0xff;
1437 tf->hob_lbam = (block >> 32) & 0xff;
1438 tf->hob_lbal = (block >> 24) & 0xff;
1440 /* request too large even for LBA48 */
1443 tf->nsect = n_block & 0xff;
1445 tf->lbah = (block >> 16) & 0xff;
1446 tf->lbam = (block >> 8) & 0xff;
1447 tf->lbal = block & 0xff;
1449 tf->device |= ATA_LBA;
1452 u32 sect, head, cyl, track;
1454 if (!lba_28_ok(block, n_block))
1457 /* Convert LBA to CHS */
1458 track = (u32)block / dev->sectors;
1459 cyl = track / dev->heads;
1460 head = track % dev->heads;
1461 sect = (u32)block % dev->sectors + 1;
1463 DPRINTK("block %u track %u cyl %u head %u sect %u\n",
1464 (u32)block, track, cyl, head, sect);
1466 /* Check whether the converted CHS can fit.
1470 if ((cyl >> 16) || (head >> 4) || (sect >> 8) || (!sect))
1473 tf->command = ATA_CMD_VERIFY;
1474 tf->nsect = n_block & 0xff; /* Sector count 0 means 256 sectors */
1477 tf->lbah = cyl >> 8;
1484 ata_scsi_set_invalid_field(qc->dev, scmd, fp, 0xff);
1488 ata_scsi_set_sense(qc->dev, scmd, ILLEGAL_REQUEST, 0x21, 0x0);
1489 /* "Logical Block Address out of range" */
1493 scmd->result = SAM_STAT_GOOD;
1497 static bool ata_check_nblocks(struct scsi_cmnd *scmd, u32 n_blocks)
1499 struct request *rq = scmd->request;
1502 if (!blk_rq_is_passthrough(rq))
1505 req_blocks = blk_rq_bytes(rq) / scmd->device->sector_size;
1506 if (n_blocks > req_blocks)
1513 * ata_scsi_rw_xlat - Translate SCSI r/w command into an ATA one
1514 * @qc: Storage for translated ATA taskfile
1516 * Converts any of six SCSI read/write commands into the
1517 * ATA counterpart, including starting sector (LBA),
1518 * sector count, and taking into account the device's LBA48
1521 * Commands %READ_6, %READ_10, %READ_16, %WRITE_6, %WRITE_10, and
1522 * %WRITE_16 are currently supported.
1525 * spin_lock_irqsave(host lock)
1528 * Zero on success, non-zero on error.
1530 static unsigned int ata_scsi_rw_xlat(struct ata_queued_cmd *qc)
1532 struct scsi_cmnd *scmd = qc->scsicmd;
1533 const u8 *cdb = scmd->cmnd;
1534 struct request *rq = scmd->request;
1535 int class = IOPRIO_PRIO_CLASS(req_get_ioprio(rq));
1536 unsigned int tf_flags = 0;
1542 if (cdb[0] == WRITE_10 || cdb[0] == WRITE_6 || cdb[0] == WRITE_16)
1543 tf_flags |= ATA_TFLAG_WRITE;
1545 /* Calculate the SCSI LBA, transfer length and FUA. */
1549 if (unlikely(scmd->cmd_len < 10)) {
1553 scsi_10_lba_len(cdb, &block, &n_block);
1554 if (cdb[1] & (1 << 3))
1555 tf_flags |= ATA_TFLAG_FUA;
1556 if (!ata_check_nblocks(scmd, n_block))
1561 if (unlikely(scmd->cmd_len < 6)) {
1565 scsi_6_lba_len(cdb, &block, &n_block);
1567 /* for 6-byte r/w commands, transfer length 0
1568 * means 256 blocks of data, not 0 block.
1572 if (!ata_check_nblocks(scmd, n_block))
1577 if (unlikely(scmd->cmd_len < 16)) {
1581 scsi_16_lba_len(cdb, &block, &n_block);
1582 if (cdb[1] & (1 << 3))
1583 tf_flags |= ATA_TFLAG_FUA;
1584 if (!ata_check_nblocks(scmd, n_block))
1588 DPRINTK("no-byte command\n");
1593 /* Check and compose ATA command */
1595 /* For 10-byte and 16-byte SCSI R/W commands, transfer
1596 * length 0 means transfer 0 block of data.
1597 * However, for ATA R/W commands, sector count 0 means
1598 * 256 or 65536 sectors, not 0 sectors as in SCSI.
1600 * WARNING: one or two older ATA drives treat 0 as 0...
1604 qc->flags |= ATA_QCFLAG_IO;
1605 qc->nbytes = n_block * scmd->device->sector_size;
1607 rc = ata_build_rw_tf(&qc->tf, qc->dev, block, n_block, tf_flags,
1610 if (likely(rc == 0))
1615 /* treat all other errors as -EINVAL, fall through */
1617 ata_scsi_set_invalid_field(qc->dev, scmd, fp, 0xff);
1621 ata_scsi_set_sense(qc->dev, scmd, ILLEGAL_REQUEST, 0x21, 0x0);
1622 /* "Logical Block Address out of range" */
1626 scmd->result = SAM_STAT_GOOD;
1630 static void ata_qc_done(struct ata_queued_cmd *qc)
1632 struct scsi_cmnd *cmd = qc->scsicmd;
1633 void (*done)(struct scsi_cmnd *) = qc->scsidone;
1639 static void ata_scsi_qc_complete(struct ata_queued_cmd *qc)
1641 struct ata_port *ap = qc->ap;
1642 struct scsi_cmnd *cmd = qc->scsicmd;
1643 u8 *cdb = cmd->cmnd;
1644 int need_sense = (qc->err_mask != 0);
1646 /* For ATA pass thru (SAT) commands, generate a sense block if
1647 * user mandated it or if there's an error. Note that if we
1648 * generate because the user forced us to [CK_COND =1], a check
1649 * condition is generated and the ATA register values are returned
1650 * whether the command completed successfully or not. If there
1651 * was no error, we use the following sense data:
1652 * sk = RECOVERED ERROR
1653 * asc,ascq = ATA PASS-THROUGH INFORMATION AVAILABLE
1655 if (((cdb[0] == ATA_16) || (cdb[0] == ATA_12)) &&
1656 ((cdb[2] & 0x20) || need_sense))
1657 ata_gen_passthru_sense(qc);
1658 else if (qc->flags & ATA_QCFLAG_SENSE_VALID)
1659 cmd->result = SAM_STAT_CHECK_CONDITION;
1660 else if (need_sense)
1661 ata_gen_ata_sense(qc);
1663 cmd->result = SAM_STAT_GOOD;
1665 if (need_sense && !ap->ops->error_handler)
1666 ata_dump_status(ap->print_id, &qc->result_tf);
1672 * ata_scsi_translate - Translate then issue SCSI command to ATA device
1673 * @dev: ATA device to which the command is addressed
1674 * @cmd: SCSI command to execute
1675 * @xlat_func: Actor which translates @cmd to an ATA taskfile
1677 * Our ->queuecommand() function has decided that the SCSI
1678 * command issued can be directly translated into an ATA
1679 * command, rather than handled internally.
1681 * This function sets up an ata_queued_cmd structure for the
1682 * SCSI command, and sends that ata_queued_cmd to the hardware.
1684 * The xlat_func argument (actor) returns 0 if ready to execute
1685 * ATA command, else 1 to finish translation. If 1 is returned
1686 * then cmd->result (and possibly cmd->sense_buffer) are assumed
1687 * to be set reflecting an error condition or clean (early)
1691 * spin_lock_irqsave(host lock)
1694 * 0 on success, SCSI_ML_QUEUE_DEVICE_BUSY if the command
1695 * needs to be deferred.
1697 static int ata_scsi_translate(struct ata_device *dev, struct scsi_cmnd *cmd,
1698 ata_xlat_func_t xlat_func)
1700 struct ata_port *ap = dev->link->ap;
1701 struct ata_queued_cmd *qc;
1706 qc = ata_scsi_qc_new(dev, cmd);
1710 /* data is present; dma-map it */
1711 if (cmd->sc_data_direction == DMA_FROM_DEVICE ||
1712 cmd->sc_data_direction == DMA_TO_DEVICE) {
1713 if (unlikely(scsi_bufflen(cmd) < 1)) {
1714 ata_dev_warn(dev, "WARNING: zero len r/w req\n");
1718 ata_sg_init(qc, scsi_sglist(cmd), scsi_sg_count(cmd));
1720 qc->dma_dir = cmd->sc_data_direction;
1723 qc->complete_fn = ata_scsi_qc_complete;
1728 if (ap->ops->qc_defer) {
1729 if ((rc = ap->ops->qc_defer(qc)))
1733 /* select device, send command to hardware */
1741 cmd->scsi_done(cmd);
1742 DPRINTK("EXIT - early finish (good or error)\n");
1747 cmd->result = (DID_ERROR << 16);
1748 cmd->scsi_done(cmd);
1750 DPRINTK("EXIT - internal\n");
1755 DPRINTK("EXIT - defer\n");
1756 if (rc == ATA_DEFER_LINK)
1757 return SCSI_MLQUEUE_DEVICE_BUSY;
1759 return SCSI_MLQUEUE_HOST_BUSY;
1762 struct ata_scsi_args {
1763 struct ata_device *dev;
1765 struct scsi_cmnd *cmd;
1769 * ata_scsi_rbuf_get - Map response buffer.
1770 * @cmd: SCSI command containing buffer to be mapped.
1771 * @flags: unsigned long variable to store irq enable status
1772 * @copy_in: copy in from user buffer
1774 * Prepare buffer for simulated SCSI commands.
1777 * spin_lock_irqsave(ata_scsi_rbuf_lock) on success
1780 * Pointer to response buffer.
1782 static void *ata_scsi_rbuf_get(struct scsi_cmnd *cmd, bool copy_in,
1783 unsigned long *flags)
1785 spin_lock_irqsave(&ata_scsi_rbuf_lock, *flags);
1787 memset(ata_scsi_rbuf, 0, ATA_SCSI_RBUF_SIZE);
1789 sg_copy_to_buffer(scsi_sglist(cmd), scsi_sg_count(cmd),
1790 ata_scsi_rbuf, ATA_SCSI_RBUF_SIZE);
1791 return ata_scsi_rbuf;
1795 * ata_scsi_rbuf_put - Unmap response buffer.
1796 * @cmd: SCSI command containing buffer to be unmapped.
1797 * @copy_out: copy out result
1798 * @flags: @flags passed to ata_scsi_rbuf_get()
1800 * Returns rbuf buffer. The result is copied to @cmd's buffer if
1801 * @copy_back is true.
1804 * Unlocks ata_scsi_rbuf_lock.
1806 static inline void ata_scsi_rbuf_put(struct scsi_cmnd *cmd, bool copy_out,
1807 unsigned long *flags)
1810 sg_copy_from_buffer(scsi_sglist(cmd), scsi_sg_count(cmd),
1811 ata_scsi_rbuf, ATA_SCSI_RBUF_SIZE);
1812 spin_unlock_irqrestore(&ata_scsi_rbuf_lock, *flags);
1816 * ata_scsi_rbuf_fill - wrapper for SCSI command simulators
1817 * @args: device IDENTIFY data / SCSI command of interest.
1818 * @actor: Callback hook for desired SCSI command simulator
1820 * Takes care of the hard work of simulating a SCSI command...
1821 * Mapping the response buffer, calling the command's handler,
1822 * and handling the handler's return value. This return value
1823 * indicates whether the handler wishes the SCSI command to be
1824 * completed successfully (0), or not (in which case cmd->result
1825 * and sense buffer are assumed to be set).
1828 * spin_lock_irqsave(host lock)
1830 static void ata_scsi_rbuf_fill(struct ata_scsi_args *args,
1831 unsigned int (*actor)(struct ata_scsi_args *args, u8 *rbuf))
1835 struct scsi_cmnd *cmd = args->cmd;
1836 unsigned long flags;
1838 rbuf = ata_scsi_rbuf_get(cmd, false, &flags);
1839 rc = actor(args, rbuf);
1840 ata_scsi_rbuf_put(cmd, rc == 0, &flags);
1843 cmd->result = SAM_STAT_GOOD;
1847 * ata_scsiop_inq_std - Simulate INQUIRY command
1848 * @args: device IDENTIFY data / SCSI command of interest.
1849 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1851 * Returns standard device identification data associated
1852 * with non-VPD INQUIRY command output.
1855 * spin_lock_irqsave(host lock)
1857 static unsigned int ata_scsiop_inq_std(struct ata_scsi_args *args, u8 *rbuf)
1859 static const u8 versions[] = {
1861 0x60, /* SAM-3 (no version claimed) */
1864 0x20, /* SBC-2 (no version claimed) */
1867 0x00 /* SPC-3 (no version claimed) */
1869 static const u8 versions_zbc[] = {
1871 0xA0, /* SAM-5 (no version claimed) */
1874 0x00, /* SBC-4 (no version claimed) */
1877 0xC0, /* SPC-5 (no version claimed) */
1886 0x5, /* claim SPC-3 version compatibility */
1896 /* set scsi removable (RMB) bit per ata bit, or if the
1897 * AHCI port says it's external (Hotplug-capable, eSATA).
1899 if (ata_id_removable(args->id) ||
1900 (args->dev->link->ap->pflags & ATA_PFLAG_EXTERNAL))
1903 if (args->dev->class == ATA_DEV_ZAC) {
1905 hdr[2] = 0x7; /* claim SPC-5 version compatibility */
1908 memcpy(rbuf, hdr, sizeof(hdr));
1909 memcpy(&rbuf[8], "ATA ", 8);
1910 ata_id_string(args->id, &rbuf[16], ATA_ID_PROD, 16);
1912 /* From SAT, use last 2 words from fw rev unless they are spaces */
1913 ata_id_string(args->id, &rbuf[32], ATA_ID_FW_REV + 2, 4);
1914 if (strncmp(&rbuf[32], " ", 4) == 0)
1915 ata_id_string(args->id, &rbuf[32], ATA_ID_FW_REV, 4);
1917 if (rbuf[32] == 0 || rbuf[32] == ' ')
1918 memcpy(&rbuf[32], "n/a ", 4);
1920 if (ata_id_zoned_cap(args->id) || args->dev->class == ATA_DEV_ZAC)
1921 memcpy(rbuf + 58, versions_zbc, sizeof(versions_zbc));
1923 memcpy(rbuf + 58, versions, sizeof(versions));
1929 * ata_scsiop_inq_00 - Simulate INQUIRY VPD page 0, list of pages
1930 * @args: device IDENTIFY data / SCSI command of interest.
1931 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1933 * Returns list of inquiry VPD pages available.
1936 * spin_lock_irqsave(host lock)
1938 static unsigned int ata_scsiop_inq_00(struct ata_scsi_args *args, u8 *rbuf)
1941 static const u8 pages[] = {
1942 0x00, /* page 0x00, this page */
1943 0x80, /* page 0x80, unit serial no page */
1944 0x83, /* page 0x83, device ident page */
1945 0x89, /* page 0x89, ata info page */
1946 0xb0, /* page 0xb0, block limits page */
1947 0xb1, /* page 0xb1, block device characteristics page */
1948 0xb2, /* page 0xb2, thin provisioning page */
1949 0xb6, /* page 0xb6, zoned block device characteristics */
1952 num_pages = sizeof(pages);
1953 if (!(args->dev->flags & ATA_DFLAG_ZAC))
1955 rbuf[3] = num_pages; /* number of supported VPD pages */
1956 memcpy(rbuf + 4, pages, num_pages);
1961 * ata_scsiop_inq_80 - Simulate INQUIRY VPD page 80, device serial number
1962 * @args: device IDENTIFY data / SCSI command of interest.
1963 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1965 * Returns ATA device serial number.
1968 * spin_lock_irqsave(host lock)
1970 static unsigned int ata_scsiop_inq_80(struct ata_scsi_args *args, u8 *rbuf)
1972 static const u8 hdr[] = {
1974 0x80, /* this page code */
1976 ATA_ID_SERNO_LEN, /* page len */
1979 memcpy(rbuf, hdr, sizeof(hdr));
1980 ata_id_string(args->id, (unsigned char *) &rbuf[4],
1981 ATA_ID_SERNO, ATA_ID_SERNO_LEN);
1986 * ata_scsiop_inq_83 - Simulate INQUIRY VPD page 83, device identity
1987 * @args: device IDENTIFY data / SCSI command of interest.
1988 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1990 * Yields two logical unit device identification designators:
1991 * - vendor specific ASCII containing the ATA serial number
1992 * - SAT defined "t10 vendor id based" containing ASCII vendor
1993 * name ("ATA "), model and serial numbers.
1996 * spin_lock_irqsave(host lock)
1998 static unsigned int ata_scsiop_inq_83(struct ata_scsi_args *args, u8 *rbuf)
2000 const int sat_model_serial_desc_len = 68;
2003 rbuf[1] = 0x83; /* this page code */
2006 /* piv=0, assoc=lu, code_set=ACSII, designator=vendor */
2008 rbuf[num + 3] = ATA_ID_SERNO_LEN;
2010 ata_id_string(args->id, (unsigned char *) rbuf + num,
2011 ATA_ID_SERNO, ATA_ID_SERNO_LEN);
2012 num += ATA_ID_SERNO_LEN;
2014 /* SAT defined lu model and serial numbers descriptor */
2015 /* piv=0, assoc=lu, code_set=ACSII, designator=t10 vendor id */
2018 rbuf[num + 3] = sat_model_serial_desc_len;
2020 memcpy(rbuf + num, "ATA ", 8);
2022 ata_id_string(args->id, (unsigned char *) rbuf + num, ATA_ID_PROD,
2024 num += ATA_ID_PROD_LEN;
2025 ata_id_string(args->id, (unsigned char *) rbuf + num, ATA_ID_SERNO,
2027 num += ATA_ID_SERNO_LEN;
2029 if (ata_id_has_wwn(args->id)) {
2030 /* SAT defined lu world wide name */
2031 /* piv=0, assoc=lu, code_set=binary, designator=NAA */
2034 rbuf[num + 3] = ATA_ID_WWN_LEN;
2036 ata_id_string(args->id, (unsigned char *) rbuf + num,
2037 ATA_ID_WWN, ATA_ID_WWN_LEN);
2038 num += ATA_ID_WWN_LEN;
2040 rbuf[3] = num - 4; /* page len (assume less than 256 bytes) */
2045 * ata_scsiop_inq_89 - Simulate INQUIRY VPD page 89, ATA info
2046 * @args: device IDENTIFY data / SCSI command of interest.
2047 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2049 * Yields SAT-specified ATA VPD page.
2052 * spin_lock_irqsave(host lock)
2054 static unsigned int ata_scsiop_inq_89(struct ata_scsi_args *args, u8 *rbuf)
2056 rbuf[1] = 0x89; /* our page code */
2057 rbuf[2] = (0x238 >> 8); /* page size fixed at 238h */
2058 rbuf[3] = (0x238 & 0xff);
2060 memcpy(&rbuf[8], "linux ", 8);
2061 memcpy(&rbuf[16], "libata ", 16);
2062 memcpy(&rbuf[32], DRV_VERSION, 4);
2064 rbuf[36] = 0x34; /* force D2H Reg FIS (34h) */
2065 rbuf[37] = (1 << 7); /* bit 7 indicates Command FIS */
2068 /* we don't store the ATA device signature, so we fake it */
2069 rbuf[38] = ATA_DRDY; /* really, this is Status reg */
2073 rbuf[56] = ATA_CMD_ID_ATA;
2075 memcpy(&rbuf[60], &args->id[0], 512);
2079 static unsigned int ata_scsiop_inq_b0(struct ata_scsi_args *args, u8 *rbuf)
2081 struct ata_device *dev = args->dev;
2085 rbuf[3] = 0x3c; /* required VPD size with unmap support */
2088 * Optimal transfer length granularity.
2090 * This is always one physical block, but for disks with a smaller
2091 * logical than physical sector size we need to figure out what the
2094 min_io_sectors = 1 << ata_id_log2_per_physical_sector(args->id);
2095 put_unaligned_be16(min_io_sectors, &rbuf[6]);
2098 * Optimal unmap granularity.
2100 * The ATA spec doesn't even know about a granularity or alignment
2101 * for the TRIM command. We can leave away most of the unmap related
2102 * VPD page entries, but we have specifify a granularity to signal
2103 * that we support some form of unmap - in thise case via WRITE SAME
2104 * with the unmap bit set.
2106 if (ata_id_has_trim(args->id)) {
2107 u64 max_blocks = 65535 * ATA_MAX_TRIM_RNUM;
2109 if (dev->horkage & ATA_HORKAGE_MAX_TRIM_128M)
2110 max_blocks = 128 << (20 - SECTOR_SHIFT);
2112 put_unaligned_be64(max_blocks, &rbuf[36]);
2113 put_unaligned_be32(1, &rbuf[28]);
2119 static unsigned int ata_scsiop_inq_b1(struct ata_scsi_args *args, u8 *rbuf)
2121 int form_factor = ata_id_form_factor(args->id);
2122 int media_rotation_rate = ata_id_rotation_rate(args->id);
2123 u8 zoned = ata_id_zoned_cap(args->id);
2127 rbuf[4] = media_rotation_rate >> 8;
2128 rbuf[5] = media_rotation_rate;
2129 rbuf[7] = form_factor;
2131 rbuf[8] = (zoned << 4);
2136 static unsigned int ata_scsiop_inq_b2(struct ata_scsi_args *args, u8 *rbuf)
2138 /* SCSI Thin Provisioning VPD page: SBC-3 rev 22 or later */
2141 rbuf[5] = 1 << 6; /* TPWS */
2146 static unsigned int ata_scsiop_inq_b6(struct ata_scsi_args *args, u8 *rbuf)
2149 * zbc-r05 SCSI Zoned Block device characteristics VPD page
2155 * URSWRZ bit is only meaningful for host-managed ZAC drives
2157 if (args->dev->zac_zoned_cap & 1)
2159 put_unaligned_be32(args->dev->zac_zones_optimal_open, &rbuf[8]);
2160 put_unaligned_be32(args->dev->zac_zones_optimal_nonseq, &rbuf[12]);
2161 put_unaligned_be32(args->dev->zac_zones_max_open, &rbuf[16]);
2167 * modecpy - Prepare response for MODE SENSE
2168 * @dest: output buffer
2169 * @src: data being copied
2170 * @n: length of mode page
2171 * @changeable: whether changeable parameters are requested
2173 * Generate a generic MODE SENSE page for either current or changeable
2179 static void modecpy(u8 *dest, const u8 *src, int n, bool changeable)
2182 memcpy(dest, src, 2);
2183 memset(dest + 2, 0, n - 2);
2185 memcpy(dest, src, n);
2190 * ata_msense_caching - Simulate MODE SENSE caching info page
2191 * @id: device IDENTIFY data
2192 * @buf: output buffer
2193 * @changeable: whether changeable parameters are requested
2195 * Generate a caching info page, which conditionally indicates
2196 * write caching to the SCSI layer, depending on device
2202 static unsigned int ata_msense_caching(u16 *id, u8 *buf, bool changeable)
2204 modecpy(buf, def_cache_mpage, sizeof(def_cache_mpage), changeable);
2206 buf[2] |= (1 << 2); /* ata_mselect_caching() */
2208 buf[2] |= (ata_id_wcache_enabled(id) << 2); /* write cache enable */
2209 buf[12] |= (!ata_id_rahead_enabled(id) << 5); /* disable read ahead */
2211 return sizeof(def_cache_mpage);
2215 * ata_msense_control - Simulate MODE SENSE control mode page
2216 * @dev: ATA device of interest
2217 * @buf: output buffer
2218 * @changeable: whether changeable parameters are requested
2220 * Generate a generic MODE SENSE control mode page.
2225 static unsigned int ata_msense_control(struct ata_device *dev, u8 *buf,
2228 modecpy(buf, def_control_mpage, sizeof(def_control_mpage), changeable);
2230 buf[2] |= (1 << 2); /* ata_mselect_control() */
2232 bool d_sense = (dev->flags & ATA_DFLAG_D_SENSE);
2234 buf[2] |= (d_sense << 2); /* descriptor format sense data */
2236 return sizeof(def_control_mpage);
2240 * ata_msense_rw_recovery - Simulate MODE SENSE r/w error recovery page
2241 * @buf: output buffer
2242 * @changeable: whether changeable parameters are requested
2244 * Generate a generic MODE SENSE r/w error recovery page.
2249 static unsigned int ata_msense_rw_recovery(u8 *buf, bool changeable)
2251 modecpy(buf, def_rw_recovery_mpage, sizeof(def_rw_recovery_mpage),
2253 return sizeof(def_rw_recovery_mpage);
2257 * We can turn this into a real blacklist if it's needed, for now just
2258 * blacklist any Maxtor BANC1G10 revision firmware
2260 static int ata_dev_supports_fua(u16 *id)
2262 unsigned char model[ATA_ID_PROD_LEN + 1], fw[ATA_ID_FW_REV_LEN + 1];
2266 if (!ata_id_has_fua(id))
2269 ata_id_c_string(id, model, ATA_ID_PROD, sizeof(model));
2270 ata_id_c_string(id, fw, ATA_ID_FW_REV, sizeof(fw));
2272 if (strcmp(model, "Maxtor"))
2274 if (strcmp(fw, "BANC1G10"))
2277 return 0; /* blacklisted */
2281 * ata_scsiop_mode_sense - Simulate MODE SENSE 6, 10 commands
2282 * @args: device IDENTIFY data / SCSI command of interest.
2283 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2285 * Simulate MODE SENSE commands. Assume this is invoked for direct
2286 * access devices (e.g. disks) only. There should be no block
2287 * descriptor for other device types.
2290 * spin_lock_irqsave(host lock)
2292 static unsigned int ata_scsiop_mode_sense(struct ata_scsi_args *args, u8 *rbuf)
2294 struct ata_device *dev = args->dev;
2295 u8 *scsicmd = args->cmd->cmnd, *p = rbuf;
2296 static const u8 sat_blk_desc[] = {
2297 0, 0, 0, 0, /* number of blocks: sat unspecified */
2299 0, 0x2, 0x0 /* block length: 512 bytes */
2302 unsigned int ebd, page_control, six_byte;
2303 u8 dpofua, bp = 0xff;
2308 six_byte = (scsicmd[0] == MODE_SENSE);
2309 ebd = !(scsicmd[1] & 0x8); /* dbd bit inverted == edb */
2311 * LLBA bit in msense(10) ignored (compliant)
2314 page_control = scsicmd[2] >> 6;
2315 switch (page_control) {
2316 case 0: /* current */
2317 case 1: /* changeable */
2318 case 2: /* defaults */
2319 break; /* supported */
2321 goto saving_not_supp;
2329 p += 4 + (ebd ? 8 : 0);
2331 p += 8 + (ebd ? 8 : 0);
2333 pg = scsicmd[2] & 0x3f;
2336 * No mode subpages supported (yet) but asking for _all_
2337 * subpages may be valid
2339 if (spg && (spg != ALL_SUB_MPAGES)) {
2345 case RW_RECOVERY_MPAGE:
2346 p += ata_msense_rw_recovery(p, page_control == 1);
2350 p += ata_msense_caching(args->id, p, page_control == 1);
2354 p += ata_msense_control(args->dev, p, page_control == 1);
2358 p += ata_msense_rw_recovery(p, page_control == 1);
2359 p += ata_msense_caching(args->id, p, page_control == 1);
2360 p += ata_msense_control(args->dev, p, page_control == 1);
2363 default: /* invalid page code */
2369 if (ata_dev_supports_fua(args->id) && (dev->flags & ATA_DFLAG_LBA48) &&
2370 (!(dev->flags & ATA_DFLAG_PIO) || dev->multi_count))
2374 rbuf[0] = p - rbuf - 1;
2377 rbuf[3] = sizeof(sat_blk_desc);
2378 memcpy(rbuf + 4, sat_blk_desc, sizeof(sat_blk_desc));
2381 unsigned int output_len = p - rbuf - 2;
2383 rbuf[0] = output_len >> 8;
2384 rbuf[1] = output_len;
2387 rbuf[7] = sizeof(sat_blk_desc);
2388 memcpy(rbuf + 8, sat_blk_desc, sizeof(sat_blk_desc));
2394 ata_scsi_set_invalid_field(dev, args->cmd, fp, bp);
2398 ata_scsi_set_sense(dev, args->cmd, ILLEGAL_REQUEST, 0x39, 0x0);
2399 /* "Saving parameters not supported" */
2404 * ata_scsiop_read_cap - Simulate READ CAPACITY[ 16] commands
2405 * @args: device IDENTIFY data / SCSI command of interest.
2406 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2408 * Simulate READ CAPACITY commands.
2413 static unsigned int ata_scsiop_read_cap(struct ata_scsi_args *args, u8 *rbuf)
2415 struct ata_device *dev = args->dev;
2416 u64 last_lba = dev->n_sectors - 1; /* LBA of the last block */
2417 u32 sector_size; /* physical sector size in bytes */
2421 sector_size = ata_id_logical_sector_size(dev->id);
2422 log2_per_phys = ata_id_log2_per_physical_sector(dev->id);
2423 lowest_aligned = ata_id_logical_sector_offset(dev->id, log2_per_phys);
2427 if (args->cmd->cmnd[0] == READ_CAPACITY) {
2428 if (last_lba >= 0xffffffffULL)
2429 last_lba = 0xffffffff;
2431 /* sector count, 32-bit */
2432 rbuf[0] = last_lba >> (8 * 3);
2433 rbuf[1] = last_lba >> (8 * 2);
2434 rbuf[2] = last_lba >> (8 * 1);
2438 rbuf[4] = sector_size >> (8 * 3);
2439 rbuf[5] = sector_size >> (8 * 2);
2440 rbuf[6] = sector_size >> (8 * 1);
2441 rbuf[7] = sector_size;
2443 /* sector count, 64-bit */
2444 rbuf[0] = last_lba >> (8 * 7);
2445 rbuf[1] = last_lba >> (8 * 6);
2446 rbuf[2] = last_lba >> (8 * 5);
2447 rbuf[3] = last_lba >> (8 * 4);
2448 rbuf[4] = last_lba >> (8 * 3);
2449 rbuf[5] = last_lba >> (8 * 2);
2450 rbuf[6] = last_lba >> (8 * 1);
2454 rbuf[ 8] = sector_size >> (8 * 3);
2455 rbuf[ 9] = sector_size >> (8 * 2);
2456 rbuf[10] = sector_size >> (8 * 1);
2457 rbuf[11] = sector_size;
2460 rbuf[13] = log2_per_phys;
2461 rbuf[14] = (lowest_aligned >> 8) & 0x3f;
2462 rbuf[15] = lowest_aligned;
2464 if (ata_id_has_trim(args->id) &&
2465 !(dev->horkage & ATA_HORKAGE_NOTRIM)) {
2466 rbuf[14] |= 0x80; /* LBPME */
2468 if (ata_id_has_zero_after_trim(args->id) &&
2469 dev->horkage & ATA_HORKAGE_ZERO_AFTER_TRIM) {
2470 ata_dev_info(dev, "Enabling discard_zeroes_data\n");
2471 rbuf[14] |= 0x40; /* LBPRZ */
2474 if (ata_id_zoned_cap(args->id) ||
2475 args->dev->class == ATA_DEV_ZAC)
2476 rbuf[12] = (1 << 4); /* RC_BASIS */
2482 * ata_scsiop_report_luns - Simulate REPORT LUNS command
2483 * @args: device IDENTIFY data / SCSI command of interest.
2484 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2486 * Simulate REPORT LUNS command.
2489 * spin_lock_irqsave(host lock)
2491 static unsigned int ata_scsiop_report_luns(struct ata_scsi_args *args, u8 *rbuf)
2494 rbuf[3] = 8; /* just one lun, LUN 0, size 8 bytes */
2499 static void atapi_sense_complete(struct ata_queued_cmd *qc)
2501 if (qc->err_mask && ((qc->err_mask & AC_ERR_DEV) == 0)) {
2502 /* FIXME: not quite right; we don't want the
2503 * translation of taskfile registers into
2504 * a sense descriptors, since that's only
2505 * correct for ATA, not ATAPI
2507 ata_gen_passthru_sense(qc);
2513 /* is it pointless to prefer PIO for "safety reasons"? */
2514 static inline int ata_pio_use_silly(struct ata_port *ap)
2516 return (ap->flags & ATA_FLAG_PIO_DMA);
2519 static void atapi_request_sense(struct ata_queued_cmd *qc)
2521 struct ata_port *ap = qc->ap;
2522 struct scsi_cmnd *cmd = qc->scsicmd;
2524 DPRINTK("ATAPI request sense\n");
2526 memset(cmd->sense_buffer, 0, SCSI_SENSE_BUFFERSIZE);
2528 #ifdef CONFIG_ATA_SFF
2529 if (ap->ops->sff_tf_read)
2530 ap->ops->sff_tf_read(ap, &qc->tf);
2533 /* fill these in, for the case where they are -not- overwritten */
2534 cmd->sense_buffer[0] = 0x70;
2535 cmd->sense_buffer[2] = qc->tf.feature >> 4;
2539 /* setup sg table and init transfer direction */
2540 sg_init_one(&qc->sgent, cmd->sense_buffer, SCSI_SENSE_BUFFERSIZE);
2541 ata_sg_init(qc, &qc->sgent, 1);
2542 qc->dma_dir = DMA_FROM_DEVICE;
2544 memset(&qc->cdb, 0, qc->dev->cdb_len);
2545 qc->cdb[0] = REQUEST_SENSE;
2546 qc->cdb[4] = SCSI_SENSE_BUFFERSIZE;
2548 qc->tf.flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
2549 qc->tf.command = ATA_CMD_PACKET;
2551 if (ata_pio_use_silly(ap)) {
2552 qc->tf.protocol = ATAPI_PROT_DMA;
2553 qc->tf.feature |= ATAPI_PKT_DMA;
2555 qc->tf.protocol = ATAPI_PROT_PIO;
2556 qc->tf.lbam = SCSI_SENSE_BUFFERSIZE;
2559 qc->nbytes = SCSI_SENSE_BUFFERSIZE;
2561 qc->complete_fn = atapi_sense_complete;
2569 * ATAPI devices typically report zero for their SCSI version, and sometimes
2570 * deviate from the spec WRT response data format. If SCSI version is
2571 * reported as zero like normal, then we make the following fixups:
2572 * 1) Fake MMC-5 version, to indicate to the Linux scsi midlayer this is a
2574 * 2) Ensure response data format / ATAPI information are always correct.
2576 static void atapi_fixup_inquiry(struct scsi_cmnd *cmd)
2580 sg_copy_to_buffer(scsi_sglist(cmd), scsi_sg_count(cmd), buf, 4);
2585 sg_copy_from_buffer(scsi_sglist(cmd), scsi_sg_count(cmd), buf, 4);
2588 static void atapi_qc_complete(struct ata_queued_cmd *qc)
2590 struct scsi_cmnd *cmd = qc->scsicmd;
2591 unsigned int err_mask = qc->err_mask;
2593 VPRINTK("ENTER, err_mask 0x%X\n", err_mask);
2595 /* handle completion from new EH */
2596 if (unlikely(qc->ap->ops->error_handler &&
2597 (err_mask || qc->flags & ATA_QCFLAG_SENSE_VALID))) {
2599 if (!(qc->flags & ATA_QCFLAG_SENSE_VALID)) {
2600 /* FIXME: not quite right; we don't want the
2601 * translation of taskfile registers into a
2602 * sense descriptors, since that's only
2603 * correct for ATA, not ATAPI
2605 ata_gen_passthru_sense(qc);
2608 /* SCSI EH automatically locks door if sdev->locked is
2609 * set. Sometimes door lock request continues to
2610 * fail, for example, when no media is present. This
2611 * creates a loop - SCSI EH issues door lock which
2612 * fails and gets invoked again to acquire sense data
2613 * for the failed command.
2615 * If door lock fails, always clear sdev->locked to
2616 * avoid this infinite loop.
2618 * This may happen before SCSI scan is complete. Make
2619 * sure qc->dev->sdev isn't NULL before dereferencing.
2621 if (qc->cdb[0] == ALLOW_MEDIUM_REMOVAL && qc->dev->sdev)
2622 qc->dev->sdev->locked = 0;
2624 qc->scsicmd->result = SAM_STAT_CHECK_CONDITION;
2629 /* successful completion or old EH failure path */
2630 if (unlikely(err_mask & AC_ERR_DEV)) {
2631 cmd->result = SAM_STAT_CHECK_CONDITION;
2632 atapi_request_sense(qc);
2634 } else if (unlikely(err_mask)) {
2635 /* FIXME: not quite right; we don't want the
2636 * translation of taskfile registers into
2637 * a sense descriptors, since that's only
2638 * correct for ATA, not ATAPI
2640 ata_gen_passthru_sense(qc);
2642 if (cmd->cmnd[0] == INQUIRY && (cmd->cmnd[1] & 0x03) == 0)
2643 atapi_fixup_inquiry(cmd);
2644 cmd->result = SAM_STAT_GOOD;
2650 * atapi_xlat - Initialize PACKET taskfile
2651 * @qc: command structure to be initialized
2654 * spin_lock_irqsave(host lock)
2657 * Zero on success, non-zero on failure.
2659 static unsigned int atapi_xlat(struct ata_queued_cmd *qc)
2661 struct scsi_cmnd *scmd = qc->scsicmd;
2662 struct ata_device *dev = qc->dev;
2663 int nodata = (scmd->sc_data_direction == DMA_NONE);
2664 int using_pio = !nodata && (dev->flags & ATA_DFLAG_PIO);
2665 unsigned int nbytes;
2667 memset(qc->cdb, 0, dev->cdb_len);
2668 memcpy(qc->cdb, scmd->cmnd, scmd->cmd_len);
2670 qc->complete_fn = atapi_qc_complete;
2672 qc->tf.flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
2673 if (scmd->sc_data_direction == DMA_TO_DEVICE) {
2674 qc->tf.flags |= ATA_TFLAG_WRITE;
2675 DPRINTK("direction: write\n");
2678 qc->tf.command = ATA_CMD_PACKET;
2679 ata_qc_set_pc_nbytes(qc);
2681 /* check whether ATAPI DMA is safe */
2682 if (!nodata && !using_pio && atapi_check_dma(qc))
2685 /* Some controller variants snoop this value for Packet
2686 * transfers to do state machine and FIFO management. Thus we
2687 * want to set it properly, and for DMA where it is
2688 * effectively meaningless.
2690 nbytes = min(ata_qc_raw_nbytes(qc), (unsigned int)63 * 1024);
2692 /* Most ATAPI devices which honor transfer chunk size don't
2693 * behave according to the spec when odd chunk size which
2694 * matches the transfer length is specified. If the number of
2695 * bytes to transfer is 2n+1. According to the spec, what
2696 * should happen is to indicate that 2n+1 is going to be
2697 * transferred and transfer 2n+2 bytes where the last byte is
2700 * In practice, this doesn't happen. ATAPI devices first
2701 * indicate and transfer 2n bytes and then indicate and
2702 * transfer 2 bytes where the last byte is padding.
2704 * This inconsistency confuses several controllers which
2705 * perform PIO using DMA such as Intel AHCIs and sil3124/32.
2706 * These controllers use actual number of transferred bytes to
2707 * update DMA pointer and transfer of 4n+2 bytes make those
2708 * controller push DMA pointer by 4n+4 bytes because SATA data
2709 * FISes are aligned to 4 bytes. This causes data corruption
2710 * and buffer overrun.
2712 * Always setting nbytes to even number solves this problem
2713 * because then ATAPI devices don't have to split data at 2n
2719 qc->tf.lbam = (nbytes & 0xFF);
2720 qc->tf.lbah = (nbytes >> 8);
2723 qc->tf.protocol = ATAPI_PROT_NODATA;
2725 qc->tf.protocol = ATAPI_PROT_PIO;
2728 qc->tf.protocol = ATAPI_PROT_DMA;
2729 qc->tf.feature |= ATAPI_PKT_DMA;
2731 if ((dev->flags & ATA_DFLAG_DMADIR) &&
2732 (scmd->sc_data_direction != DMA_TO_DEVICE))
2733 /* some SATA bridges need us to indicate data xfer direction */
2734 qc->tf.feature |= ATAPI_DMADIR;
2738 /* FIXME: We need to translate 0x05 READ_BLOCK_LIMITS to a MODE_SENSE
2739 as ATAPI tape drives don't get this right otherwise */
2743 static struct ata_device *ata_find_dev(struct ata_port *ap, int devno)
2745 if (!sata_pmp_attached(ap)) {
2746 if (likely(devno >= 0 &&
2747 devno < ata_link_max_devices(&ap->link)))
2748 return &ap->link.device[devno];
2750 if (likely(devno >= 0 &&
2751 devno < ap->nr_pmp_links))
2752 return &ap->pmp_link[devno].device[0];
2758 static struct ata_device *__ata_scsi_find_dev(struct ata_port *ap,
2759 const struct scsi_device *scsidev)
2763 /* skip commands not addressed to targets we simulate */
2764 if (!sata_pmp_attached(ap)) {
2765 if (unlikely(scsidev->channel || scsidev->lun))
2767 devno = scsidev->id;
2769 if (unlikely(scsidev->id || scsidev->lun))
2771 devno = scsidev->channel;
2774 return ata_find_dev(ap, devno);
2778 * ata_scsi_find_dev - lookup ata_device from scsi_cmnd
2779 * @ap: ATA port to which the device is attached
2780 * @scsidev: SCSI device from which we derive the ATA device
2782 * Given various information provided in struct scsi_cmnd,
2783 * map that onto an ATA bus, and using that mapping
2784 * determine which ata_device is associated with the
2785 * SCSI command to be sent.
2788 * spin_lock_irqsave(host lock)
2791 * Associated ATA device, or %NULL if not found.
2794 ata_scsi_find_dev(struct ata_port *ap, const struct scsi_device *scsidev)
2796 struct ata_device *dev = __ata_scsi_find_dev(ap, scsidev);
2798 if (unlikely(!dev || !ata_dev_enabled(dev)))
2805 * ata_scsi_map_proto - Map pass-thru protocol value to taskfile value.
2806 * @byte1: Byte 1 from pass-thru CDB.
2809 * ATA_PROT_UNKNOWN if mapping failed/unimplemented, protocol otherwise.
2812 ata_scsi_map_proto(u8 byte1)
2814 switch((byte1 & 0x1e) >> 1) {
2815 case 3: /* Non-data */
2816 return ATA_PROT_NODATA;
2819 case 10: /* UDMA Data-in */
2820 case 11: /* UDMA Data-Out */
2821 return ATA_PROT_DMA;
2823 case 4: /* PIO Data-in */
2824 case 5: /* PIO Data-out */
2825 return ATA_PROT_PIO;
2827 case 12: /* FPDMA */
2828 return ATA_PROT_NCQ;
2830 case 0: /* Hard Reset */
2832 case 8: /* Device Diagnostic */
2833 case 9: /* Device Reset */
2834 case 7: /* DMA Queued */
2835 case 15: /* Return Response Info */
2836 default: /* Reserved */
2840 return ATA_PROT_UNKNOWN;
2844 * ata_scsi_pass_thru - convert ATA pass-thru CDB to taskfile
2845 * @qc: command structure to be initialized
2847 * Handles either 12, 16, or 32-byte versions of the CDB.
2850 * Zero on success, non-zero on failure.
2852 static unsigned int ata_scsi_pass_thru(struct ata_queued_cmd *qc)
2854 struct ata_taskfile *tf = &(qc->tf);
2855 struct scsi_cmnd *scmd = qc->scsicmd;
2856 struct ata_device *dev = qc->dev;
2857 const u8 *cdb = scmd->cmnd;
2861 /* 7Fh variable length cmd means a ata pass-thru(32) */
2862 if (cdb[0] == VARIABLE_LENGTH_CMD)
2865 tf->protocol = ata_scsi_map_proto(cdb[1 + cdb_offset]);
2866 if (tf->protocol == ATA_PROT_UNKNOWN) {
2871 if (ata_is_ncq(tf->protocol) && (cdb[2 + cdb_offset] & 0x3) == 0)
2872 tf->protocol = ATA_PROT_NCQ_NODATA;
2875 tf->flags |= ATA_TFLAG_LBA;
2878 * 12 and 16 byte CDBs use different offsets to
2879 * provide the various register values.
2881 if (cdb[0] == ATA_16) {
2883 * 16-byte CDB - may contain extended commands.
2885 * If that is the case, copy the upper byte register values.
2887 if (cdb[1] & 0x01) {
2888 tf->hob_feature = cdb[3];
2889 tf->hob_nsect = cdb[5];
2890 tf->hob_lbal = cdb[7];
2891 tf->hob_lbam = cdb[9];
2892 tf->hob_lbah = cdb[11];
2893 tf->flags |= ATA_TFLAG_LBA48;
2895 tf->flags &= ~ATA_TFLAG_LBA48;
2898 * Always copy low byte, device and command registers.
2900 tf->feature = cdb[4];
2905 tf->device = cdb[13];
2906 tf->command = cdb[14];
2907 } else if (cdb[0] == ATA_12) {
2909 * 12-byte CDB - incapable of extended commands.
2911 tf->flags &= ~ATA_TFLAG_LBA48;
2913 tf->feature = cdb[3];
2918 tf->device = cdb[8];
2919 tf->command = cdb[9];
2922 * 32-byte CDB - may contain extended command fields.
2924 * If that is the case, copy the upper byte register values.
2926 if (cdb[10] & 0x01) {
2927 tf->hob_feature = cdb[20];
2928 tf->hob_nsect = cdb[22];
2929 tf->hob_lbal = cdb[16];
2930 tf->hob_lbam = cdb[15];
2931 tf->hob_lbah = cdb[14];
2932 tf->flags |= ATA_TFLAG_LBA48;
2934 tf->flags &= ~ATA_TFLAG_LBA48;
2936 tf->feature = cdb[21];
2937 tf->nsect = cdb[23];
2941 tf->device = cdb[24];
2942 tf->command = cdb[25];
2943 tf->auxiliary = get_unaligned_be32(&cdb[28]);
2946 /* For NCQ commands copy the tag value */
2947 if (ata_is_ncq(tf->protocol))
2948 tf->nsect = qc->hw_tag << 3;
2950 /* enforce correct master/slave bit */
2951 tf->device = dev->devno ?
2952 tf->device | ATA_DEV1 : tf->device & ~ATA_DEV1;
2954 switch (tf->command) {
2955 /* READ/WRITE LONG use a non-standard sect_size */
2956 case ATA_CMD_READ_LONG:
2957 case ATA_CMD_READ_LONG_ONCE:
2958 case ATA_CMD_WRITE_LONG:
2959 case ATA_CMD_WRITE_LONG_ONCE:
2960 if (tf->protocol != ATA_PROT_PIO || tf->nsect != 1) {
2964 qc->sect_size = scsi_bufflen(scmd);
2967 /* commands using reported Logical Block size (e.g. 512 or 4K) */
2968 case ATA_CMD_CFA_WRITE_NE:
2969 case ATA_CMD_CFA_TRANS_SECT:
2970 case ATA_CMD_CFA_WRITE_MULT_NE:
2971 /* XXX: case ATA_CMD_CFA_WRITE_SECTORS_WITHOUT_ERASE: */
2973 case ATA_CMD_READ_EXT:
2974 case ATA_CMD_READ_QUEUED:
2975 /* XXX: case ATA_CMD_READ_QUEUED_EXT: */
2976 case ATA_CMD_FPDMA_READ:
2977 case ATA_CMD_READ_MULTI:
2978 case ATA_CMD_READ_MULTI_EXT:
2979 case ATA_CMD_PIO_READ:
2980 case ATA_CMD_PIO_READ_EXT:
2981 case ATA_CMD_READ_STREAM_DMA_EXT:
2982 case ATA_CMD_READ_STREAM_EXT:
2983 case ATA_CMD_VERIFY:
2984 case ATA_CMD_VERIFY_EXT:
2986 case ATA_CMD_WRITE_EXT:
2987 case ATA_CMD_WRITE_FUA_EXT:
2988 case ATA_CMD_WRITE_QUEUED:
2989 case ATA_CMD_WRITE_QUEUED_FUA_EXT:
2990 case ATA_CMD_FPDMA_WRITE:
2991 case ATA_CMD_WRITE_MULTI:
2992 case ATA_CMD_WRITE_MULTI_EXT:
2993 case ATA_CMD_WRITE_MULTI_FUA_EXT:
2994 case ATA_CMD_PIO_WRITE:
2995 case ATA_CMD_PIO_WRITE_EXT:
2996 case ATA_CMD_WRITE_STREAM_DMA_EXT:
2997 case ATA_CMD_WRITE_STREAM_EXT:
2998 qc->sect_size = scmd->device->sector_size;
3001 /* Everything else uses 512 byte "sectors" */
3003 qc->sect_size = ATA_SECT_SIZE;
3007 * Set flags so that all registers will be written, pass on
3008 * write indication (used for PIO/DMA setup), result TF is
3009 * copied back and we don't whine too much about its failure.
3011 tf->flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
3012 if (scmd->sc_data_direction == DMA_TO_DEVICE)
3013 tf->flags |= ATA_TFLAG_WRITE;
3015 qc->flags |= ATA_QCFLAG_RESULT_TF | ATA_QCFLAG_QUIET;
3018 * Set transfer length.
3020 * TODO: find out if we need to do more here to
3021 * cover scatter/gather case.
3023 ata_qc_set_pc_nbytes(qc);
3025 /* We may not issue DMA commands if no DMA mode is set */
3026 if (tf->protocol == ATA_PROT_DMA && dev->dma_mode == 0) {
3031 /* We may not issue NCQ commands to devices not supporting NCQ */
3032 if (ata_is_ncq(tf->protocol) && !ata_ncq_enabled(dev)) {
3037 /* sanity check for pio multi commands */
3038 if ((cdb[1] & 0xe0) && !is_multi_taskfile(tf)) {
3043 if (is_multi_taskfile(tf)) {
3044 unsigned int multi_count = 1 << (cdb[1] >> 5);
3046 /* compare the passed through multi_count
3047 * with the cached multi_count of libata
3049 if (multi_count != dev->multi_count)
3050 ata_dev_warn(dev, "invalid multi_count %u ignored\n",
3055 * Filter SET_FEATURES - XFER MODE command -- otherwise,
3056 * SET_FEATURES - XFER MODE must be preceded/succeeded
3057 * by an update to hardware-specific registers for each
3058 * controller (i.e. the reason for ->set_piomode(),
3059 * ->set_dmamode(), and ->post_set_mode() hooks).
3061 if (tf->command == ATA_CMD_SET_FEATURES &&
3062 tf->feature == SETFEATURES_XFER) {
3063 fp = (cdb[0] == ATA_16) ? 4 : 3;
3068 * Filter TPM commands by default. These provide an
3069 * essentially uncontrolled encrypted "back door" between
3070 * applications and the disk. Set libata.allow_tpm=1 if you
3071 * have a real reason for wanting to use them. This ensures
3072 * that installed software cannot easily mess stuff up without
3073 * user intent. DVR type users will probably ship with this enabled
3074 * for movie content management.
3076 * Note that for ATA8 we can issue a DCS change and DCS freeze lock
3077 * for this and should do in future but that it is not sufficient as
3078 * DCS is an optional feature set. Thus we also do the software filter
3079 * so that we comply with the TC consortium stated goal that the user
3080 * can turn off TC features of their system.
3082 if (tf->command >= 0x5C && tf->command <= 0x5F && !libata_allow_tpm) {
3083 fp = (cdb[0] == ATA_16) ? 14 : 9;
3090 ata_scsi_set_invalid_field(dev, scmd, fp, 0xff);
3095 * ata_format_dsm_trim_descr() - SATL Write Same to DSM Trim
3096 * @cmd: SCSI command being translated
3097 * @trmax: Maximum number of entries that will fit in sector_size bytes.
3098 * @sector: Starting sector
3099 * @count: Total Range of request in logical sectors
3101 * Rewrite the WRITE SAME descriptor to be a DSM TRIM little-endian formatted
3104 * Upto 64 entries of the format:
3105 * 63:48 Range Length
3108 * Range Length of 0 is ignored.
3109 * LBA's should be sorted order and not overlap.
3111 * NOTE: this is the same format as ADD LBA(S) TO NV CACHE PINNED SET
3113 * Return: Number of bytes copied into sglist.
3115 static size_t ata_format_dsm_trim_descr(struct scsi_cmnd *cmd, u32 trmax,
3116 u64 sector, u32 count)
3118 struct scsi_device *sdp = cmd->device;
3119 size_t len = sdp->sector_size;
3123 unsigned long flags;
3125 WARN_ON(len > ATA_SCSI_RBUF_SIZE);
3127 if (len > ATA_SCSI_RBUF_SIZE)
3128 len = ATA_SCSI_RBUF_SIZE;
3130 spin_lock_irqsave(&ata_scsi_rbuf_lock, flags);
3131 buf = ((void *)ata_scsi_rbuf);
3132 memset(buf, 0, len);
3134 u64 entry = sector |
3135 ((u64)(count > 0xffff ? 0xffff : count) << 48);
3136 buf[i++] = __cpu_to_le64(entry);
3137 if (count <= 0xffff)
3142 r = sg_copy_from_buffer(scsi_sglist(cmd), scsi_sg_count(cmd), buf, len);
3143 spin_unlock_irqrestore(&ata_scsi_rbuf_lock, flags);
3149 * ata_scsi_write_same_xlat() - SATL Write Same to ATA SCT Write Same
3150 * @qc: Command to be translated
3152 * Translate a SCSI WRITE SAME command to be either a DSM TRIM command or
3153 * an SCT Write Same command.
3154 * Based on WRITE SAME has the UNMAP flag:
3156 * - When set translate to DSM TRIM
3157 * - When clear translate to SCT Write Same
3159 static unsigned int ata_scsi_write_same_xlat(struct ata_queued_cmd *qc)
3161 struct ata_taskfile *tf = &qc->tf;
3162 struct scsi_cmnd *scmd = qc->scsicmd;
3163 struct scsi_device *sdp = scmd->device;
3164 size_t len = sdp->sector_size;
3165 struct ata_device *dev = qc->dev;
3166 const u8 *cdb = scmd->cmnd;
3169 const u32 trmax = len >> 3;
3173 u8 unmap = cdb[1] & 0x8;
3175 /* we may not issue DMA commands if no DMA mode is set */
3176 if (unlikely(!dev->dma_mode))
3177 goto invalid_opcode;
3180 * We only allow sending this command through the block layer,
3181 * as it modifies the DATA OUT buffer, which would corrupt user
3182 * memory for SG_IO commands.
3184 if (unlikely(blk_rq_is_passthrough(scmd->request)))
3185 goto invalid_opcode;
3187 if (unlikely(scmd->cmd_len < 16)) {
3191 scsi_16_lba_len(cdb, &block, &n_block);
3194 (dev->horkage & ATA_HORKAGE_NOTRIM) ||
3195 !ata_id_has_trim(dev->id)) {
3200 /* If the request is too large the cmd is invalid */
3201 if (n_block > 0xffff * trmax) {
3207 * WRITE SAME always has a sector sized buffer as payload, this
3208 * should never be a multiple entry S/G list.
3210 if (!scsi_sg_count(scmd))
3211 goto invalid_param_len;
3214 * size must match sector size in bytes
3215 * For DATA SET MANAGEMENT TRIM in ACS-2 nsect (aka count)
3216 * is defined as number of 512 byte blocks to be transferred.
3219 size = ata_format_dsm_trim_descr(scmd, trmax, block, n_block);
3221 goto invalid_param_len;
3223 if (ata_ncq_enabled(dev) && ata_fpdma_dsm_supported(dev)) {
3224 /* Newer devices support queued TRIM commands */
3225 tf->protocol = ATA_PROT_NCQ;
3226 tf->command = ATA_CMD_FPDMA_SEND;
3227 tf->hob_nsect = ATA_SUBCMD_FPDMA_SEND_DSM & 0x1f;
3228 tf->nsect = qc->hw_tag << 3;
3229 tf->hob_feature = (size / 512) >> 8;
3230 tf->feature = size / 512;
3234 tf->protocol = ATA_PROT_DMA;
3235 tf->hob_feature = 0;
3236 tf->feature = ATA_DSM_TRIM;
3237 tf->hob_nsect = (size / 512) >> 8;
3238 tf->nsect = size / 512;
3239 tf->command = ATA_CMD_DSM;
3242 tf->flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE | ATA_TFLAG_LBA48 |
3245 ata_qc_set_pc_nbytes(qc);
3250 ata_scsi_set_invalid_field(dev, scmd, fp, bp);
3253 /* "Parameter list length error" */
3254 ata_scsi_set_sense(dev, scmd, ILLEGAL_REQUEST, 0x1a, 0x0);
3257 /* "Invalid command operation code" */
3258 ata_scsi_set_sense(dev, scmd, ILLEGAL_REQUEST, 0x20, 0x0);
3263 * ata_scsiop_maint_in - Simulate a subset of MAINTENANCE_IN
3264 * @args: device MAINTENANCE_IN data / SCSI command of interest.
3265 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
3267 * Yields a subset to satisfy scsi_report_opcode()
3270 * spin_lock_irqsave(host lock)
3272 static unsigned int ata_scsiop_maint_in(struct ata_scsi_args *args, u8 *rbuf)
3274 struct ata_device *dev = args->dev;
3275 u8 *cdb = args->cmd->cmnd;
3277 unsigned int err = 0;
3280 ata_dev_warn(dev, "invalid command format %d\n", cdb[2]);
3289 case SERVICE_ACTION_IN_16:
3292 case SYNCHRONIZE_CACHE:
3296 case TEST_UNIT_READY:
3297 case SEND_DIAGNOSTIC:
3298 case MAINTENANCE_IN:
3310 case MODE_SELECT_10:
3316 if (ata_id_zoned_cap(dev->id) ||
3317 dev->class == ATA_DEV_ZAC)
3320 case SECURITY_PROTOCOL_IN:
3321 case SECURITY_PROTOCOL_OUT:
3322 if (dev->flags & ATA_DFLAG_TRUSTED)
3329 rbuf[1] = supported; /* supported */
3334 * ata_scsi_report_zones_complete - convert ATA output
3335 * @qc: command structure returning the data
3337 * Convert T-13 little-endian field representation into
3338 * T-10 big-endian field representation.
3341 static void ata_scsi_report_zones_complete(struct ata_queued_cmd *qc)
3343 struct scsi_cmnd *scmd = qc->scsicmd;
3344 struct sg_mapping_iter miter;
3345 unsigned long flags;
3346 unsigned int bytes = 0;
3348 sg_miter_start(&miter, scsi_sglist(scmd), scsi_sg_count(scmd),
3349 SG_MITER_TO_SG | SG_MITER_ATOMIC);
3351 local_irq_save(flags);
3352 while (sg_miter_next(&miter)) {
3353 unsigned int offset = 0;
3358 u64 max_lba, opt_lba;
3361 /* Swizzle header */
3363 list_length = get_unaligned_le32(&hdr[0]);
3364 same = get_unaligned_le16(&hdr[4]);
3365 max_lba = get_unaligned_le64(&hdr[8]);
3366 opt_lba = get_unaligned_le64(&hdr[16]);
3367 put_unaligned_be32(list_length, &hdr[0]);
3368 hdr[4] = same & 0xf;
3369 put_unaligned_be64(max_lba, &hdr[8]);
3370 put_unaligned_be64(opt_lba, &hdr[16]);
3374 while (offset < miter.length) {
3376 u8 cond, type, non_seq, reset;
3377 u64 size, start, wp;
3379 /* Swizzle zone descriptor */
3380 rec = miter.addr + offset;
3381 type = rec[0] & 0xf;
3382 cond = (rec[1] >> 4) & 0xf;
3383 non_seq = (rec[1] & 2);
3384 reset = (rec[1] & 1);
3385 size = get_unaligned_le64(&rec[8]);
3386 start = get_unaligned_le64(&rec[16]);
3387 wp = get_unaligned_le64(&rec[24]);
3389 rec[1] = (cond << 4) | non_seq | reset;
3390 put_unaligned_be64(size, &rec[8]);
3391 put_unaligned_be64(start, &rec[16]);
3392 put_unaligned_be64(wp, &rec[24]);
3393 WARN_ON(offset + 64 > miter.length);
3398 sg_miter_stop(&miter);
3399 local_irq_restore(flags);
3401 ata_scsi_qc_complete(qc);
3404 static unsigned int ata_scsi_zbc_in_xlat(struct ata_queued_cmd *qc)
3406 struct ata_taskfile *tf = &qc->tf;
3407 struct scsi_cmnd *scmd = qc->scsicmd;
3408 const u8 *cdb = scmd->cmnd;
3409 u16 sect, fp = (u16)-1;
3410 u8 sa, options, bp = 0xff;
3414 if (unlikely(scmd->cmd_len < 16)) {
3415 ata_dev_warn(qc->dev, "invalid cdb length %d\n",
3420 scsi_16_lba_len(cdb, &block, &n_block);
3421 if (n_block != scsi_bufflen(scmd)) {
3422 ata_dev_warn(qc->dev, "non-matching transfer count (%d/%d)\n",
3423 n_block, scsi_bufflen(scmd));
3424 goto invalid_param_len;
3427 if (sa != ZI_REPORT_ZONES) {
3428 ata_dev_warn(qc->dev, "invalid service action %d\n", sa);
3433 * ZAC allows only for transfers in 512 byte blocks,
3434 * and uses a 16 bit value for the transfer count.
3436 if ((n_block / 512) > 0xffff || n_block < 512 || (n_block % 512)) {
3437 ata_dev_warn(qc->dev, "invalid transfer count %d\n", n_block);
3438 goto invalid_param_len;
3440 sect = n_block / 512;
3441 options = cdb[14] & 0xbf;
3443 if (ata_ncq_enabled(qc->dev) &&
3444 ata_fpdma_zac_mgmt_in_supported(qc->dev)) {
3445 tf->protocol = ATA_PROT_NCQ;
3446 tf->command = ATA_CMD_FPDMA_RECV;
3447 tf->hob_nsect = ATA_SUBCMD_FPDMA_RECV_ZAC_MGMT_IN & 0x1f;
3448 tf->nsect = qc->hw_tag << 3;
3449 tf->feature = sect & 0xff;
3450 tf->hob_feature = (sect >> 8) & 0xff;
3451 tf->auxiliary = ATA_SUBCMD_ZAC_MGMT_IN_REPORT_ZONES | (options << 8);
3453 tf->command = ATA_CMD_ZAC_MGMT_IN;
3454 tf->feature = ATA_SUBCMD_ZAC_MGMT_IN_REPORT_ZONES;
3455 tf->protocol = ATA_PROT_DMA;
3456 tf->hob_feature = options;
3457 tf->hob_nsect = (sect >> 8) & 0xff;
3458 tf->nsect = sect & 0xff;
3460 tf->device = ATA_LBA;
3461 tf->lbah = (block >> 16) & 0xff;
3462 tf->lbam = (block >> 8) & 0xff;
3463 tf->lbal = block & 0xff;
3464 tf->hob_lbah = (block >> 40) & 0xff;
3465 tf->hob_lbam = (block >> 32) & 0xff;
3466 tf->hob_lbal = (block >> 24) & 0xff;
3468 tf->flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE | ATA_TFLAG_LBA48;
3469 qc->flags |= ATA_QCFLAG_RESULT_TF;
3471 ata_qc_set_pc_nbytes(qc);
3473 qc->complete_fn = ata_scsi_report_zones_complete;
3478 ata_scsi_set_invalid_field(qc->dev, scmd, fp, bp);
3482 /* "Parameter list length error" */
3483 ata_scsi_set_sense(qc->dev, scmd, ILLEGAL_REQUEST, 0x1a, 0x0);
3487 static unsigned int ata_scsi_zbc_out_xlat(struct ata_queued_cmd *qc)
3489 struct ata_taskfile *tf = &qc->tf;
3490 struct scsi_cmnd *scmd = qc->scsicmd;
3491 struct ata_device *dev = qc->dev;
3492 const u8 *cdb = scmd->cmnd;
3498 if (unlikely(scmd->cmd_len < 16)) {
3504 if ((sa != ZO_CLOSE_ZONE) && (sa != ZO_FINISH_ZONE) &&
3505 (sa != ZO_OPEN_ZONE) && (sa != ZO_RESET_WRITE_POINTER)) {
3510 scsi_16_lba_len(cdb, &block, &n_block);
3513 * ZAC MANAGEMENT OUT doesn't define any length
3515 goto invalid_param_len;
3518 all = cdb[14] & 0x1;
3521 * Ignore the block address (zone ID) as defined by ZBC.
3524 } else if (block >= dev->n_sectors) {
3526 * Block must be a valid zone ID (a zone start LBA).
3532 if (ata_ncq_enabled(qc->dev) &&
3533 ata_fpdma_zac_mgmt_out_supported(qc->dev)) {
3534 tf->protocol = ATA_PROT_NCQ_NODATA;
3535 tf->command = ATA_CMD_NCQ_NON_DATA;
3536 tf->feature = ATA_SUBCMD_NCQ_NON_DATA_ZAC_MGMT_OUT;
3537 tf->nsect = qc->hw_tag << 3;
3538 tf->auxiliary = sa | ((u16)all << 8);
3540 tf->protocol = ATA_PROT_NODATA;
3541 tf->command = ATA_CMD_ZAC_MGMT_OUT;
3543 tf->hob_feature = all;
3545 tf->lbah = (block >> 16) & 0xff;
3546 tf->lbam = (block >> 8) & 0xff;
3547 tf->lbal = block & 0xff;
3548 tf->hob_lbah = (block >> 40) & 0xff;
3549 tf->hob_lbam = (block >> 32) & 0xff;
3550 tf->hob_lbal = (block >> 24) & 0xff;
3551 tf->device = ATA_LBA;
3552 tf->flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE | ATA_TFLAG_LBA48;
3557 ata_scsi_set_invalid_field(qc->dev, scmd, fp, 0xff);
3560 /* "Parameter list length error" */
3561 ata_scsi_set_sense(qc->dev, scmd, ILLEGAL_REQUEST, 0x1a, 0x0);
3566 * ata_mselect_caching - Simulate MODE SELECT for caching info page
3567 * @qc: Storage for translated ATA taskfile
3568 * @buf: input buffer
3569 * @len: number of valid bytes in the input buffer
3570 * @fp: out parameter for the failed field on error
3572 * Prepare a taskfile to modify caching information for the device.
3577 static int ata_mselect_caching(struct ata_queued_cmd *qc,
3578 const u8 *buf, int len, u16 *fp)
3580 struct ata_taskfile *tf = &qc->tf;
3581 struct ata_device *dev = qc->dev;
3582 u8 mpage[CACHE_MPAGE_LEN];
3587 * The first two bytes of def_cache_mpage are a header, so offsets
3588 * in mpage are off by 2 compared to buf. Same for len.
3591 if (len != CACHE_MPAGE_LEN - 2) {
3592 if (len < CACHE_MPAGE_LEN - 2)
3595 *fp = CACHE_MPAGE_LEN - 2;
3599 wce = buf[0] & (1 << 2);
3602 * Check that read-only bits are not modified.
3604 ata_msense_caching(dev->id, mpage, false);
3605 for (i = 0; i < CACHE_MPAGE_LEN - 2; i++) {
3608 if (mpage[i + 2] != buf[i]) {
3614 tf->flags |= ATA_TFLAG_DEVICE | ATA_TFLAG_ISADDR;
3615 tf->protocol = ATA_PROT_NODATA;
3617 tf->command = ATA_CMD_SET_FEATURES;
3618 tf->feature = wce ? SETFEATURES_WC_ON : SETFEATURES_WC_OFF;
3623 * ata_mselect_control - Simulate MODE SELECT for control page
3624 * @qc: Storage for translated ATA taskfile
3625 * @buf: input buffer
3626 * @len: number of valid bytes in the input buffer
3627 * @fp: out parameter for the failed field on error
3629 * Prepare a taskfile to modify caching information for the device.
3634 static int ata_mselect_control(struct ata_queued_cmd *qc,
3635 const u8 *buf, int len, u16 *fp)
3637 struct ata_device *dev = qc->dev;
3638 u8 mpage[CONTROL_MPAGE_LEN];
3643 * The first two bytes of def_control_mpage are a header, so offsets
3644 * in mpage are off by 2 compared to buf. Same for len.
3647 if (len != CONTROL_MPAGE_LEN - 2) {
3648 if (len < CONTROL_MPAGE_LEN - 2)
3651 *fp = CONTROL_MPAGE_LEN - 2;
3655 d_sense = buf[0] & (1 << 2);
3658 * Check that read-only bits are not modified.
3660 ata_msense_control(dev, mpage, false);
3661 for (i = 0; i < CONTROL_MPAGE_LEN - 2; i++) {
3664 if (mpage[2 + i] != buf[i]) {
3669 if (d_sense & (1 << 2))
3670 dev->flags |= ATA_DFLAG_D_SENSE;
3672 dev->flags &= ~ATA_DFLAG_D_SENSE;
3677 * ata_scsi_mode_select_xlat - Simulate MODE SELECT 6, 10 commands
3678 * @qc: Storage for translated ATA taskfile
3680 * Converts a MODE SELECT command to an ATA SET FEATURES taskfile.
3681 * Assume this is invoked for direct access devices (e.g. disks) only.
3682 * There should be no block descriptor for other device types.
3685 * spin_lock_irqsave(host lock)
3687 static unsigned int ata_scsi_mode_select_xlat(struct ata_queued_cmd *qc)
3689 struct scsi_cmnd *scmd = qc->scsicmd;
3690 const u8 *cdb = scmd->cmnd;
3692 unsigned six_byte, pg_len, hdr_len, bd_len;
3697 const u8 *p = buffer;
3701 six_byte = (cdb[0] == MODE_SELECT);
3703 if (scmd->cmd_len < 5) {
3711 if (scmd->cmd_len < 9) {
3716 len = (cdb[7] << 8) + cdb[8];
3720 /* We only support PF=1, SP=0. */
3721 if ((cdb[1] & 0x11) != 0x10) {
3723 bp = (cdb[1] & 0x01) ? 1 : 5;
3727 /* Test early for possible overrun. */
3728 if (!scsi_sg_count(scmd) || scsi_sglist(scmd)->length < len)
3729 goto invalid_param_len;
3731 /* Move past header and block descriptors. */
3733 goto invalid_param_len;
3735 if (!sg_copy_to_buffer(scsi_sglist(scmd), scsi_sg_count(scmd),
3736 buffer, sizeof(buffer)))
3737 goto invalid_param_len;
3742 bd_len = (p[6] << 8) + p[7];
3747 goto invalid_param_len;
3748 if (bd_len != 0 && bd_len != 8) {
3749 fp = (six_byte) ? 3 : 6;
3750 fp += bd_len + hdr_len;
3759 /* Parse both possible formats for the mode page headers. */
3763 goto invalid_param_len;
3766 pg_len = (p[2] << 8) | p[3];
3771 goto invalid_param_len;
3780 * No mode subpages supported (yet) but asking for _all_
3781 * subpages may be valid
3783 if (spg && (spg != ALL_SUB_MPAGES)) {
3784 fp = (p[0] & 0x40) ? 1 : 0;
3785 fp += hdr_len + bd_len;
3789 goto invalid_param_len;
3793 if (ata_mselect_caching(qc, p, pg_len, &fp) < 0) {
3794 fp += hdr_len + bd_len;
3799 if (ata_mselect_control(qc, p, pg_len, &fp) < 0) {
3800 fp += hdr_len + bd_len;
3803 goto skip; /* No ATA command to send */
3806 default: /* invalid page code */
3807 fp = bd_len + hdr_len;
3812 * Only one page has changeable data, so we only support setting one
3821 ata_scsi_set_invalid_field(qc->dev, scmd, fp, bp);
3825 ata_scsi_set_invalid_parameter(qc->dev, scmd, fp);
3829 /* "Parameter list length error" */
3830 ata_scsi_set_sense(qc->dev, scmd, ILLEGAL_REQUEST, 0x1a, 0x0);
3834 scmd->result = SAM_STAT_GOOD;
3838 static u8 ata_scsi_trusted_op(u32 len, bool send, bool dma)
3841 return ATA_CMD_TRUSTED_NONDATA;
3843 return dma ? ATA_CMD_TRUSTED_SND_DMA : ATA_CMD_TRUSTED_SND;
3845 return dma ? ATA_CMD_TRUSTED_RCV_DMA : ATA_CMD_TRUSTED_RCV;
3848 static unsigned int ata_scsi_security_inout_xlat(struct ata_queued_cmd *qc)
3850 struct scsi_cmnd *scmd = qc->scsicmd;
3851 const u8 *cdb = scmd->cmnd;
3852 struct ata_taskfile *tf = &qc->tf;
3854 bool send = (cdb[0] == SECURITY_PROTOCOL_OUT);
3855 u16 spsp = get_unaligned_be16(&cdb[2]);
3856 u32 len = get_unaligned_be32(&cdb[6]);
3857 bool dma = !(qc->dev->flags & ATA_DFLAG_PIO);
3860 * We don't support the ATA "security" protocol.
3863 ata_scsi_set_invalid_field(qc->dev, scmd, 1, 0);
3867 if (cdb[4] & 7) { /* INC_512 */
3869 ata_scsi_set_invalid_field(qc->dev, scmd, 6, 0);
3873 if (len > 0x01fffe00) {
3874 ata_scsi_set_invalid_field(qc->dev, scmd, 6, 0);
3878 /* convert to the sector-based ATA addressing */
3879 len = (len + 511) / 512;
3882 tf->protocol = dma ? ATA_PROT_DMA : ATA_PROT_PIO;
3883 tf->flags |= ATA_TFLAG_DEVICE | ATA_TFLAG_ISADDR | ATA_TFLAG_LBA;
3885 tf->flags |= ATA_TFLAG_WRITE;
3886 tf->command = ata_scsi_trusted_op(len, send, dma);
3888 tf->lbam = spsp & 0xff;
3889 tf->lbah = spsp >> 8;
3892 tf->nsect = len & 0xff;
3893 tf->lbal = len >> 8;
3896 tf->lbah = (1 << 7);
3899 ata_qc_set_pc_nbytes(qc);
3904 * ata_scsi_var_len_cdb_xlat - SATL variable length CDB to Handler
3905 * @qc: Command to be translated
3907 * Translate a SCSI variable length CDB to specified commands.
3908 * It checks a service action value in CDB to call corresponding handler.
3911 * Zero on success, non-zero on failure
3914 static unsigned int ata_scsi_var_len_cdb_xlat(struct ata_queued_cmd *qc)
3916 struct scsi_cmnd *scmd = qc->scsicmd;
3917 const u8 *cdb = scmd->cmnd;
3918 const u16 sa = get_unaligned_be16(&cdb[8]);
3921 * if service action represents a ata pass-thru(32) command,
3922 * then pass it to ata_scsi_pass_thru handler.
3925 return ata_scsi_pass_thru(qc);
3927 /* unsupported service action */
3932 * ata_get_xlat_func - check if SCSI to ATA translation is possible
3934 * @cmd: SCSI command opcode to consider
3936 * Look up the SCSI command given, and determine whether the
3937 * SCSI command is to be translated or simulated.
3940 * Pointer to translation function if possible, %NULL if not.
3943 static inline ata_xlat_func_t ata_get_xlat_func(struct ata_device *dev, u8 cmd)
3953 return ata_scsi_rw_xlat;
3956 return ata_scsi_write_same_xlat;
3958 case SYNCHRONIZE_CACHE:
3959 if (ata_try_flush_cache(dev))
3960 return ata_scsi_flush_xlat;
3965 return ata_scsi_verify_xlat;
3969 return ata_scsi_pass_thru;
3971 case VARIABLE_LENGTH_CMD:
3972 return ata_scsi_var_len_cdb_xlat;
3975 case MODE_SELECT_10:
3976 return ata_scsi_mode_select_xlat;
3980 return ata_scsi_zbc_in_xlat;
3983 return ata_scsi_zbc_out_xlat;
3985 case SECURITY_PROTOCOL_IN:
3986 case SECURITY_PROTOCOL_OUT:
3987 if (!(dev->flags & ATA_DFLAG_TRUSTED))
3989 return ata_scsi_security_inout_xlat;
3992 return ata_scsi_start_stop_xlat;
3999 * ata_scsi_dump_cdb - dump SCSI command contents to dmesg
4000 * @ap: ATA port to which the command was being sent
4001 * @cmd: SCSI command to dump
4003 * Prints the contents of a SCSI command via printk().
4006 void ata_scsi_dump_cdb(struct ata_port *ap, struct scsi_cmnd *cmd)
4008 #ifdef ATA_VERBOSE_DEBUG
4009 struct scsi_device *scsidev = cmd->device;
4011 VPRINTK("CDB (%u:%d,%d,%lld) %9ph\n",
4013 scsidev->channel, scsidev->id, scsidev->lun,
4018 int __ata_scsi_queuecmd(struct scsi_cmnd *scmd, struct ata_device *dev)
4020 u8 scsi_op = scmd->cmnd[0];
4021 ata_xlat_func_t xlat_func;
4024 if (dev->class == ATA_DEV_ATA || dev->class == ATA_DEV_ZAC) {
4025 if (unlikely(!scmd->cmd_len || scmd->cmd_len > dev->cdb_len))
4028 xlat_func = ata_get_xlat_func(dev, scsi_op);
4030 if (unlikely(!scmd->cmd_len))
4034 if (likely((scsi_op != ATA_16) || !atapi_passthru16)) {
4035 /* relay SCSI command to ATAPI device */
4036 int len = COMMAND_SIZE(scsi_op);
4037 if (unlikely(len > scmd->cmd_len ||
4038 len > dev->cdb_len ||
4039 scmd->cmd_len > ATAPI_CDB_LEN))
4042 xlat_func = atapi_xlat;
4044 /* ATA_16 passthru, treat as an ATA command */
4045 if (unlikely(scmd->cmd_len > 16))
4048 xlat_func = ata_get_xlat_func(dev, scsi_op);
4053 rc = ata_scsi_translate(dev, scmd, xlat_func);
4055 ata_scsi_simulate(dev, scmd);
4060 DPRINTK("bad CDB len=%u, scsi_op=0x%02x, max=%u\n",
4061 scmd->cmd_len, scsi_op, dev->cdb_len);
4062 scmd->result = DID_ERROR << 16;
4063 scmd->scsi_done(scmd);
4068 * ata_scsi_queuecmd - Issue SCSI cdb to libata-managed device
4069 * @shost: SCSI host of command to be sent
4070 * @cmd: SCSI command to be sent
4072 * In some cases, this function translates SCSI commands into
4073 * ATA taskfiles, and queues the taskfiles to be sent to
4074 * hardware. In other cases, this function simulates a
4075 * SCSI device by evaluating and responding to certain
4076 * SCSI commands. This creates the overall effect of
4077 * ATA and ATAPI devices appearing as SCSI devices.
4083 * Return value from __ata_scsi_queuecmd() if @cmd can be queued,
4086 int ata_scsi_queuecmd(struct Scsi_Host *shost, struct scsi_cmnd *cmd)
4088 struct ata_port *ap;
4089 struct ata_device *dev;
4090 struct scsi_device *scsidev = cmd->device;
4092 unsigned long irq_flags;
4094 ap = ata_shost_to_port(shost);
4096 spin_lock_irqsave(ap->lock, irq_flags);
4098 ata_scsi_dump_cdb(ap, cmd);
4100 dev = ata_scsi_find_dev(ap, scsidev);
4102 rc = __ata_scsi_queuecmd(cmd, dev);
4104 cmd->result = (DID_BAD_TARGET << 16);
4105 cmd->scsi_done(cmd);
4108 spin_unlock_irqrestore(ap->lock, irq_flags);
4112 EXPORT_SYMBOL_GPL(ata_scsi_queuecmd);
4115 * ata_scsi_simulate - simulate SCSI command on ATA device
4116 * @dev: the target device
4117 * @cmd: SCSI command being sent to device.
4119 * Interprets and directly executes a select list of SCSI commands
4120 * that can be handled internally.
4123 * spin_lock_irqsave(host lock)
4126 void ata_scsi_simulate(struct ata_device *dev, struct scsi_cmnd *cmd)
4128 struct ata_scsi_args args;
4129 const u8 *scsicmd = cmd->cmnd;
4136 switch(scsicmd[0]) {
4138 if (scsicmd[1] & 2) /* is CmdDt set? */
4139 ata_scsi_set_invalid_field(dev, cmd, 1, 0xff);
4140 else if ((scsicmd[1] & 1) == 0) /* is EVPD clear? */
4141 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_std);
4142 else switch (scsicmd[2]) {
4144 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_00);
4147 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_80);
4150 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_83);
4153 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_89);
4156 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_b0);
4159 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_b1);
4162 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_b2);
4165 if (dev->flags & ATA_DFLAG_ZAC) {
4166 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_b6);
4171 ata_scsi_set_invalid_field(dev, cmd, 2, 0xff);
4178 ata_scsi_rbuf_fill(&args, ata_scsiop_mode_sense);
4182 ata_scsi_rbuf_fill(&args, ata_scsiop_read_cap);
4185 case SERVICE_ACTION_IN_16:
4186 if ((scsicmd[1] & 0x1f) == SAI_READ_CAPACITY_16)
4187 ata_scsi_rbuf_fill(&args, ata_scsiop_read_cap);
4189 ata_scsi_set_invalid_field(dev, cmd, 1, 0xff);
4193 ata_scsi_rbuf_fill(&args, ata_scsiop_report_luns);
4197 ata_scsi_set_sense(dev, cmd, 0, 0, 0);
4200 /* if we reach this, then writeback caching is disabled,
4201 * turning this into a no-op.
4203 case SYNCHRONIZE_CACHE:
4206 /* no-op's, complete with success */
4210 case TEST_UNIT_READY:
4213 case SEND_DIAGNOSTIC:
4214 tmp8 = scsicmd[1] & ~(1 << 3);
4215 if (tmp8 != 0x4 || scsicmd[3] || scsicmd[4])
4216 ata_scsi_set_invalid_field(dev, cmd, 1, 0xff);
4219 case MAINTENANCE_IN:
4220 if (scsicmd[1] == MI_REPORT_SUPPORTED_OPERATION_CODES)
4221 ata_scsi_rbuf_fill(&args, ata_scsiop_maint_in);
4223 ata_scsi_set_invalid_field(dev, cmd, 1, 0xff);
4226 /* all other commands */
4228 ata_scsi_set_sense(dev, cmd, ILLEGAL_REQUEST, 0x20, 0x0);
4229 /* "Invalid command operation code" */
4233 cmd->scsi_done(cmd);
4236 int ata_scsi_add_hosts(struct ata_host *host, struct scsi_host_template *sht)
4240 for (i = 0; i < host->n_ports; i++) {
4241 struct ata_port *ap = host->ports[i];
4242 struct Scsi_Host *shost;
4245 shost = scsi_host_alloc(sht, sizeof(struct ata_port *));
4249 shost->eh_noresume = 1;
4250 *(struct ata_port **)&shost->hostdata[0] = ap;
4251 ap->scsi_host = shost;
4253 shost->transportt = ata_scsi_transport_template;
4254 shost->unique_id = ap->print_id;
4257 shost->max_channel = 1;
4258 shost->max_cmd_len = 32;
4260 /* Schedule policy is determined by ->qc_defer()
4261 * callback and it needs to see every deferred qc.
4262 * Set host_blocked to 1 to prevent SCSI midlayer from
4263 * automatically deferring requests.
4265 shost->max_host_blocked = 1;
4267 rc = scsi_add_host_with_dma(shost, &ap->tdev, ap->host->dev);
4276 struct Scsi_Host *shost = host->ports[i]->scsi_host;
4278 /* scsi_host_put() is in ata_devres_release() */
4279 scsi_remove_host(shost);
4285 static void ata_scsi_assign_ofnode(struct ata_device *dev, struct ata_port *ap)
4287 struct scsi_device *sdev = dev->sdev;
4288 struct device *d = ap->host->dev;
4289 struct device_node *np = d->of_node;
4290 struct device_node *child;
4292 for_each_available_child_of_node(np, child) {
4296 ret = of_property_read_u32(child, "reg", &val);
4299 if (val == dev->devno) {
4300 dev_dbg(d, "found matching device node\n");
4301 sdev->sdev_gendev.of_node = child;
4307 static void ata_scsi_assign_ofnode(struct ata_device *dev, struct ata_port *ap)
4312 void ata_scsi_scan_host(struct ata_port *ap, int sync)
4315 struct ata_device *last_failed_dev = NULL;
4316 struct ata_link *link;
4317 struct ata_device *dev;
4320 ata_for_each_link(link, ap, EDGE) {
4321 ata_for_each_dev(dev, link, ENABLED) {
4322 struct scsi_device *sdev;
4323 int channel = 0, id = 0;
4328 if (ata_is_host_link(link))
4331 channel = link->pmp;
4333 sdev = __scsi_add_device(ap->scsi_host, channel, id, 0,
4335 if (!IS_ERR(sdev)) {
4337 ata_scsi_assign_ofnode(dev, ap);
4338 scsi_device_put(sdev);
4345 /* If we scanned while EH was in progress or allocation
4346 * failure occurred, scan would have failed silently. Check
4347 * whether all devices are attached.
4349 ata_for_each_link(link, ap, EDGE) {
4350 ata_for_each_dev(dev, link, ENABLED) {
4359 /* we're missing some SCSI devices */
4361 /* If caller requested synchrnous scan && we've made
4362 * any progress, sleep briefly and repeat.
4364 if (dev != last_failed_dev) {
4366 last_failed_dev = dev;
4370 /* We might be failing to detect boot device, give it
4371 * a few more chances.
4379 "WARNING: synchronous SCSI scan failed without making any progress, switching to async\n");
4382 queue_delayed_work(system_long_wq, &ap->hotplug_task,
4383 round_jiffies_relative(HZ));
4387 * ata_scsi_offline_dev - offline attached SCSI device
4388 * @dev: ATA device to offline attached SCSI device for
4390 * This function is called from ata_eh_hotplug() and responsible
4391 * for taking the SCSI device attached to @dev offline. This
4392 * function is called with host lock which protects dev->sdev
4396 * spin_lock_irqsave(host lock)
4399 * 1 if attached SCSI device exists, 0 otherwise.
4401 int ata_scsi_offline_dev(struct ata_device *dev)
4404 scsi_device_set_state(dev->sdev, SDEV_OFFLINE);
4411 * ata_scsi_remove_dev - remove attached SCSI device
4412 * @dev: ATA device to remove attached SCSI device for
4414 * This function is called from ata_eh_scsi_hotplug() and
4415 * responsible for removing the SCSI device attached to @dev.
4418 * Kernel thread context (may sleep).
4420 static void ata_scsi_remove_dev(struct ata_device *dev)
4422 struct ata_port *ap = dev->link->ap;
4423 struct scsi_device *sdev;
4424 unsigned long flags;
4426 /* Alas, we need to grab scan_mutex to ensure SCSI device
4427 * state doesn't change underneath us and thus
4428 * scsi_device_get() always succeeds. The mutex locking can
4429 * be removed if there is __scsi_device_get() interface which
4430 * increments reference counts regardless of device state.
4432 mutex_lock(&ap->scsi_host->scan_mutex);
4433 spin_lock_irqsave(ap->lock, flags);
4435 /* clearing dev->sdev is protected by host lock */
4440 /* If user initiated unplug races with us, sdev can go
4441 * away underneath us after the host lock and
4442 * scan_mutex are released. Hold onto it.
4444 if (scsi_device_get(sdev) == 0) {
4445 /* The following ensures the attached sdev is
4446 * offline on return from ata_scsi_offline_dev()
4447 * regardless it wins or loses the race
4448 * against this function.
4450 scsi_device_set_state(sdev, SDEV_OFFLINE);
4457 spin_unlock_irqrestore(ap->lock, flags);
4458 mutex_unlock(&ap->scsi_host->scan_mutex);
4461 ata_dev_info(dev, "detaching (SCSI %s)\n",
4462 dev_name(&sdev->sdev_gendev));
4464 scsi_remove_device(sdev);
4465 scsi_device_put(sdev);
4469 static void ata_scsi_handle_link_detach(struct ata_link *link)
4471 struct ata_port *ap = link->ap;
4472 struct ata_device *dev;
4474 ata_for_each_dev(dev, link, ALL) {
4475 unsigned long flags;
4477 if (!(dev->flags & ATA_DFLAG_DETACHED))
4480 spin_lock_irqsave(ap->lock, flags);
4481 dev->flags &= ~ATA_DFLAG_DETACHED;
4482 spin_unlock_irqrestore(ap->lock, flags);
4484 if (zpodd_dev_enabled(dev))
4487 ata_scsi_remove_dev(dev);
4492 * ata_scsi_media_change_notify - send media change event
4493 * @dev: Pointer to the disk device with media change event
4495 * Tell the block layer to send a media change notification
4499 * spin_lock_irqsave(host lock)
4501 void ata_scsi_media_change_notify(struct ata_device *dev)
4504 sdev_evt_send_simple(dev->sdev, SDEV_EVT_MEDIA_CHANGE,
4509 * ata_scsi_hotplug - SCSI part of hotplug
4510 * @work: Pointer to ATA port to perform SCSI hotplug on
4512 * Perform SCSI part of hotplug. It's executed from a separate
4513 * workqueue after EH completes. This is necessary because SCSI
4514 * hot plugging requires working EH and hot unplugging is
4515 * synchronized with hot plugging with a mutex.
4518 * Kernel thread context (may sleep).
4520 void ata_scsi_hotplug(struct work_struct *work)
4522 struct ata_port *ap =
4523 container_of(work, struct ata_port, hotplug_task.work);
4526 if (ap->pflags & ATA_PFLAG_UNLOADING) {
4527 DPRINTK("ENTER/EXIT - unloading\n");
4532 mutex_lock(&ap->scsi_scan_mutex);
4534 /* Unplug detached devices. We cannot use link iterator here
4535 * because PMP links have to be scanned even if PMP is
4536 * currently not attached. Iterate manually.
4538 ata_scsi_handle_link_detach(&ap->link);
4540 for (i = 0; i < SATA_PMP_MAX_PORTS; i++)
4541 ata_scsi_handle_link_detach(&ap->pmp_link[i]);
4543 /* scan for new ones */
4544 ata_scsi_scan_host(ap, 0);
4546 mutex_unlock(&ap->scsi_scan_mutex);
4551 * ata_scsi_user_scan - indication for user-initiated bus scan
4552 * @shost: SCSI host to scan
4553 * @channel: Channel to scan
4557 * This function is called when user explicitly requests bus
4558 * scan. Set probe pending flag and invoke EH.
4561 * SCSI layer (we don't care)
4566 int ata_scsi_user_scan(struct Scsi_Host *shost, unsigned int channel,
4567 unsigned int id, u64 lun)
4569 struct ata_port *ap = ata_shost_to_port(shost);
4570 unsigned long flags;
4573 if (!ap->ops->error_handler)
4576 if (lun != SCAN_WILD_CARD && lun)
4579 if (!sata_pmp_attached(ap)) {
4580 if (channel != SCAN_WILD_CARD && channel)
4584 if (id != SCAN_WILD_CARD && id)
4589 spin_lock_irqsave(ap->lock, flags);
4591 if (devno == SCAN_WILD_CARD) {
4592 struct ata_link *link;
4594 ata_for_each_link(link, ap, EDGE) {
4595 struct ata_eh_info *ehi = &link->eh_info;
4596 ehi->probe_mask |= ATA_ALL_DEVICES;
4597 ehi->action |= ATA_EH_RESET;
4600 struct ata_device *dev = ata_find_dev(ap, devno);
4603 struct ata_eh_info *ehi = &dev->link->eh_info;
4604 ehi->probe_mask |= 1 << dev->devno;
4605 ehi->action |= ATA_EH_RESET;
4611 ata_port_schedule_eh(ap);
4612 spin_unlock_irqrestore(ap->lock, flags);
4613 ata_port_wait_eh(ap);
4615 spin_unlock_irqrestore(ap->lock, flags);
4621 * ata_scsi_dev_rescan - initiate scsi_rescan_device()
4622 * @work: Pointer to ATA port to perform scsi_rescan_device()
4624 * After ATA pass thru (SAT) commands are executed successfully,
4625 * libata need to propagate the changes to SCSI layer.
4628 * Kernel thread context (may sleep).
4630 void ata_scsi_dev_rescan(struct work_struct *work)
4632 struct ata_port *ap =
4633 container_of(work, struct ata_port, scsi_rescan_task);
4634 struct ata_link *link;
4635 struct ata_device *dev;
4636 unsigned long flags;
4638 mutex_lock(&ap->scsi_scan_mutex);
4639 spin_lock_irqsave(ap->lock, flags);
4641 ata_for_each_link(link, ap, EDGE) {
4642 ata_for_each_dev(dev, link, ENABLED) {
4643 struct scsi_device *sdev = dev->sdev;
4647 if (scsi_device_get(sdev))
4650 spin_unlock_irqrestore(ap->lock, flags);
4651 scsi_rescan_device(&(sdev->sdev_gendev));
4652 scsi_device_put(sdev);
4653 spin_lock_irqsave(ap->lock, flags);
4657 spin_unlock_irqrestore(ap->lock, flags);
4658 mutex_unlock(&ap->scsi_scan_mutex);