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;
96 unsigned int uninitialized_var(msecs);
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 cmd->result = (DRIVER_SENSE << 24) | SAM_STAT_CHECK_CONDITION;
201 scsi_build_sense_buffer(d_sense, cmd->sense_buffer, sk, asc, ascq);
204 void ata_scsi_set_sense_information(struct ata_device *dev,
205 struct scsi_cmnd *cmd,
206 const struct ata_taskfile *tf)
213 information = ata_tf_read_block(tf, dev);
214 if (information == U64_MAX)
217 scsi_set_sense_information(cmd->sense_buffer,
218 SCSI_SENSE_BUFFERSIZE, information);
221 static void ata_scsi_set_invalid_field(struct ata_device *dev,
222 struct scsi_cmnd *cmd, u16 field, u8 bit)
224 ata_scsi_set_sense(dev, cmd, ILLEGAL_REQUEST, 0x24, 0x0);
225 /* "Invalid field in CDB" */
226 scsi_set_sense_field_pointer(cmd->sense_buffer, SCSI_SENSE_BUFFERSIZE,
230 static void ata_scsi_set_invalid_parameter(struct ata_device *dev,
231 struct scsi_cmnd *cmd, u16 field)
233 /* "Invalid field in parameter list" */
234 ata_scsi_set_sense(dev, cmd, ILLEGAL_REQUEST, 0x26, 0x0);
235 scsi_set_sense_field_pointer(cmd->sense_buffer, SCSI_SENSE_BUFFERSIZE,
239 struct device_attribute *ata_common_sdev_attrs[] = {
240 &dev_attr_unload_heads,
243 EXPORT_SYMBOL_GPL(ata_common_sdev_attrs);
246 * ata_std_bios_param - generic bios head/sector/cylinder calculator used by sd.
247 * @sdev: SCSI device for which BIOS geometry is to be determined
248 * @bdev: block device associated with @sdev
249 * @capacity: capacity of SCSI device
250 * @geom: location to which geometry will be output
252 * Generic bios head/sector/cylinder calculator
253 * used by sd. Most BIOSes nowadays expect a XXX/255/16 (CHS)
254 * mapping. Some situations may arise where the disk is not
255 * bootable if this is not used.
258 * Defined by the SCSI layer. We don't really care.
263 int ata_std_bios_param(struct scsi_device *sdev, struct block_device *bdev,
264 sector_t capacity, int geom[])
268 sector_div(capacity, 255*63);
273 EXPORT_SYMBOL_GPL(ata_std_bios_param);
276 * ata_scsi_unlock_native_capacity - unlock native capacity
277 * @sdev: SCSI device to adjust device capacity for
279 * This function is called if a partition on @sdev extends beyond
280 * the end of the device. It requests EH to unlock HPA.
283 * Defined by the SCSI layer. Might sleep.
285 void ata_scsi_unlock_native_capacity(struct scsi_device *sdev)
287 struct ata_port *ap = ata_shost_to_port(sdev->host);
288 struct ata_device *dev;
291 spin_lock_irqsave(ap->lock, flags);
293 dev = ata_scsi_find_dev(ap, sdev);
294 if (dev && dev->n_sectors < dev->n_native_sectors) {
295 dev->flags |= ATA_DFLAG_UNLOCK_HPA;
296 dev->link->eh_info.action |= ATA_EH_RESET;
297 ata_port_schedule_eh(ap);
300 spin_unlock_irqrestore(ap->lock, flags);
301 ata_port_wait_eh(ap);
303 EXPORT_SYMBOL_GPL(ata_scsi_unlock_native_capacity);
306 * ata_get_identity - Handler for HDIO_GET_IDENTITY ioctl
308 * @sdev: SCSI device to get identify data for
309 * @arg: User buffer area for identify data
312 * Defined by the SCSI layer. We don't really care.
315 * Zero on success, negative errno on error.
317 static int ata_get_identity(struct ata_port *ap, struct scsi_device *sdev,
320 struct ata_device *dev = ata_scsi_find_dev(ap, sdev);
321 u16 __user *dst = arg;
327 if (copy_to_user(dst, dev->id, ATA_ID_WORDS * sizeof(u16)))
330 ata_id_string(dev->id, buf, ATA_ID_PROD, ATA_ID_PROD_LEN);
331 if (copy_to_user(dst + ATA_ID_PROD, buf, ATA_ID_PROD_LEN))
334 ata_id_string(dev->id, buf, ATA_ID_FW_REV, ATA_ID_FW_REV_LEN);
335 if (copy_to_user(dst + ATA_ID_FW_REV, buf, ATA_ID_FW_REV_LEN))
338 ata_id_string(dev->id, buf, ATA_ID_SERNO, ATA_ID_SERNO_LEN);
339 if (copy_to_user(dst + ATA_ID_SERNO, buf, ATA_ID_SERNO_LEN))
346 * ata_cmd_ioctl - Handler for HDIO_DRIVE_CMD ioctl
347 * @scsidev: Device to which we are issuing command
348 * @arg: User provided data for issuing command
351 * Defined by the SCSI layer. We don't really care.
354 * Zero on success, negative errno on error.
356 int ata_cmd_ioctl(struct scsi_device *scsidev, void __user *arg)
359 u8 sensebuf[SCSI_SENSE_BUFFERSIZE];
360 u8 scsi_cmd[MAX_COMMAND_SIZE];
361 u8 args[4], *argbuf = NULL;
363 enum dma_data_direction data_dir;
364 struct scsi_sense_hdr sshdr;
370 if (copy_from_user(args, arg, sizeof(args)))
373 memset(sensebuf, 0, sizeof(sensebuf));
374 memset(scsi_cmd, 0, sizeof(scsi_cmd));
377 argsize = ATA_SECT_SIZE * args[3];
378 argbuf = kmalloc(argsize, GFP_KERNEL);
379 if (argbuf == NULL) {
384 scsi_cmd[1] = (4 << 1); /* PIO Data-in */
385 scsi_cmd[2] = 0x0e; /* no off.line or cc, read from dev,
386 block count in sector count field */
387 data_dir = DMA_FROM_DEVICE;
389 scsi_cmd[1] = (3 << 1); /* Non-data */
390 scsi_cmd[2] = 0x20; /* cc but no off.line or data xfer */
394 scsi_cmd[0] = ATA_16;
396 scsi_cmd[4] = args[2];
397 if (args[0] == ATA_CMD_SMART) { /* hack -- ide driver does this too */
398 scsi_cmd[6] = args[3];
399 scsi_cmd[8] = args[1];
400 scsi_cmd[10] = ATA_SMART_LBAM_PASS;
401 scsi_cmd[12] = ATA_SMART_LBAH_PASS;
403 scsi_cmd[6] = args[1];
405 scsi_cmd[14] = args[0];
407 /* Good values for timeout and retries? Values below
408 from scsi_ioctl_send_command() for default case... */
409 cmd_result = scsi_execute(scsidev, scsi_cmd, data_dir, argbuf, argsize,
410 sensebuf, &sshdr, (10*HZ), 5, 0, 0, NULL);
412 if (driver_byte(cmd_result) == DRIVER_SENSE) {/* sense data available */
413 u8 *desc = sensebuf + 8;
414 cmd_result &= ~(0xFF<<24); /* DRIVER_SENSE is not an error */
416 /* If we set cc then ATA pass-through will cause a
417 * check condition even if no error. Filter that. */
418 if (cmd_result & SAM_STAT_CHECK_CONDITION) {
419 if (sshdr.sense_key == RECOVERED_ERROR &&
420 sshdr.asc == 0 && sshdr.ascq == 0x1d)
421 cmd_result &= ~SAM_STAT_CHECK_CONDITION;
424 /* Send userspace a few ATA registers (same as drivers/ide) */
425 if (sensebuf[0] == 0x72 && /* format is "descriptor" */
426 desc[0] == 0x09) { /* code is "ATA Descriptor" */
427 args[0] = desc[13]; /* status */
428 args[1] = desc[3]; /* error */
429 args[2] = desc[5]; /* sector count (0:7) */
430 if (copy_to_user(arg, args, sizeof(args)))
442 && copy_to_user(arg + sizeof(args), argbuf, argsize))
450 * ata_task_ioctl - Handler for HDIO_DRIVE_TASK ioctl
451 * @scsidev: Device to which we are issuing command
452 * @arg: User provided data for issuing command
455 * Defined by the SCSI layer. We don't really care.
458 * Zero on success, negative errno on error.
460 int ata_task_ioctl(struct scsi_device *scsidev, void __user *arg)
463 u8 sensebuf[SCSI_SENSE_BUFFERSIZE];
464 u8 scsi_cmd[MAX_COMMAND_SIZE];
466 struct scsi_sense_hdr sshdr;
472 if (copy_from_user(args, arg, sizeof(args)))
475 memset(sensebuf, 0, sizeof(sensebuf));
476 memset(scsi_cmd, 0, sizeof(scsi_cmd));
477 scsi_cmd[0] = ATA_16;
478 scsi_cmd[1] = (3 << 1); /* Non-data */
479 scsi_cmd[2] = 0x20; /* cc but no off.line or data xfer */
480 scsi_cmd[4] = args[1];
481 scsi_cmd[6] = args[2];
482 scsi_cmd[8] = args[3];
483 scsi_cmd[10] = args[4];
484 scsi_cmd[12] = args[5];
485 scsi_cmd[13] = args[6] & 0x4f;
486 scsi_cmd[14] = args[0];
488 /* Good values for timeout and retries? Values below
489 from scsi_ioctl_send_command() for default case... */
490 cmd_result = scsi_execute(scsidev, scsi_cmd, DMA_NONE, NULL, 0,
491 sensebuf, &sshdr, (10*HZ), 5, 0, 0, NULL);
493 if (driver_byte(cmd_result) == DRIVER_SENSE) {/* sense data available */
494 u8 *desc = sensebuf + 8;
495 cmd_result &= ~(0xFF<<24); /* DRIVER_SENSE is not an error */
497 /* If we set cc then ATA pass-through will cause a
498 * check condition even if no error. Filter that. */
499 if (cmd_result & SAM_STAT_CHECK_CONDITION) {
500 if (sshdr.sense_key == RECOVERED_ERROR &&
501 sshdr.asc == 0 && sshdr.ascq == 0x1d)
502 cmd_result &= ~SAM_STAT_CHECK_CONDITION;
505 /* Send userspace ATA registers */
506 if (sensebuf[0] == 0x72 && /* format is "descriptor" */
507 desc[0] == 0x09) {/* code is "ATA Descriptor" */
508 args[0] = desc[13]; /* status */
509 args[1] = desc[3]; /* error */
510 args[2] = desc[5]; /* sector count (0:7) */
511 args[3] = desc[7]; /* lbal */
512 args[4] = desc[9]; /* lbam */
513 args[5] = desc[11]; /* lbah */
514 args[6] = desc[12]; /* select */
515 if (copy_to_user(arg, args, sizeof(args)))
529 static int ata_ioc32(struct ata_port *ap)
531 if (ap->flags & ATA_FLAG_PIO_DMA)
533 if (ap->pflags & ATA_PFLAG_PIO32)
539 * This handles both native and compat commands, so anything added
540 * here must have a compatible argument, or check in_compat_syscall()
542 int ata_sas_scsi_ioctl(struct ata_port *ap, struct scsi_device *scsidev,
543 unsigned int cmd, void __user *arg)
551 spin_lock_irqsave(ap->lock, flags);
553 spin_unlock_irqrestore(ap->lock, flags);
555 if (in_compat_syscall())
556 return put_user(val, (compat_ulong_t __user *)arg);
558 return put_user(val, (unsigned long __user *)arg);
561 val = (unsigned long) arg;
563 spin_lock_irqsave(ap->lock, flags);
564 if (ap->pflags & ATA_PFLAG_PIO32CHANGE) {
566 ap->pflags |= ATA_PFLAG_PIO32;
568 ap->pflags &= ~ATA_PFLAG_PIO32;
570 if (val != ata_ioc32(ap))
573 spin_unlock_irqrestore(ap->lock, flags);
576 case HDIO_GET_IDENTITY:
577 return ata_get_identity(ap, scsidev, arg);
580 if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
582 return ata_cmd_ioctl(scsidev, arg);
584 case HDIO_DRIVE_TASK:
585 if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
587 return ata_task_ioctl(scsidev, arg);
596 EXPORT_SYMBOL_GPL(ata_sas_scsi_ioctl);
598 int ata_scsi_ioctl(struct scsi_device *scsidev, unsigned int cmd,
601 return ata_sas_scsi_ioctl(ata_shost_to_port(scsidev->host),
604 EXPORT_SYMBOL_GPL(ata_scsi_ioctl);
607 * ata_scsi_qc_new - acquire new ata_queued_cmd reference
608 * @dev: ATA device to which the new command is attached
609 * @cmd: SCSI command that originated this ATA command
611 * Obtain a reference to an unused ata_queued_cmd structure,
612 * which is the basic libata structure representing a single
613 * ATA command sent to the hardware.
615 * If a command was available, fill in the SCSI-specific
616 * portions of the structure with information on the
620 * spin_lock_irqsave(host lock)
623 * Command allocated, or %NULL if none available.
625 static struct ata_queued_cmd *ata_scsi_qc_new(struct ata_device *dev,
626 struct scsi_cmnd *cmd)
628 struct ata_queued_cmd *qc;
630 qc = ata_qc_new_init(dev, cmd->request->tag);
633 qc->scsidone = cmd->scsi_done;
635 qc->sg = scsi_sglist(cmd);
636 qc->n_elem = scsi_sg_count(cmd);
638 if (cmd->request->rq_flags & RQF_QUIET)
639 qc->flags |= ATA_QCFLAG_QUIET;
641 cmd->result = (DID_OK << 16) | (QUEUE_FULL << 1);
648 static void ata_qc_set_pc_nbytes(struct ata_queued_cmd *qc)
650 struct scsi_cmnd *scmd = qc->scsicmd;
652 qc->extrabytes = scmd->request->extra_len;
653 qc->nbytes = scsi_bufflen(scmd) + qc->extrabytes;
657 * ata_dump_status - user friendly display of error info
658 * @id: id of the port in question
659 * @tf: ptr to filled out taskfile
661 * Decode and dump the ATA error/status registers for the user so
662 * that they have some idea what really happened at the non
663 * make-believe layer.
666 * inherited from caller
668 static void ata_dump_status(unsigned id, struct ata_taskfile *tf)
670 u8 stat = tf->command, err = tf->feature;
672 pr_warn("ata%u: status=0x%02x { ", id, stat);
673 if (stat & ATA_BUSY) {
674 pr_cont("Busy }\n"); /* Data is not valid in this case */
676 if (stat & ATA_DRDY) pr_cont("DriveReady ");
677 if (stat & ATA_DF) pr_cont("DeviceFault ");
678 if (stat & ATA_DSC) pr_cont("SeekComplete ");
679 if (stat & ATA_DRQ) pr_cont("DataRequest ");
680 if (stat & ATA_CORR) pr_cont("CorrectedError ");
681 if (stat & ATA_SENSE) pr_cont("Sense ");
682 if (stat & ATA_ERR) pr_cont("Error ");
686 pr_warn("ata%u: error=0x%02x { ", id, err);
687 if (err & ATA_ABORTED) pr_cont("DriveStatusError ");
688 if (err & ATA_ICRC) {
689 if (err & ATA_ABORTED)
691 else pr_cont("Sector ");
693 if (err & ATA_UNC) pr_cont("UncorrectableError ");
694 if (err & ATA_IDNF) pr_cont("SectorIdNotFound ");
695 if (err & ATA_TRK0NF) pr_cont("TrackZeroNotFound ");
696 if (err & ATA_AMNF) pr_cont("AddrMarkNotFound ");
703 * ata_to_sense_error - convert ATA error to SCSI error
704 * @id: ATA device number
705 * @drv_stat: value contained in ATA status register
706 * @drv_err: value contained in ATA error register
707 * @sk: the sense key we'll fill out
708 * @asc: the additional sense code we'll fill out
709 * @ascq: the additional sense code qualifier we'll fill out
710 * @verbose: be verbose
712 * Converts an ATA error into a SCSI error. Fill out pointers to
713 * SK, ASC, and ASCQ bytes for later use in fixed or descriptor
714 * format sense blocks.
717 * spin_lock_irqsave(host lock)
719 static void ata_to_sense_error(unsigned id, u8 drv_stat, u8 drv_err, u8 *sk,
720 u8 *asc, u8 *ascq, int verbose)
724 /* Based on the 3ware driver translation table */
725 static const unsigned char sense_table[][4] = {
727 {0xd1, ABORTED_COMMAND, 0x00, 0x00},
728 // Device busy Aborted command
730 {0xd0, ABORTED_COMMAND, 0x00, 0x00},
731 // Device busy Aborted command
733 {0x61, HARDWARE_ERROR, 0x00, 0x00},
734 // Device fault Hardware error
735 /* ICRC|ABRT */ /* NB: ICRC & !ABRT is BBD */
736 {0x84, ABORTED_COMMAND, 0x47, 0x00},
737 // Data CRC error SCSI parity error
738 /* MC|ID|ABRT|TRK0|MARK */
739 {0x37, NOT_READY, 0x04, 0x00},
740 // Unit offline Not ready
742 {0x09, NOT_READY, 0x04, 0x00},
743 // Unrecovered disk error Not ready
744 /* Bad address mark */
745 {0x01, MEDIUM_ERROR, 0x13, 0x00},
746 // Address mark not found for data field
747 /* TRK0 - Track 0 not found */
748 {0x02, HARDWARE_ERROR, 0x00, 0x00},
750 /* Abort: 0x04 is not translated here, see below */
751 /* Media change request */
752 {0x08, NOT_READY, 0x04, 0x00},
753 // FIXME: faking offline
754 /* SRV/IDNF - ID not found */
755 {0x10, ILLEGAL_REQUEST, 0x21, 0x00},
756 // Logical address out of range
757 /* MC - Media Changed */
758 {0x20, UNIT_ATTENTION, 0x28, 0x00},
759 // Not ready to ready change, medium may have changed
760 /* ECC - Uncorrectable ECC error */
761 {0x40, MEDIUM_ERROR, 0x11, 0x04},
762 // Unrecovered read error
763 /* BBD - block marked bad */
764 {0x80, MEDIUM_ERROR, 0x11, 0x04},
765 // Block marked bad Medium error, unrecovered read error
766 {0xFF, 0xFF, 0xFF, 0xFF}, // END mark
768 static const unsigned char stat_table[][4] = {
769 /* Must be first because BUSY means no other bits valid */
770 {0x80, ABORTED_COMMAND, 0x47, 0x00},
771 // Busy, fake parity for now
772 {0x40, ILLEGAL_REQUEST, 0x21, 0x04},
773 // Device ready, unaligned write command
774 {0x20, HARDWARE_ERROR, 0x44, 0x00},
775 // Device fault, internal target failure
776 {0x08, ABORTED_COMMAND, 0x47, 0x00},
777 // Timed out in xfer, fake parity for now
778 {0x04, RECOVERED_ERROR, 0x11, 0x00},
779 // Recovered ECC error Medium error, recovered
780 {0xFF, 0xFF, 0xFF, 0xFF}, // END mark
784 * Is this an error we can process/parse
786 if (drv_stat & ATA_BUSY) {
787 drv_err = 0; /* Ignore the err bits, they're invalid */
791 /* Look for drv_err */
792 for (i = 0; sense_table[i][0] != 0xFF; i++) {
793 /* Look for best matches first */
794 if ((sense_table[i][0] & drv_err) ==
796 *sk = sense_table[i][1];
797 *asc = sense_table[i][2];
798 *ascq = sense_table[i][3];
805 * Fall back to interpreting status bits. Note that if the drv_err
806 * has only the ABRT bit set, we decode drv_stat. ABRT by itself
807 * is not descriptive enough.
809 for (i = 0; stat_table[i][0] != 0xFF; i++) {
810 if (stat_table[i][0] & drv_stat) {
811 *sk = stat_table[i][1];
812 *asc = stat_table[i][2];
813 *ascq = stat_table[i][3];
819 * We need a sensible error return here, which is tricky, and one
820 * that won't cause people to do things like return a disk wrongly.
822 *sk = ABORTED_COMMAND;
828 pr_err("ata%u: translated ATA stat/err 0x%02x/%02x to SCSI SK/ASC/ASCQ 0x%x/%02x/%02x\n",
829 id, drv_stat, drv_err, *sk, *asc, *ascq);
834 * ata_gen_passthru_sense - Generate check condition sense block.
835 * @qc: Command that completed.
837 * This function is specific to the ATA descriptor format sense
838 * block specified for the ATA pass through commands. Regardless
839 * of whether the command errored or not, return a sense
840 * block. Copy all controller registers into the sense
841 * block. If there was no error, we get the request from an ATA
842 * passthrough command, so we use the following sense data:
843 * sk = RECOVERED ERROR
844 * asc,ascq = ATA PASS-THROUGH INFORMATION AVAILABLE
850 static void ata_gen_passthru_sense(struct ata_queued_cmd *qc)
852 struct scsi_cmnd *cmd = qc->scsicmd;
853 struct ata_taskfile *tf = &qc->result_tf;
854 unsigned char *sb = cmd->sense_buffer;
855 unsigned char *desc = sb + 8;
856 int verbose = qc->ap->ops->error_handler == NULL;
857 u8 sense_key, asc, ascq;
859 memset(sb, 0, SCSI_SENSE_BUFFERSIZE);
861 cmd->result = (DRIVER_SENSE << 24) | SAM_STAT_CHECK_CONDITION;
864 * Use ata_to_sense_error() to map status register bits
865 * onto sense key, asc & ascq.
868 tf->command & (ATA_BUSY | ATA_DF | ATA_ERR | ATA_DRQ)) {
869 ata_to_sense_error(qc->ap->print_id, tf->command, tf->feature,
870 &sense_key, &asc, &ascq, verbose);
871 ata_scsi_set_sense(qc->dev, cmd, sense_key, asc, ascq);
874 * ATA PASS-THROUGH INFORMATION AVAILABLE
875 * Always in descriptor format sense.
877 scsi_build_sense_buffer(1, cmd->sense_buffer,
878 RECOVERED_ERROR, 0, 0x1D);
881 if ((cmd->sense_buffer[0] & 0x7f) >= 0x72) {
884 /* descriptor format */
886 desc = (char *)scsi_sense_desc_find(sb, len + 8, 9);
888 if (SCSI_SENSE_BUFFERSIZE < len + 14)
896 * Copy registers into sense buffer.
899 desc[3] = tf->feature; /* == error reg */
904 desc[12] = tf->device;
905 desc[13] = tf->command; /* == status reg */
908 * Fill in Extend bit, and the high order bytes
911 if (tf->flags & ATA_TFLAG_LBA48) {
913 desc[4] = tf->hob_nsect;
914 desc[6] = tf->hob_lbal;
915 desc[8] = tf->hob_lbam;
916 desc[10] = tf->hob_lbah;
919 /* Fixed sense format */
920 desc[0] = tf->feature;
921 desc[1] = tf->command; /* status */
922 desc[2] = tf->device;
925 if (tf->flags & ATA_TFLAG_LBA48) {
929 if (tf->hob_lbal || tf->hob_lbam || tf->hob_lbah)
939 * ata_gen_ata_sense - generate a SCSI fixed sense block
940 * @qc: Command that we are erroring out
942 * Generate sense block for a failed ATA command @qc. Descriptor
943 * format is used to accommodate LBA48 block address.
948 static void ata_gen_ata_sense(struct ata_queued_cmd *qc)
950 struct ata_device *dev = qc->dev;
951 struct scsi_cmnd *cmd = qc->scsicmd;
952 struct ata_taskfile *tf = &qc->result_tf;
953 unsigned char *sb = cmd->sense_buffer;
954 int verbose = qc->ap->ops->error_handler == NULL;
956 u8 sense_key, asc, ascq;
958 memset(sb, 0, SCSI_SENSE_BUFFERSIZE);
960 cmd->result = (DRIVER_SENSE << 24) | SAM_STAT_CHECK_CONDITION;
962 if (ata_dev_disabled(dev)) {
963 /* Device disabled after error recovery */
964 /* LOGICAL UNIT NOT READY, HARD RESET REQUIRED */
965 ata_scsi_set_sense(dev, cmd, NOT_READY, 0x04, 0x21);
968 /* Use ata_to_sense_error() to map status register bits
969 * onto sense key, asc & ascq.
972 tf->command & (ATA_BUSY | ATA_DF | ATA_ERR | ATA_DRQ)) {
973 ata_to_sense_error(qc->ap->print_id, tf->command, tf->feature,
974 &sense_key, &asc, &ascq, verbose);
975 ata_scsi_set_sense(dev, cmd, sense_key, asc, ascq);
977 /* Could not decode error */
978 ata_dev_warn(dev, "could not decode error status 0x%x err_mask 0x%x\n",
979 tf->command, qc->err_mask);
980 ata_scsi_set_sense(dev, cmd, ABORTED_COMMAND, 0, 0);
984 block = ata_tf_read_block(&qc->result_tf, dev);
985 if (block == U64_MAX)
988 scsi_set_sense_information(sb, SCSI_SENSE_BUFFERSIZE, block);
991 void ata_scsi_sdev_config(struct scsi_device *sdev)
993 sdev->use_10_for_rw = 1;
994 sdev->use_10_for_ms = 1;
995 sdev->no_write_same = 1;
997 /* Schedule policy is determined by ->qc_defer() callback and
998 * it needs to see every deferred qc. Set dev_blocked to 1 to
999 * prevent SCSI midlayer from automatically deferring
1002 sdev->max_device_blocked = 1;
1006 * atapi_drain_needed - Check whether data transfer may overflow
1007 * @rq: request to be checked
1009 * ATAPI commands which transfer variable length data to host
1010 * might overflow due to application error or hardware bug. This
1011 * function checks whether overflow should be drained and ignored
1018 * 1 if ; otherwise, 0.
1020 static int atapi_drain_needed(struct request *rq)
1022 if (likely(!blk_rq_is_passthrough(rq)))
1025 if (!blk_rq_bytes(rq) || op_is_write(req_op(rq)))
1028 return atapi_cmd_type(scsi_req(rq)->cmd[0]) == ATAPI_MISC;
1031 int ata_scsi_dev_config(struct scsi_device *sdev, struct ata_device *dev)
1033 struct request_queue *q = sdev->request_queue;
1035 if (!ata_id_has_unload(dev->id))
1036 dev->flags |= ATA_DFLAG_NO_UNLOAD;
1038 /* configure max sectors */
1039 blk_queue_max_hw_sectors(q, dev->max_sectors);
1041 if (dev->class == ATA_DEV_ATAPI) {
1044 sdev->sector_size = ATA_SECT_SIZE;
1046 /* set DMA padding */
1047 blk_queue_update_dma_pad(q, ATA_DMA_PAD_SZ - 1);
1049 /* configure draining */
1050 buf = kmalloc(ATAPI_MAX_DRAIN, q->bounce_gfp | GFP_KERNEL);
1052 ata_dev_err(dev, "drain buffer allocation failed\n");
1056 blk_queue_dma_drain(q, atapi_drain_needed, buf, ATAPI_MAX_DRAIN);
1058 sdev->sector_size = ata_id_logical_sector_size(dev->id);
1059 sdev->manage_start_stop = 1;
1063 * ata_pio_sectors() expects buffer for each sector to not cross
1064 * page boundary. Enforce it by requiring buffers to be sector
1065 * aligned, which works iff sector_size is not larger than
1066 * PAGE_SIZE. ATAPI devices also need the alignment as
1067 * IDENTIFY_PACKET is executed as ATA_PROT_PIO.
1069 if (sdev->sector_size > PAGE_SIZE)
1071 "sector_size=%u > PAGE_SIZE, PIO may malfunction\n",
1074 blk_queue_update_dma_alignment(q, sdev->sector_size - 1);
1076 if (dev->flags & ATA_DFLAG_AN)
1077 set_bit(SDEV_EVT_MEDIA_CHANGE, sdev->supported_events);
1079 if (dev->flags & ATA_DFLAG_NCQ) {
1082 depth = min(sdev->host->can_queue, ata_id_queue_depth(dev->id));
1083 depth = min(ATA_MAX_QUEUE, depth);
1084 scsi_change_queue_depth(sdev, depth);
1087 if (dev->flags & ATA_DFLAG_TRUSTED)
1088 sdev->security_supported = 1;
1095 * ata_scsi_slave_config - Set SCSI device attributes
1096 * @sdev: SCSI device to examine
1098 * This is called before we actually start reading
1099 * and writing to the device, to configure certain
1100 * SCSI mid-layer behaviors.
1103 * Defined by SCSI layer. We don't really care.
1106 int ata_scsi_slave_config(struct scsi_device *sdev)
1108 struct ata_port *ap = ata_shost_to_port(sdev->host);
1109 struct ata_device *dev = __ata_scsi_find_dev(ap, sdev);
1112 ata_scsi_sdev_config(sdev);
1115 rc = ata_scsi_dev_config(sdev, dev);
1119 EXPORT_SYMBOL_GPL(ata_scsi_slave_config);
1122 * ata_scsi_slave_destroy - SCSI device is about to be destroyed
1123 * @sdev: SCSI device to be destroyed
1125 * @sdev is about to be destroyed for hot/warm unplugging. If
1126 * this unplugging was initiated by libata as indicated by NULL
1127 * dev->sdev, this function doesn't have to do anything.
1128 * Otherwise, SCSI layer initiated warm-unplug is in progress.
1129 * Clear dev->sdev, schedule the device for ATA detach and invoke
1133 * Defined by SCSI layer. We don't really care.
1135 void ata_scsi_slave_destroy(struct scsi_device *sdev)
1137 struct ata_port *ap = ata_shost_to_port(sdev->host);
1138 struct request_queue *q = sdev->request_queue;
1139 unsigned long flags;
1140 struct ata_device *dev;
1142 if (!ap->ops->error_handler)
1145 spin_lock_irqsave(ap->lock, flags);
1146 dev = __ata_scsi_find_dev(ap, sdev);
1147 if (dev && dev->sdev) {
1148 /* SCSI device already in CANCEL state, no need to offline it */
1150 dev->flags |= ATA_DFLAG_DETACH;
1151 ata_port_schedule_eh(ap);
1153 spin_unlock_irqrestore(ap->lock, flags);
1155 kfree(q->dma_drain_buffer);
1156 q->dma_drain_buffer = NULL;
1157 q->dma_drain_size = 0;
1159 EXPORT_SYMBOL_GPL(ata_scsi_slave_destroy);
1162 * ata_scsi_start_stop_xlat - Translate SCSI START STOP UNIT command
1163 * @qc: Storage for translated ATA taskfile
1165 * Sets up an ATA taskfile to issue STANDBY (to stop) or READ VERIFY
1166 * (to start). Perhaps these commands should be preceded by
1167 * CHECK POWER MODE to see what power mode the device is already in.
1168 * [See SAT revision 5 at www.t10.org]
1171 * spin_lock_irqsave(host lock)
1174 * Zero on success, non-zero on error.
1176 static unsigned int ata_scsi_start_stop_xlat(struct ata_queued_cmd *qc)
1178 struct scsi_cmnd *scmd = qc->scsicmd;
1179 struct ata_taskfile *tf = &qc->tf;
1180 const u8 *cdb = scmd->cmnd;
1184 if (scmd->cmd_len < 5) {
1189 tf->flags |= ATA_TFLAG_DEVICE | ATA_TFLAG_ISADDR;
1190 tf->protocol = ATA_PROT_NODATA;
1192 ; /* ignore IMMED bit, violates sat-r05 */
1197 goto invalid_fld; /* LOEJ bit set not supported */
1199 if (((cdb[4] >> 4) & 0xf) != 0) {
1202 goto invalid_fld; /* power conditions not supported */
1206 tf->nsect = 1; /* 1 sector, lba=0 */
1208 if (qc->dev->flags & ATA_DFLAG_LBA) {
1209 tf->flags |= ATA_TFLAG_LBA;
1214 tf->device |= ATA_LBA;
1217 tf->lbal = 0x1; /* sect */
1218 tf->lbam = 0x0; /* cyl low */
1219 tf->lbah = 0x0; /* cyl high */
1222 tf->command = ATA_CMD_VERIFY; /* READ VERIFY */
1224 /* Some odd clown BIOSen issue spindown on power off (ACPI S4
1225 * or S5) causing some drives to spin up and down again.
1227 if ((qc->ap->flags & ATA_FLAG_NO_POWEROFF_SPINDOWN) &&
1228 system_state == SYSTEM_POWER_OFF)
1231 if ((qc->ap->flags & ATA_FLAG_NO_HIBERNATE_SPINDOWN) &&
1232 system_entering_hibernation())
1235 /* Issue ATA STANDBY IMMEDIATE command */
1236 tf->command = ATA_CMD_STANDBYNOW1;
1240 * Standby and Idle condition timers could be implemented but that
1241 * would require libata to implement the Power condition mode page
1242 * and allow the user to change it. Changing mode pages requires
1243 * MODE SELECT to be implemented.
1249 ata_scsi_set_invalid_field(qc->dev, scmd, fp, bp);
1252 scmd->result = SAM_STAT_GOOD;
1258 * ata_scsi_flush_xlat - Translate SCSI SYNCHRONIZE CACHE command
1259 * @qc: Storage for translated ATA taskfile
1261 * Sets up an ATA taskfile to issue FLUSH CACHE or
1265 * spin_lock_irqsave(host lock)
1268 * Zero on success, non-zero on error.
1270 static unsigned int ata_scsi_flush_xlat(struct ata_queued_cmd *qc)
1272 struct ata_taskfile *tf = &qc->tf;
1274 tf->flags |= ATA_TFLAG_DEVICE;
1275 tf->protocol = ATA_PROT_NODATA;
1277 if (qc->dev->flags & ATA_DFLAG_FLUSH_EXT)
1278 tf->command = ATA_CMD_FLUSH_EXT;
1280 tf->command = ATA_CMD_FLUSH;
1282 /* flush is critical for IO integrity, consider it an IO command */
1283 qc->flags |= ATA_QCFLAG_IO;
1289 * scsi_6_lba_len - Get LBA and transfer length
1290 * @cdb: SCSI command to translate
1292 * Calculate LBA and transfer length for 6-byte commands.
1296 * @plen: the transfer length
1298 static void scsi_6_lba_len(const u8 *cdb, u64 *plba, u32 *plen)
1303 VPRINTK("six-byte command\n");
1305 lba |= ((u64)(cdb[1] & 0x1f)) << 16;
1306 lba |= ((u64)cdb[2]) << 8;
1307 lba |= ((u64)cdb[3]);
1316 * scsi_10_lba_len - Get LBA and transfer length
1317 * @cdb: SCSI command to translate
1319 * Calculate LBA and transfer length for 10-byte commands.
1323 * @plen: the transfer length
1325 static void scsi_10_lba_len(const u8 *cdb, u64 *plba, u32 *plen)
1330 VPRINTK("ten-byte command\n");
1332 lba |= ((u64)cdb[2]) << 24;
1333 lba |= ((u64)cdb[3]) << 16;
1334 lba |= ((u64)cdb[4]) << 8;
1335 lba |= ((u64)cdb[5]);
1337 len |= ((u32)cdb[7]) << 8;
1338 len |= ((u32)cdb[8]);
1345 * scsi_16_lba_len - Get LBA and transfer length
1346 * @cdb: SCSI command to translate
1348 * Calculate LBA and transfer length for 16-byte commands.
1352 * @plen: the transfer length
1354 static void scsi_16_lba_len(const u8 *cdb, u64 *plba, u32 *plen)
1359 VPRINTK("sixteen-byte command\n");
1361 lba |= ((u64)cdb[2]) << 56;
1362 lba |= ((u64)cdb[3]) << 48;
1363 lba |= ((u64)cdb[4]) << 40;
1364 lba |= ((u64)cdb[5]) << 32;
1365 lba |= ((u64)cdb[6]) << 24;
1366 lba |= ((u64)cdb[7]) << 16;
1367 lba |= ((u64)cdb[8]) << 8;
1368 lba |= ((u64)cdb[9]);
1370 len |= ((u32)cdb[10]) << 24;
1371 len |= ((u32)cdb[11]) << 16;
1372 len |= ((u32)cdb[12]) << 8;
1373 len |= ((u32)cdb[13]);
1380 * ata_scsi_verify_xlat - Translate SCSI VERIFY command into an ATA one
1381 * @qc: Storage for translated ATA taskfile
1383 * Converts SCSI VERIFY command to an ATA READ VERIFY command.
1386 * spin_lock_irqsave(host lock)
1389 * Zero on success, non-zero on error.
1391 static unsigned int ata_scsi_verify_xlat(struct ata_queued_cmd *qc)
1393 struct scsi_cmnd *scmd = qc->scsicmd;
1394 struct ata_taskfile *tf = &qc->tf;
1395 struct ata_device *dev = qc->dev;
1396 u64 dev_sectors = qc->dev->n_sectors;
1397 const u8 *cdb = scmd->cmnd;
1402 tf->flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
1403 tf->protocol = ATA_PROT_NODATA;
1405 if (cdb[0] == VERIFY) {
1406 if (scmd->cmd_len < 10) {
1410 scsi_10_lba_len(cdb, &block, &n_block);
1411 } else if (cdb[0] == VERIFY_16) {
1412 if (scmd->cmd_len < 16) {
1416 scsi_16_lba_len(cdb, &block, &n_block);
1424 if (block >= dev_sectors)
1426 if ((block + n_block) > dev_sectors)
1429 if (dev->flags & ATA_DFLAG_LBA) {
1430 tf->flags |= ATA_TFLAG_LBA;
1432 if (lba_28_ok(block, n_block)) {
1434 tf->command = ATA_CMD_VERIFY;
1435 tf->device |= (block >> 24) & 0xf;
1436 } else if (lba_48_ok(block, n_block)) {
1437 if (!(dev->flags & ATA_DFLAG_LBA48))
1441 tf->flags |= ATA_TFLAG_LBA48;
1442 tf->command = ATA_CMD_VERIFY_EXT;
1444 tf->hob_nsect = (n_block >> 8) & 0xff;
1446 tf->hob_lbah = (block >> 40) & 0xff;
1447 tf->hob_lbam = (block >> 32) & 0xff;
1448 tf->hob_lbal = (block >> 24) & 0xff;
1450 /* request too large even for LBA48 */
1453 tf->nsect = n_block & 0xff;
1455 tf->lbah = (block >> 16) & 0xff;
1456 tf->lbam = (block >> 8) & 0xff;
1457 tf->lbal = block & 0xff;
1459 tf->device |= ATA_LBA;
1462 u32 sect, head, cyl, track;
1464 if (!lba_28_ok(block, n_block))
1467 /* Convert LBA to CHS */
1468 track = (u32)block / dev->sectors;
1469 cyl = track / dev->heads;
1470 head = track % dev->heads;
1471 sect = (u32)block % dev->sectors + 1;
1473 DPRINTK("block %u track %u cyl %u head %u sect %u\n",
1474 (u32)block, track, cyl, head, sect);
1476 /* Check whether the converted CHS can fit.
1480 if ((cyl >> 16) || (head >> 4) || (sect >> 8) || (!sect))
1483 tf->command = ATA_CMD_VERIFY;
1484 tf->nsect = n_block & 0xff; /* Sector count 0 means 256 sectors */
1487 tf->lbah = cyl >> 8;
1494 ata_scsi_set_invalid_field(qc->dev, scmd, fp, 0xff);
1498 ata_scsi_set_sense(qc->dev, scmd, ILLEGAL_REQUEST, 0x21, 0x0);
1499 /* "Logical Block Address out of range" */
1503 scmd->result = SAM_STAT_GOOD;
1507 static bool ata_check_nblocks(struct scsi_cmnd *scmd, u32 n_blocks)
1509 struct request *rq = scmd->request;
1512 if (!blk_rq_is_passthrough(rq))
1515 req_blocks = blk_rq_bytes(rq) / scmd->device->sector_size;
1516 if (n_blocks > req_blocks)
1523 * ata_scsi_rw_xlat - Translate SCSI r/w command into an ATA one
1524 * @qc: Storage for translated ATA taskfile
1526 * Converts any of six SCSI read/write commands into the
1527 * ATA counterpart, including starting sector (LBA),
1528 * sector count, and taking into account the device's LBA48
1531 * Commands %READ_6, %READ_10, %READ_16, %WRITE_6, %WRITE_10, and
1532 * %WRITE_16 are currently supported.
1535 * spin_lock_irqsave(host lock)
1538 * Zero on success, non-zero on error.
1540 static unsigned int ata_scsi_rw_xlat(struct ata_queued_cmd *qc)
1542 struct scsi_cmnd *scmd = qc->scsicmd;
1543 const u8 *cdb = scmd->cmnd;
1544 struct request *rq = scmd->request;
1545 int class = IOPRIO_PRIO_CLASS(req_get_ioprio(rq));
1546 unsigned int tf_flags = 0;
1552 if (cdb[0] == WRITE_10 || cdb[0] == WRITE_6 || cdb[0] == WRITE_16)
1553 tf_flags |= ATA_TFLAG_WRITE;
1555 /* Calculate the SCSI LBA, transfer length and FUA. */
1559 if (unlikely(scmd->cmd_len < 10)) {
1563 scsi_10_lba_len(cdb, &block, &n_block);
1564 if (cdb[1] & (1 << 3))
1565 tf_flags |= ATA_TFLAG_FUA;
1566 if (!ata_check_nblocks(scmd, n_block))
1571 if (unlikely(scmd->cmd_len < 6)) {
1575 scsi_6_lba_len(cdb, &block, &n_block);
1577 /* for 6-byte r/w commands, transfer length 0
1578 * means 256 blocks of data, not 0 block.
1582 if (!ata_check_nblocks(scmd, n_block))
1587 if (unlikely(scmd->cmd_len < 16)) {
1591 scsi_16_lba_len(cdb, &block, &n_block);
1592 if (cdb[1] & (1 << 3))
1593 tf_flags |= ATA_TFLAG_FUA;
1594 if (!ata_check_nblocks(scmd, n_block))
1598 DPRINTK("no-byte command\n");
1603 /* Check and compose ATA command */
1605 /* For 10-byte and 16-byte SCSI R/W commands, transfer
1606 * length 0 means transfer 0 block of data.
1607 * However, for ATA R/W commands, sector count 0 means
1608 * 256 or 65536 sectors, not 0 sectors as in SCSI.
1610 * WARNING: one or two older ATA drives treat 0 as 0...
1614 qc->flags |= ATA_QCFLAG_IO;
1615 qc->nbytes = n_block * scmd->device->sector_size;
1617 rc = ata_build_rw_tf(&qc->tf, qc->dev, block, n_block, tf_flags,
1620 if (likely(rc == 0))
1625 /* treat all other errors as -EINVAL, fall through */
1627 ata_scsi_set_invalid_field(qc->dev, scmd, fp, 0xff);
1631 ata_scsi_set_sense(qc->dev, scmd, ILLEGAL_REQUEST, 0x21, 0x0);
1632 /* "Logical Block Address out of range" */
1636 scmd->result = SAM_STAT_GOOD;
1640 static void ata_qc_done(struct ata_queued_cmd *qc)
1642 struct scsi_cmnd *cmd = qc->scsicmd;
1643 void (*done)(struct scsi_cmnd *) = qc->scsidone;
1649 static void ata_scsi_qc_complete(struct ata_queued_cmd *qc)
1651 struct ata_port *ap = qc->ap;
1652 struct scsi_cmnd *cmd = qc->scsicmd;
1653 u8 *cdb = cmd->cmnd;
1654 int need_sense = (qc->err_mask != 0);
1656 /* For ATA pass thru (SAT) commands, generate a sense block if
1657 * user mandated it or if there's an error. Note that if we
1658 * generate because the user forced us to [CK_COND =1], a check
1659 * condition is generated and the ATA register values are returned
1660 * whether the command completed successfully or not. If there
1661 * was no error, we use the following sense data:
1662 * sk = RECOVERED ERROR
1663 * asc,ascq = ATA PASS-THROUGH INFORMATION AVAILABLE
1665 if (((cdb[0] == ATA_16) || (cdb[0] == ATA_12)) &&
1666 ((cdb[2] & 0x20) || need_sense))
1667 ata_gen_passthru_sense(qc);
1668 else if (qc->flags & ATA_QCFLAG_SENSE_VALID)
1669 cmd->result = SAM_STAT_CHECK_CONDITION;
1670 else if (need_sense)
1671 ata_gen_ata_sense(qc);
1673 cmd->result = SAM_STAT_GOOD;
1675 if (need_sense && !ap->ops->error_handler)
1676 ata_dump_status(ap->print_id, &qc->result_tf);
1682 * ata_scsi_translate - Translate then issue SCSI command to ATA device
1683 * @dev: ATA device to which the command is addressed
1684 * @cmd: SCSI command to execute
1685 * @xlat_func: Actor which translates @cmd to an ATA taskfile
1687 * Our ->queuecommand() function has decided that the SCSI
1688 * command issued can be directly translated into an ATA
1689 * command, rather than handled internally.
1691 * This function sets up an ata_queued_cmd structure for the
1692 * SCSI command, and sends that ata_queued_cmd to the hardware.
1694 * The xlat_func argument (actor) returns 0 if ready to execute
1695 * ATA command, else 1 to finish translation. If 1 is returned
1696 * then cmd->result (and possibly cmd->sense_buffer) are assumed
1697 * to be set reflecting an error condition or clean (early)
1701 * spin_lock_irqsave(host lock)
1704 * 0 on success, SCSI_ML_QUEUE_DEVICE_BUSY if the command
1705 * needs to be deferred.
1707 static int ata_scsi_translate(struct ata_device *dev, struct scsi_cmnd *cmd,
1708 ata_xlat_func_t xlat_func)
1710 struct ata_port *ap = dev->link->ap;
1711 struct ata_queued_cmd *qc;
1716 qc = ata_scsi_qc_new(dev, cmd);
1720 /* data is present; dma-map it */
1721 if (cmd->sc_data_direction == DMA_FROM_DEVICE ||
1722 cmd->sc_data_direction == DMA_TO_DEVICE) {
1723 if (unlikely(scsi_bufflen(cmd) < 1)) {
1724 ata_dev_warn(dev, "WARNING: zero len r/w req\n");
1728 ata_sg_init(qc, scsi_sglist(cmd), scsi_sg_count(cmd));
1730 qc->dma_dir = cmd->sc_data_direction;
1733 qc->complete_fn = ata_scsi_qc_complete;
1738 if (ap->ops->qc_defer) {
1739 if ((rc = ap->ops->qc_defer(qc)))
1743 /* select device, send command to hardware */
1751 cmd->scsi_done(cmd);
1752 DPRINTK("EXIT - early finish (good or error)\n");
1757 cmd->result = (DID_ERROR << 16);
1758 cmd->scsi_done(cmd);
1760 DPRINTK("EXIT - internal\n");
1765 DPRINTK("EXIT - defer\n");
1766 if (rc == ATA_DEFER_LINK)
1767 return SCSI_MLQUEUE_DEVICE_BUSY;
1769 return SCSI_MLQUEUE_HOST_BUSY;
1772 struct ata_scsi_args {
1773 struct ata_device *dev;
1775 struct scsi_cmnd *cmd;
1779 * ata_scsi_rbuf_get - Map response buffer.
1780 * @cmd: SCSI command containing buffer to be mapped.
1781 * @flags: unsigned long variable to store irq enable status
1782 * @copy_in: copy in from user buffer
1784 * Prepare buffer for simulated SCSI commands.
1787 * spin_lock_irqsave(ata_scsi_rbuf_lock) on success
1790 * Pointer to response buffer.
1792 static void *ata_scsi_rbuf_get(struct scsi_cmnd *cmd, bool copy_in,
1793 unsigned long *flags)
1795 spin_lock_irqsave(&ata_scsi_rbuf_lock, *flags);
1797 memset(ata_scsi_rbuf, 0, ATA_SCSI_RBUF_SIZE);
1799 sg_copy_to_buffer(scsi_sglist(cmd), scsi_sg_count(cmd),
1800 ata_scsi_rbuf, ATA_SCSI_RBUF_SIZE);
1801 return ata_scsi_rbuf;
1805 * ata_scsi_rbuf_put - Unmap response buffer.
1806 * @cmd: SCSI command containing buffer to be unmapped.
1807 * @copy_out: copy out result
1808 * @flags: @flags passed to ata_scsi_rbuf_get()
1810 * Returns rbuf buffer. The result is copied to @cmd's buffer if
1811 * @copy_back is true.
1814 * Unlocks ata_scsi_rbuf_lock.
1816 static inline void ata_scsi_rbuf_put(struct scsi_cmnd *cmd, bool copy_out,
1817 unsigned long *flags)
1820 sg_copy_from_buffer(scsi_sglist(cmd), scsi_sg_count(cmd),
1821 ata_scsi_rbuf, ATA_SCSI_RBUF_SIZE);
1822 spin_unlock_irqrestore(&ata_scsi_rbuf_lock, *flags);
1826 * ata_scsi_rbuf_fill - wrapper for SCSI command simulators
1827 * @args: device IDENTIFY data / SCSI command of interest.
1828 * @actor: Callback hook for desired SCSI command simulator
1830 * Takes care of the hard work of simulating a SCSI command...
1831 * Mapping the response buffer, calling the command's handler,
1832 * and handling the handler's return value. This return value
1833 * indicates whether the handler wishes the SCSI command to be
1834 * completed successfully (0), or not (in which case cmd->result
1835 * and sense buffer are assumed to be set).
1838 * spin_lock_irqsave(host lock)
1840 static void ata_scsi_rbuf_fill(struct ata_scsi_args *args,
1841 unsigned int (*actor)(struct ata_scsi_args *args, u8 *rbuf))
1845 struct scsi_cmnd *cmd = args->cmd;
1846 unsigned long flags;
1848 rbuf = ata_scsi_rbuf_get(cmd, false, &flags);
1849 rc = actor(args, rbuf);
1850 ata_scsi_rbuf_put(cmd, rc == 0, &flags);
1853 cmd->result = SAM_STAT_GOOD;
1857 * ata_scsiop_inq_std - Simulate INQUIRY command
1858 * @args: device IDENTIFY data / SCSI command of interest.
1859 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1861 * Returns standard device identification data associated
1862 * with non-VPD INQUIRY command output.
1865 * spin_lock_irqsave(host lock)
1867 static unsigned int ata_scsiop_inq_std(struct ata_scsi_args *args, u8 *rbuf)
1869 static const u8 versions[] = {
1871 0x60, /* SAM-3 (no version claimed) */
1874 0x20, /* SBC-2 (no version claimed) */
1877 0x00 /* SPC-3 (no version claimed) */
1879 static const u8 versions_zbc[] = {
1881 0xA0, /* SAM-5 (no version claimed) */
1884 0x00, /* SBC-4 (no version claimed) */
1887 0xC0, /* SPC-5 (no version claimed) */
1896 0x5, /* claim SPC-3 version compatibility */
1906 /* set scsi removable (RMB) bit per ata bit, or if the
1907 * AHCI port says it's external (Hotplug-capable, eSATA).
1909 if (ata_id_removable(args->id) ||
1910 (args->dev->link->ap->pflags & ATA_PFLAG_EXTERNAL))
1913 if (args->dev->class == ATA_DEV_ZAC) {
1915 hdr[2] = 0x7; /* claim SPC-5 version compatibility */
1918 memcpy(rbuf, hdr, sizeof(hdr));
1919 memcpy(&rbuf[8], "ATA ", 8);
1920 ata_id_string(args->id, &rbuf[16], ATA_ID_PROD, 16);
1922 /* From SAT, use last 2 words from fw rev unless they are spaces */
1923 ata_id_string(args->id, &rbuf[32], ATA_ID_FW_REV + 2, 4);
1924 if (strncmp(&rbuf[32], " ", 4) == 0)
1925 ata_id_string(args->id, &rbuf[32], ATA_ID_FW_REV, 4);
1927 if (rbuf[32] == 0 || rbuf[32] == ' ')
1928 memcpy(&rbuf[32], "n/a ", 4);
1930 if (ata_id_zoned_cap(args->id) || args->dev->class == ATA_DEV_ZAC)
1931 memcpy(rbuf + 58, versions_zbc, sizeof(versions_zbc));
1933 memcpy(rbuf + 58, versions, sizeof(versions));
1939 * ata_scsiop_inq_00 - Simulate INQUIRY VPD page 0, list of pages
1940 * @args: device IDENTIFY data / SCSI command of interest.
1941 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1943 * Returns list of inquiry VPD pages available.
1946 * spin_lock_irqsave(host lock)
1948 static unsigned int ata_scsiop_inq_00(struct ata_scsi_args *args, u8 *rbuf)
1951 static const u8 pages[] = {
1952 0x00, /* page 0x00, this page */
1953 0x80, /* page 0x80, unit serial no page */
1954 0x83, /* page 0x83, device ident page */
1955 0x89, /* page 0x89, ata info page */
1956 0xb0, /* page 0xb0, block limits page */
1957 0xb1, /* page 0xb1, block device characteristics page */
1958 0xb2, /* page 0xb2, thin provisioning page */
1959 0xb6, /* page 0xb6, zoned block device characteristics */
1962 num_pages = sizeof(pages);
1963 if (!(args->dev->flags & ATA_DFLAG_ZAC))
1965 rbuf[3] = num_pages; /* number of supported VPD pages */
1966 memcpy(rbuf + 4, pages, num_pages);
1971 * ata_scsiop_inq_80 - Simulate INQUIRY VPD page 80, device serial number
1972 * @args: device IDENTIFY data / SCSI command of interest.
1973 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1975 * Returns ATA device serial number.
1978 * spin_lock_irqsave(host lock)
1980 static unsigned int ata_scsiop_inq_80(struct ata_scsi_args *args, u8 *rbuf)
1982 static const u8 hdr[] = {
1984 0x80, /* this page code */
1986 ATA_ID_SERNO_LEN, /* page len */
1989 memcpy(rbuf, hdr, sizeof(hdr));
1990 ata_id_string(args->id, (unsigned char *) &rbuf[4],
1991 ATA_ID_SERNO, ATA_ID_SERNO_LEN);
1996 * ata_scsiop_inq_83 - Simulate INQUIRY VPD page 83, device identity
1997 * @args: device IDENTIFY data / SCSI command of interest.
1998 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2000 * Yields two logical unit device identification designators:
2001 * - vendor specific ASCII containing the ATA serial number
2002 * - SAT defined "t10 vendor id based" containing ASCII vendor
2003 * name ("ATA "), model and serial numbers.
2006 * spin_lock_irqsave(host lock)
2008 static unsigned int ata_scsiop_inq_83(struct ata_scsi_args *args, u8 *rbuf)
2010 const int sat_model_serial_desc_len = 68;
2013 rbuf[1] = 0x83; /* this page code */
2016 /* piv=0, assoc=lu, code_set=ACSII, designator=vendor */
2018 rbuf[num + 3] = ATA_ID_SERNO_LEN;
2020 ata_id_string(args->id, (unsigned char *) rbuf + num,
2021 ATA_ID_SERNO, ATA_ID_SERNO_LEN);
2022 num += ATA_ID_SERNO_LEN;
2024 /* SAT defined lu model and serial numbers descriptor */
2025 /* piv=0, assoc=lu, code_set=ACSII, designator=t10 vendor id */
2028 rbuf[num + 3] = sat_model_serial_desc_len;
2030 memcpy(rbuf + num, "ATA ", 8);
2032 ata_id_string(args->id, (unsigned char *) rbuf + num, ATA_ID_PROD,
2034 num += ATA_ID_PROD_LEN;
2035 ata_id_string(args->id, (unsigned char *) rbuf + num, ATA_ID_SERNO,
2037 num += ATA_ID_SERNO_LEN;
2039 if (ata_id_has_wwn(args->id)) {
2040 /* SAT defined lu world wide name */
2041 /* piv=0, assoc=lu, code_set=binary, designator=NAA */
2044 rbuf[num + 3] = ATA_ID_WWN_LEN;
2046 ata_id_string(args->id, (unsigned char *) rbuf + num,
2047 ATA_ID_WWN, ATA_ID_WWN_LEN);
2048 num += ATA_ID_WWN_LEN;
2050 rbuf[3] = num - 4; /* page len (assume less than 256 bytes) */
2055 * ata_scsiop_inq_89 - Simulate INQUIRY VPD page 89, ATA info
2056 * @args: device IDENTIFY data / SCSI command of interest.
2057 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2059 * Yields SAT-specified ATA VPD page.
2062 * spin_lock_irqsave(host lock)
2064 static unsigned int ata_scsiop_inq_89(struct ata_scsi_args *args, u8 *rbuf)
2066 rbuf[1] = 0x89; /* our page code */
2067 rbuf[2] = (0x238 >> 8); /* page size fixed at 238h */
2068 rbuf[3] = (0x238 & 0xff);
2070 memcpy(&rbuf[8], "linux ", 8);
2071 memcpy(&rbuf[16], "libata ", 16);
2072 memcpy(&rbuf[32], DRV_VERSION, 4);
2074 rbuf[36] = 0x34; /* force D2H Reg FIS (34h) */
2075 rbuf[37] = (1 << 7); /* bit 7 indicates Command FIS */
2078 /* we don't store the ATA device signature, so we fake it */
2079 rbuf[38] = ATA_DRDY; /* really, this is Status reg */
2083 rbuf[56] = ATA_CMD_ID_ATA;
2085 memcpy(&rbuf[60], &args->id[0], 512);
2089 static unsigned int ata_scsiop_inq_b0(struct ata_scsi_args *args, u8 *rbuf)
2094 rbuf[3] = 0x3c; /* required VPD size with unmap support */
2097 * Optimal transfer length granularity.
2099 * This is always one physical block, but for disks with a smaller
2100 * logical than physical sector size we need to figure out what the
2103 min_io_sectors = 1 << ata_id_log2_per_physical_sector(args->id);
2104 put_unaligned_be16(min_io_sectors, &rbuf[6]);
2107 * Optimal unmap granularity.
2109 * The ATA spec doesn't even know about a granularity or alignment
2110 * for the TRIM command. We can leave away most of the unmap related
2111 * VPD page entries, but we have specifify a granularity to signal
2112 * that we support some form of unmap - in thise case via WRITE SAME
2113 * with the unmap bit set.
2115 if (ata_id_has_trim(args->id)) {
2116 put_unaligned_be64(65535 * ATA_MAX_TRIM_RNUM, &rbuf[36]);
2117 put_unaligned_be32(1, &rbuf[28]);
2123 static unsigned int ata_scsiop_inq_b1(struct ata_scsi_args *args, u8 *rbuf)
2125 int form_factor = ata_id_form_factor(args->id);
2126 int media_rotation_rate = ata_id_rotation_rate(args->id);
2127 u8 zoned = ata_id_zoned_cap(args->id);
2131 rbuf[4] = media_rotation_rate >> 8;
2132 rbuf[5] = media_rotation_rate;
2133 rbuf[7] = form_factor;
2135 rbuf[8] = (zoned << 4);
2140 static unsigned int ata_scsiop_inq_b2(struct ata_scsi_args *args, u8 *rbuf)
2142 /* SCSI Thin Provisioning VPD page: SBC-3 rev 22 or later */
2145 rbuf[5] = 1 << 6; /* TPWS */
2150 static unsigned int ata_scsiop_inq_b6(struct ata_scsi_args *args, u8 *rbuf)
2153 * zbc-r05 SCSI Zoned Block device characteristics VPD page
2159 * URSWRZ bit is only meaningful for host-managed ZAC drives
2161 if (args->dev->zac_zoned_cap & 1)
2163 put_unaligned_be32(args->dev->zac_zones_optimal_open, &rbuf[8]);
2164 put_unaligned_be32(args->dev->zac_zones_optimal_nonseq, &rbuf[12]);
2165 put_unaligned_be32(args->dev->zac_zones_max_open, &rbuf[16]);
2171 * modecpy - Prepare response for MODE SENSE
2172 * @dest: output buffer
2173 * @src: data being copied
2174 * @n: length of mode page
2175 * @changeable: whether changeable parameters are requested
2177 * Generate a generic MODE SENSE page for either current or changeable
2183 static void modecpy(u8 *dest, const u8 *src, int n, bool changeable)
2186 memcpy(dest, src, 2);
2187 memset(dest + 2, 0, n - 2);
2189 memcpy(dest, src, n);
2194 * ata_msense_caching - Simulate MODE SENSE caching info page
2195 * @id: device IDENTIFY data
2196 * @buf: output buffer
2197 * @changeable: whether changeable parameters are requested
2199 * Generate a caching info page, which conditionally indicates
2200 * write caching to the SCSI layer, depending on device
2206 static unsigned int ata_msense_caching(u16 *id, u8 *buf, bool changeable)
2208 modecpy(buf, def_cache_mpage, sizeof(def_cache_mpage), changeable);
2210 buf[2] |= (1 << 2); /* ata_mselect_caching() */
2212 buf[2] |= (ata_id_wcache_enabled(id) << 2); /* write cache enable */
2213 buf[12] |= (!ata_id_rahead_enabled(id) << 5); /* disable read ahead */
2215 return sizeof(def_cache_mpage);
2219 * ata_msense_control - Simulate MODE SENSE control mode page
2220 * @dev: ATA device of interest
2221 * @buf: output buffer
2222 * @changeable: whether changeable parameters are requested
2224 * Generate a generic MODE SENSE control mode page.
2229 static unsigned int ata_msense_control(struct ata_device *dev, u8 *buf,
2232 modecpy(buf, def_control_mpage, sizeof(def_control_mpage), changeable);
2234 buf[2] |= (1 << 2); /* ata_mselect_control() */
2236 bool d_sense = (dev->flags & ATA_DFLAG_D_SENSE);
2238 buf[2] |= (d_sense << 2); /* descriptor format sense data */
2240 return sizeof(def_control_mpage);
2244 * ata_msense_rw_recovery - Simulate MODE SENSE r/w error recovery page
2245 * @buf: output buffer
2246 * @changeable: whether changeable parameters are requested
2248 * Generate a generic MODE SENSE r/w error recovery page.
2253 static unsigned int ata_msense_rw_recovery(u8 *buf, bool changeable)
2255 modecpy(buf, def_rw_recovery_mpage, sizeof(def_rw_recovery_mpage),
2257 return sizeof(def_rw_recovery_mpage);
2261 * We can turn this into a real blacklist if it's needed, for now just
2262 * blacklist any Maxtor BANC1G10 revision firmware
2264 static int ata_dev_supports_fua(u16 *id)
2266 unsigned char model[ATA_ID_PROD_LEN + 1], fw[ATA_ID_FW_REV_LEN + 1];
2270 if (!ata_id_has_fua(id))
2273 ata_id_c_string(id, model, ATA_ID_PROD, sizeof(model));
2274 ata_id_c_string(id, fw, ATA_ID_FW_REV, sizeof(fw));
2276 if (strcmp(model, "Maxtor"))
2278 if (strcmp(fw, "BANC1G10"))
2281 return 0; /* blacklisted */
2285 * ata_scsiop_mode_sense - Simulate MODE SENSE 6, 10 commands
2286 * @args: device IDENTIFY data / SCSI command of interest.
2287 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2289 * Simulate MODE SENSE commands. Assume this is invoked for direct
2290 * access devices (e.g. disks) only. There should be no block
2291 * descriptor for other device types.
2294 * spin_lock_irqsave(host lock)
2296 static unsigned int ata_scsiop_mode_sense(struct ata_scsi_args *args, u8 *rbuf)
2298 struct ata_device *dev = args->dev;
2299 u8 *scsicmd = args->cmd->cmnd, *p = rbuf;
2300 static const u8 sat_blk_desc[] = {
2301 0, 0, 0, 0, /* number of blocks: sat unspecified */
2303 0, 0x2, 0x0 /* block length: 512 bytes */
2306 unsigned int ebd, page_control, six_byte;
2307 u8 dpofua, bp = 0xff;
2312 six_byte = (scsicmd[0] == MODE_SENSE);
2313 ebd = !(scsicmd[1] & 0x8); /* dbd bit inverted == edb */
2315 * LLBA bit in msense(10) ignored (compliant)
2318 page_control = scsicmd[2] >> 6;
2319 switch (page_control) {
2320 case 0: /* current */
2321 case 1: /* changeable */
2322 case 2: /* defaults */
2323 break; /* supported */
2325 goto saving_not_supp;
2333 p += 4 + (ebd ? 8 : 0);
2335 p += 8 + (ebd ? 8 : 0);
2337 pg = scsicmd[2] & 0x3f;
2340 * No mode subpages supported (yet) but asking for _all_
2341 * subpages may be valid
2343 if (spg && (spg != ALL_SUB_MPAGES)) {
2349 case RW_RECOVERY_MPAGE:
2350 p += ata_msense_rw_recovery(p, page_control == 1);
2354 p += ata_msense_caching(args->id, p, page_control == 1);
2358 p += ata_msense_control(args->dev, p, page_control == 1);
2362 p += ata_msense_rw_recovery(p, page_control == 1);
2363 p += ata_msense_caching(args->id, p, page_control == 1);
2364 p += ata_msense_control(args->dev, p, page_control == 1);
2367 default: /* invalid page code */
2373 if (ata_dev_supports_fua(args->id) && (dev->flags & ATA_DFLAG_LBA48) &&
2374 (!(dev->flags & ATA_DFLAG_PIO) || dev->multi_count))
2378 rbuf[0] = p - rbuf - 1;
2381 rbuf[3] = sizeof(sat_blk_desc);
2382 memcpy(rbuf + 4, sat_blk_desc, sizeof(sat_blk_desc));
2385 unsigned int output_len = p - rbuf - 2;
2387 rbuf[0] = output_len >> 8;
2388 rbuf[1] = output_len;
2391 rbuf[7] = sizeof(sat_blk_desc);
2392 memcpy(rbuf + 8, sat_blk_desc, sizeof(sat_blk_desc));
2398 ata_scsi_set_invalid_field(dev, args->cmd, fp, bp);
2402 ata_scsi_set_sense(dev, args->cmd, ILLEGAL_REQUEST, 0x39, 0x0);
2403 /* "Saving parameters not supported" */
2408 * ata_scsiop_read_cap - Simulate READ CAPACITY[ 16] commands
2409 * @args: device IDENTIFY data / SCSI command of interest.
2410 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2412 * Simulate READ CAPACITY commands.
2417 static unsigned int ata_scsiop_read_cap(struct ata_scsi_args *args, u8 *rbuf)
2419 struct ata_device *dev = args->dev;
2420 u64 last_lba = dev->n_sectors - 1; /* LBA of the last block */
2421 u32 sector_size; /* physical sector size in bytes */
2425 sector_size = ata_id_logical_sector_size(dev->id);
2426 log2_per_phys = ata_id_log2_per_physical_sector(dev->id);
2427 lowest_aligned = ata_id_logical_sector_offset(dev->id, log2_per_phys);
2431 if (args->cmd->cmnd[0] == READ_CAPACITY) {
2432 if (last_lba >= 0xffffffffULL)
2433 last_lba = 0xffffffff;
2435 /* sector count, 32-bit */
2436 rbuf[0] = last_lba >> (8 * 3);
2437 rbuf[1] = last_lba >> (8 * 2);
2438 rbuf[2] = last_lba >> (8 * 1);
2442 rbuf[4] = sector_size >> (8 * 3);
2443 rbuf[5] = sector_size >> (8 * 2);
2444 rbuf[6] = sector_size >> (8 * 1);
2445 rbuf[7] = sector_size;
2447 /* sector count, 64-bit */
2448 rbuf[0] = last_lba >> (8 * 7);
2449 rbuf[1] = last_lba >> (8 * 6);
2450 rbuf[2] = last_lba >> (8 * 5);
2451 rbuf[3] = last_lba >> (8 * 4);
2452 rbuf[4] = last_lba >> (8 * 3);
2453 rbuf[5] = last_lba >> (8 * 2);
2454 rbuf[6] = last_lba >> (8 * 1);
2458 rbuf[ 8] = sector_size >> (8 * 3);
2459 rbuf[ 9] = sector_size >> (8 * 2);
2460 rbuf[10] = sector_size >> (8 * 1);
2461 rbuf[11] = sector_size;
2464 rbuf[13] = log2_per_phys;
2465 rbuf[14] = (lowest_aligned >> 8) & 0x3f;
2466 rbuf[15] = lowest_aligned;
2468 if (ata_id_has_trim(args->id) &&
2469 !(dev->horkage & ATA_HORKAGE_NOTRIM)) {
2470 rbuf[14] |= 0x80; /* LBPME */
2472 if (ata_id_has_zero_after_trim(args->id) &&
2473 dev->horkage & ATA_HORKAGE_ZERO_AFTER_TRIM) {
2474 ata_dev_info(dev, "Enabling discard_zeroes_data\n");
2475 rbuf[14] |= 0x40; /* LBPRZ */
2478 if (ata_id_zoned_cap(args->id) ||
2479 args->dev->class == ATA_DEV_ZAC)
2480 rbuf[12] = (1 << 4); /* RC_BASIS */
2486 * ata_scsiop_report_luns - Simulate REPORT LUNS command
2487 * @args: device IDENTIFY data / SCSI command of interest.
2488 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2490 * Simulate REPORT LUNS command.
2493 * spin_lock_irqsave(host lock)
2495 static unsigned int ata_scsiop_report_luns(struct ata_scsi_args *args, u8 *rbuf)
2498 rbuf[3] = 8; /* just one lun, LUN 0, size 8 bytes */
2503 static void atapi_sense_complete(struct ata_queued_cmd *qc)
2505 if (qc->err_mask && ((qc->err_mask & AC_ERR_DEV) == 0)) {
2506 /* FIXME: not quite right; we don't want the
2507 * translation of taskfile registers into
2508 * a sense descriptors, since that's only
2509 * correct for ATA, not ATAPI
2511 ata_gen_passthru_sense(qc);
2517 /* is it pointless to prefer PIO for "safety reasons"? */
2518 static inline int ata_pio_use_silly(struct ata_port *ap)
2520 return (ap->flags & ATA_FLAG_PIO_DMA);
2523 static void atapi_request_sense(struct ata_queued_cmd *qc)
2525 struct ata_port *ap = qc->ap;
2526 struct scsi_cmnd *cmd = qc->scsicmd;
2528 DPRINTK("ATAPI request sense\n");
2530 memset(cmd->sense_buffer, 0, SCSI_SENSE_BUFFERSIZE);
2532 #ifdef CONFIG_ATA_SFF
2533 if (ap->ops->sff_tf_read)
2534 ap->ops->sff_tf_read(ap, &qc->tf);
2537 /* fill these in, for the case where they are -not- overwritten */
2538 cmd->sense_buffer[0] = 0x70;
2539 cmd->sense_buffer[2] = qc->tf.feature >> 4;
2543 /* setup sg table and init transfer direction */
2544 sg_init_one(&qc->sgent, cmd->sense_buffer, SCSI_SENSE_BUFFERSIZE);
2545 ata_sg_init(qc, &qc->sgent, 1);
2546 qc->dma_dir = DMA_FROM_DEVICE;
2548 memset(&qc->cdb, 0, qc->dev->cdb_len);
2549 qc->cdb[0] = REQUEST_SENSE;
2550 qc->cdb[4] = SCSI_SENSE_BUFFERSIZE;
2552 qc->tf.flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
2553 qc->tf.command = ATA_CMD_PACKET;
2555 if (ata_pio_use_silly(ap)) {
2556 qc->tf.protocol = ATAPI_PROT_DMA;
2557 qc->tf.feature |= ATAPI_PKT_DMA;
2559 qc->tf.protocol = ATAPI_PROT_PIO;
2560 qc->tf.lbam = SCSI_SENSE_BUFFERSIZE;
2563 qc->nbytes = SCSI_SENSE_BUFFERSIZE;
2565 qc->complete_fn = atapi_sense_complete;
2573 * ATAPI devices typically report zero for their SCSI version, and sometimes
2574 * deviate from the spec WRT response data format. If SCSI version is
2575 * reported as zero like normal, then we make the following fixups:
2576 * 1) Fake MMC-5 version, to indicate to the Linux scsi midlayer this is a
2578 * 2) Ensure response data format / ATAPI information are always correct.
2580 static void atapi_fixup_inquiry(struct scsi_cmnd *cmd)
2584 sg_copy_to_buffer(scsi_sglist(cmd), scsi_sg_count(cmd), buf, 4);
2589 sg_copy_from_buffer(scsi_sglist(cmd), scsi_sg_count(cmd), buf, 4);
2592 static void atapi_qc_complete(struct ata_queued_cmd *qc)
2594 struct scsi_cmnd *cmd = qc->scsicmd;
2595 unsigned int err_mask = qc->err_mask;
2597 VPRINTK("ENTER, err_mask 0x%X\n", err_mask);
2599 /* handle completion from new EH */
2600 if (unlikely(qc->ap->ops->error_handler &&
2601 (err_mask || qc->flags & ATA_QCFLAG_SENSE_VALID))) {
2603 if (!(qc->flags & ATA_QCFLAG_SENSE_VALID)) {
2604 /* FIXME: not quite right; we don't want the
2605 * translation of taskfile registers into a
2606 * sense descriptors, since that's only
2607 * correct for ATA, not ATAPI
2609 ata_gen_passthru_sense(qc);
2612 /* SCSI EH automatically locks door if sdev->locked is
2613 * set. Sometimes door lock request continues to
2614 * fail, for example, when no media is present. This
2615 * creates a loop - SCSI EH issues door lock which
2616 * fails and gets invoked again to acquire sense data
2617 * for the failed command.
2619 * If door lock fails, always clear sdev->locked to
2620 * avoid this infinite loop.
2622 * This may happen before SCSI scan is complete. Make
2623 * sure qc->dev->sdev isn't NULL before dereferencing.
2625 if (qc->cdb[0] == ALLOW_MEDIUM_REMOVAL && qc->dev->sdev)
2626 qc->dev->sdev->locked = 0;
2628 qc->scsicmd->result = SAM_STAT_CHECK_CONDITION;
2633 /* successful completion or old EH failure path */
2634 if (unlikely(err_mask & AC_ERR_DEV)) {
2635 cmd->result = SAM_STAT_CHECK_CONDITION;
2636 atapi_request_sense(qc);
2638 } else if (unlikely(err_mask)) {
2639 /* FIXME: not quite right; we don't want the
2640 * translation of taskfile registers into
2641 * a sense descriptors, since that's only
2642 * correct for ATA, not ATAPI
2644 ata_gen_passthru_sense(qc);
2646 if (cmd->cmnd[0] == INQUIRY && (cmd->cmnd[1] & 0x03) == 0)
2647 atapi_fixup_inquiry(cmd);
2648 cmd->result = SAM_STAT_GOOD;
2654 * atapi_xlat - Initialize PACKET taskfile
2655 * @qc: command structure to be initialized
2658 * spin_lock_irqsave(host lock)
2661 * Zero on success, non-zero on failure.
2663 static unsigned int atapi_xlat(struct ata_queued_cmd *qc)
2665 struct scsi_cmnd *scmd = qc->scsicmd;
2666 struct ata_device *dev = qc->dev;
2667 int nodata = (scmd->sc_data_direction == DMA_NONE);
2668 int using_pio = !nodata && (dev->flags & ATA_DFLAG_PIO);
2669 unsigned int nbytes;
2671 memset(qc->cdb, 0, dev->cdb_len);
2672 memcpy(qc->cdb, scmd->cmnd, scmd->cmd_len);
2674 qc->complete_fn = atapi_qc_complete;
2676 qc->tf.flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
2677 if (scmd->sc_data_direction == DMA_TO_DEVICE) {
2678 qc->tf.flags |= ATA_TFLAG_WRITE;
2679 DPRINTK("direction: write\n");
2682 qc->tf.command = ATA_CMD_PACKET;
2683 ata_qc_set_pc_nbytes(qc);
2685 /* check whether ATAPI DMA is safe */
2686 if (!nodata && !using_pio && atapi_check_dma(qc))
2689 /* Some controller variants snoop this value for Packet
2690 * transfers to do state machine and FIFO management. Thus we
2691 * want to set it properly, and for DMA where it is
2692 * effectively meaningless.
2694 nbytes = min(ata_qc_raw_nbytes(qc), (unsigned int)63 * 1024);
2696 /* Most ATAPI devices which honor transfer chunk size don't
2697 * behave according to the spec when odd chunk size which
2698 * matches the transfer length is specified. If the number of
2699 * bytes to transfer is 2n+1. According to the spec, what
2700 * should happen is to indicate that 2n+1 is going to be
2701 * transferred and transfer 2n+2 bytes where the last byte is
2704 * In practice, this doesn't happen. ATAPI devices first
2705 * indicate and transfer 2n bytes and then indicate and
2706 * transfer 2 bytes where the last byte is padding.
2708 * This inconsistency confuses several controllers which
2709 * perform PIO using DMA such as Intel AHCIs and sil3124/32.
2710 * These controllers use actual number of transferred bytes to
2711 * update DMA pointer and transfer of 4n+2 bytes make those
2712 * controller push DMA pointer by 4n+4 bytes because SATA data
2713 * FISes are aligned to 4 bytes. This causes data corruption
2714 * and buffer overrun.
2716 * Always setting nbytes to even number solves this problem
2717 * because then ATAPI devices don't have to split data at 2n
2723 qc->tf.lbam = (nbytes & 0xFF);
2724 qc->tf.lbah = (nbytes >> 8);
2727 qc->tf.protocol = ATAPI_PROT_NODATA;
2729 qc->tf.protocol = ATAPI_PROT_PIO;
2732 qc->tf.protocol = ATAPI_PROT_DMA;
2733 qc->tf.feature |= ATAPI_PKT_DMA;
2735 if ((dev->flags & ATA_DFLAG_DMADIR) &&
2736 (scmd->sc_data_direction != DMA_TO_DEVICE))
2737 /* some SATA bridges need us to indicate data xfer direction */
2738 qc->tf.feature |= ATAPI_DMADIR;
2742 /* FIXME: We need to translate 0x05 READ_BLOCK_LIMITS to a MODE_SENSE
2743 as ATAPI tape drives don't get this right otherwise */
2747 static struct ata_device *ata_find_dev(struct ata_port *ap, int devno)
2749 if (!sata_pmp_attached(ap)) {
2750 if (likely(devno >= 0 &&
2751 devno < ata_link_max_devices(&ap->link)))
2752 return &ap->link.device[devno];
2754 if (likely(devno >= 0 &&
2755 devno < ap->nr_pmp_links))
2756 return &ap->pmp_link[devno].device[0];
2762 static struct ata_device *__ata_scsi_find_dev(struct ata_port *ap,
2763 const struct scsi_device *scsidev)
2767 /* skip commands not addressed to targets we simulate */
2768 if (!sata_pmp_attached(ap)) {
2769 if (unlikely(scsidev->channel || scsidev->lun))
2771 devno = scsidev->id;
2773 if (unlikely(scsidev->id || scsidev->lun))
2775 devno = scsidev->channel;
2778 return ata_find_dev(ap, devno);
2782 * ata_scsi_find_dev - lookup ata_device from scsi_cmnd
2783 * @ap: ATA port to which the device is attached
2784 * @scsidev: SCSI device from which we derive the ATA device
2786 * Given various information provided in struct scsi_cmnd,
2787 * map that onto an ATA bus, and using that mapping
2788 * determine which ata_device is associated with the
2789 * SCSI command to be sent.
2792 * spin_lock_irqsave(host lock)
2795 * Associated ATA device, or %NULL if not found.
2798 ata_scsi_find_dev(struct ata_port *ap, const struct scsi_device *scsidev)
2800 struct ata_device *dev = __ata_scsi_find_dev(ap, scsidev);
2802 if (unlikely(!dev || !ata_dev_enabled(dev)))
2809 * ata_scsi_map_proto - Map pass-thru protocol value to taskfile value.
2810 * @byte1: Byte 1 from pass-thru CDB.
2813 * ATA_PROT_UNKNOWN if mapping failed/unimplemented, protocol otherwise.
2816 ata_scsi_map_proto(u8 byte1)
2818 switch((byte1 & 0x1e) >> 1) {
2819 case 3: /* Non-data */
2820 return ATA_PROT_NODATA;
2823 case 10: /* UDMA Data-in */
2824 case 11: /* UDMA Data-Out */
2825 return ATA_PROT_DMA;
2827 case 4: /* PIO Data-in */
2828 case 5: /* PIO Data-out */
2829 return ATA_PROT_PIO;
2831 case 12: /* FPDMA */
2832 return ATA_PROT_NCQ;
2834 case 0: /* Hard Reset */
2836 case 8: /* Device Diagnostic */
2837 case 9: /* Device Reset */
2838 case 7: /* DMA Queued */
2839 case 15: /* Return Response Info */
2840 default: /* Reserved */
2844 return ATA_PROT_UNKNOWN;
2848 * ata_scsi_pass_thru - convert ATA pass-thru CDB to taskfile
2849 * @qc: command structure to be initialized
2851 * Handles either 12, 16, or 32-byte versions of the CDB.
2854 * Zero on success, non-zero on failure.
2856 static unsigned int ata_scsi_pass_thru(struct ata_queued_cmd *qc)
2858 struct ata_taskfile *tf = &(qc->tf);
2859 struct scsi_cmnd *scmd = qc->scsicmd;
2860 struct ata_device *dev = qc->dev;
2861 const u8 *cdb = scmd->cmnd;
2865 /* 7Fh variable length cmd means a ata pass-thru(32) */
2866 if (cdb[0] == VARIABLE_LENGTH_CMD)
2869 tf->protocol = ata_scsi_map_proto(cdb[1 + cdb_offset]);
2870 if (tf->protocol == ATA_PROT_UNKNOWN) {
2875 if (ata_is_ncq(tf->protocol) && (cdb[2 + cdb_offset] & 0x3) == 0)
2876 tf->protocol = ATA_PROT_NCQ_NODATA;
2879 tf->flags |= ATA_TFLAG_LBA;
2882 * 12 and 16 byte CDBs use different offsets to
2883 * provide the various register values.
2885 if (cdb[0] == ATA_16) {
2887 * 16-byte CDB - may contain extended commands.
2889 * If that is the case, copy the upper byte register values.
2891 if (cdb[1] & 0x01) {
2892 tf->hob_feature = cdb[3];
2893 tf->hob_nsect = cdb[5];
2894 tf->hob_lbal = cdb[7];
2895 tf->hob_lbam = cdb[9];
2896 tf->hob_lbah = cdb[11];
2897 tf->flags |= ATA_TFLAG_LBA48;
2899 tf->flags &= ~ATA_TFLAG_LBA48;
2902 * Always copy low byte, device and command registers.
2904 tf->feature = cdb[4];
2909 tf->device = cdb[13];
2910 tf->command = cdb[14];
2911 } else if (cdb[0] == ATA_12) {
2913 * 12-byte CDB - incapable of extended commands.
2915 tf->flags &= ~ATA_TFLAG_LBA48;
2917 tf->feature = cdb[3];
2922 tf->device = cdb[8];
2923 tf->command = cdb[9];
2926 * 32-byte CDB - may contain extended command fields.
2928 * If that is the case, copy the upper byte register values.
2930 if (cdb[10] & 0x01) {
2931 tf->hob_feature = cdb[20];
2932 tf->hob_nsect = cdb[22];
2933 tf->hob_lbal = cdb[16];
2934 tf->hob_lbam = cdb[15];
2935 tf->hob_lbah = cdb[14];
2936 tf->flags |= ATA_TFLAG_LBA48;
2938 tf->flags &= ~ATA_TFLAG_LBA48;
2940 tf->feature = cdb[21];
2941 tf->nsect = cdb[23];
2945 tf->device = cdb[24];
2946 tf->command = cdb[25];
2947 tf->auxiliary = get_unaligned_be32(&cdb[28]);
2950 /* For NCQ commands copy the tag value */
2951 if (ata_is_ncq(tf->protocol))
2952 tf->nsect = qc->hw_tag << 3;
2954 /* enforce correct master/slave bit */
2955 tf->device = dev->devno ?
2956 tf->device | ATA_DEV1 : tf->device & ~ATA_DEV1;
2958 switch (tf->command) {
2959 /* READ/WRITE LONG use a non-standard sect_size */
2960 case ATA_CMD_READ_LONG:
2961 case ATA_CMD_READ_LONG_ONCE:
2962 case ATA_CMD_WRITE_LONG:
2963 case ATA_CMD_WRITE_LONG_ONCE:
2964 if (tf->protocol != ATA_PROT_PIO || tf->nsect != 1) {
2968 qc->sect_size = scsi_bufflen(scmd);
2971 /* commands using reported Logical Block size (e.g. 512 or 4K) */
2972 case ATA_CMD_CFA_WRITE_NE:
2973 case ATA_CMD_CFA_TRANS_SECT:
2974 case ATA_CMD_CFA_WRITE_MULT_NE:
2975 /* XXX: case ATA_CMD_CFA_WRITE_SECTORS_WITHOUT_ERASE: */
2977 case ATA_CMD_READ_EXT:
2978 case ATA_CMD_READ_QUEUED:
2979 /* XXX: case ATA_CMD_READ_QUEUED_EXT: */
2980 case ATA_CMD_FPDMA_READ:
2981 case ATA_CMD_READ_MULTI:
2982 case ATA_CMD_READ_MULTI_EXT:
2983 case ATA_CMD_PIO_READ:
2984 case ATA_CMD_PIO_READ_EXT:
2985 case ATA_CMD_READ_STREAM_DMA_EXT:
2986 case ATA_CMD_READ_STREAM_EXT:
2987 case ATA_CMD_VERIFY:
2988 case ATA_CMD_VERIFY_EXT:
2990 case ATA_CMD_WRITE_EXT:
2991 case ATA_CMD_WRITE_FUA_EXT:
2992 case ATA_CMD_WRITE_QUEUED:
2993 case ATA_CMD_WRITE_QUEUED_FUA_EXT:
2994 case ATA_CMD_FPDMA_WRITE:
2995 case ATA_CMD_WRITE_MULTI:
2996 case ATA_CMD_WRITE_MULTI_EXT:
2997 case ATA_CMD_WRITE_MULTI_FUA_EXT:
2998 case ATA_CMD_PIO_WRITE:
2999 case ATA_CMD_PIO_WRITE_EXT:
3000 case ATA_CMD_WRITE_STREAM_DMA_EXT:
3001 case ATA_CMD_WRITE_STREAM_EXT:
3002 qc->sect_size = scmd->device->sector_size;
3005 /* Everything else uses 512 byte "sectors" */
3007 qc->sect_size = ATA_SECT_SIZE;
3011 * Set flags so that all registers will be written, pass on
3012 * write indication (used for PIO/DMA setup), result TF is
3013 * copied back and we don't whine too much about its failure.
3015 tf->flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
3016 if (scmd->sc_data_direction == DMA_TO_DEVICE)
3017 tf->flags |= ATA_TFLAG_WRITE;
3019 qc->flags |= ATA_QCFLAG_RESULT_TF | ATA_QCFLAG_QUIET;
3022 * Set transfer length.
3024 * TODO: find out if we need to do more here to
3025 * cover scatter/gather case.
3027 ata_qc_set_pc_nbytes(qc);
3029 /* We may not issue DMA commands if no DMA mode is set */
3030 if (tf->protocol == ATA_PROT_DMA && dev->dma_mode == 0) {
3035 /* We may not issue NCQ commands to devices not supporting NCQ */
3036 if (ata_is_ncq(tf->protocol) && !ata_ncq_enabled(dev)) {
3041 /* sanity check for pio multi commands */
3042 if ((cdb[1] & 0xe0) && !is_multi_taskfile(tf)) {
3047 if (is_multi_taskfile(tf)) {
3048 unsigned int multi_count = 1 << (cdb[1] >> 5);
3050 /* compare the passed through multi_count
3051 * with the cached multi_count of libata
3053 if (multi_count != dev->multi_count)
3054 ata_dev_warn(dev, "invalid multi_count %u ignored\n",
3059 * Filter SET_FEATURES - XFER MODE command -- otherwise,
3060 * SET_FEATURES - XFER MODE must be preceded/succeeded
3061 * by an update to hardware-specific registers for each
3062 * controller (i.e. the reason for ->set_piomode(),
3063 * ->set_dmamode(), and ->post_set_mode() hooks).
3065 if (tf->command == ATA_CMD_SET_FEATURES &&
3066 tf->feature == SETFEATURES_XFER) {
3067 fp = (cdb[0] == ATA_16) ? 4 : 3;
3072 * Filter TPM commands by default. These provide an
3073 * essentially uncontrolled encrypted "back door" between
3074 * applications and the disk. Set libata.allow_tpm=1 if you
3075 * have a real reason for wanting to use them. This ensures
3076 * that installed software cannot easily mess stuff up without
3077 * user intent. DVR type users will probably ship with this enabled
3078 * for movie content management.
3080 * Note that for ATA8 we can issue a DCS change and DCS freeze lock
3081 * for this and should do in future but that it is not sufficient as
3082 * DCS is an optional feature set. Thus we also do the software filter
3083 * so that we comply with the TC consortium stated goal that the user
3084 * can turn off TC features of their system.
3086 if (tf->command >= 0x5C && tf->command <= 0x5F && !libata_allow_tpm) {
3087 fp = (cdb[0] == ATA_16) ? 14 : 9;
3094 ata_scsi_set_invalid_field(dev, scmd, fp, 0xff);
3099 * ata_format_dsm_trim_descr() - SATL Write Same to DSM Trim
3100 * @cmd: SCSI command being translated
3101 * @trmax: Maximum number of entries that will fit in sector_size bytes.
3102 * @sector: Starting sector
3103 * @count: Total Range of request in logical sectors
3105 * Rewrite the WRITE SAME descriptor to be a DSM TRIM little-endian formatted
3108 * Upto 64 entries of the format:
3109 * 63:48 Range Length
3112 * Range Length of 0 is ignored.
3113 * LBA's should be sorted order and not overlap.
3115 * NOTE: this is the same format as ADD LBA(S) TO NV CACHE PINNED SET
3117 * Return: Number of bytes copied into sglist.
3119 static size_t ata_format_dsm_trim_descr(struct scsi_cmnd *cmd, u32 trmax,
3120 u64 sector, u32 count)
3122 struct scsi_device *sdp = cmd->device;
3123 size_t len = sdp->sector_size;
3127 unsigned long flags;
3129 WARN_ON(len > ATA_SCSI_RBUF_SIZE);
3131 if (len > ATA_SCSI_RBUF_SIZE)
3132 len = ATA_SCSI_RBUF_SIZE;
3134 spin_lock_irqsave(&ata_scsi_rbuf_lock, flags);
3135 buf = ((void *)ata_scsi_rbuf);
3136 memset(buf, 0, len);
3138 u64 entry = sector |
3139 ((u64)(count > 0xffff ? 0xffff : count) << 48);
3140 buf[i++] = __cpu_to_le64(entry);
3141 if (count <= 0xffff)
3146 r = sg_copy_from_buffer(scsi_sglist(cmd), scsi_sg_count(cmd), buf, len);
3147 spin_unlock_irqrestore(&ata_scsi_rbuf_lock, flags);
3153 * ata_scsi_write_same_xlat() - SATL Write Same to ATA SCT Write Same
3154 * @qc: Command to be translated
3156 * Translate a SCSI WRITE SAME command to be either a DSM TRIM command or
3157 * an SCT Write Same command.
3158 * Based on WRITE SAME has the UNMAP flag:
3160 * - When set translate to DSM TRIM
3161 * - When clear translate to SCT Write Same
3163 static unsigned int ata_scsi_write_same_xlat(struct ata_queued_cmd *qc)
3165 struct ata_taskfile *tf = &qc->tf;
3166 struct scsi_cmnd *scmd = qc->scsicmd;
3167 struct scsi_device *sdp = scmd->device;
3168 size_t len = sdp->sector_size;
3169 struct ata_device *dev = qc->dev;
3170 const u8 *cdb = scmd->cmnd;
3173 const u32 trmax = len >> 3;
3177 u8 unmap = cdb[1] & 0x8;
3179 /* we may not issue DMA commands if no DMA mode is set */
3180 if (unlikely(!dev->dma_mode))
3181 goto invalid_opcode;
3184 * We only allow sending this command through the block layer,
3185 * as it modifies the DATA OUT buffer, which would corrupt user
3186 * memory for SG_IO commands.
3188 if (unlikely(blk_rq_is_passthrough(scmd->request)))
3189 goto invalid_opcode;
3191 if (unlikely(scmd->cmd_len < 16)) {
3195 scsi_16_lba_len(cdb, &block, &n_block);
3198 (dev->horkage & ATA_HORKAGE_NOTRIM) ||
3199 !ata_id_has_trim(dev->id)) {
3204 /* If the request is too large the cmd is invalid */
3205 if (n_block > 0xffff * trmax) {
3211 * WRITE SAME always has a sector sized buffer as payload, this
3212 * should never be a multiple entry S/G list.
3214 if (!scsi_sg_count(scmd))
3215 goto invalid_param_len;
3218 * size must match sector size in bytes
3219 * For DATA SET MANAGEMENT TRIM in ACS-2 nsect (aka count)
3220 * is defined as number of 512 byte blocks to be transferred.
3223 size = ata_format_dsm_trim_descr(scmd, trmax, block, n_block);
3225 goto invalid_param_len;
3227 if (ata_ncq_enabled(dev) && ata_fpdma_dsm_supported(dev)) {
3228 /* Newer devices support queued TRIM commands */
3229 tf->protocol = ATA_PROT_NCQ;
3230 tf->command = ATA_CMD_FPDMA_SEND;
3231 tf->hob_nsect = ATA_SUBCMD_FPDMA_SEND_DSM & 0x1f;
3232 tf->nsect = qc->hw_tag << 3;
3233 tf->hob_feature = (size / 512) >> 8;
3234 tf->feature = size / 512;
3238 tf->protocol = ATA_PROT_DMA;
3239 tf->hob_feature = 0;
3240 tf->feature = ATA_DSM_TRIM;
3241 tf->hob_nsect = (size / 512) >> 8;
3242 tf->nsect = size / 512;
3243 tf->command = ATA_CMD_DSM;
3246 tf->flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE | ATA_TFLAG_LBA48 |
3249 ata_qc_set_pc_nbytes(qc);
3254 ata_scsi_set_invalid_field(dev, scmd, fp, bp);
3257 /* "Parameter list length error" */
3258 ata_scsi_set_sense(dev, scmd, ILLEGAL_REQUEST, 0x1a, 0x0);
3261 /* "Invalid command operation code" */
3262 ata_scsi_set_sense(dev, scmd, ILLEGAL_REQUEST, 0x20, 0x0);
3267 * ata_scsiop_maint_in - Simulate a subset of MAINTENANCE_IN
3268 * @args: device MAINTENANCE_IN data / SCSI command of interest.
3269 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
3271 * Yields a subset to satisfy scsi_report_opcode()
3274 * spin_lock_irqsave(host lock)
3276 static unsigned int ata_scsiop_maint_in(struct ata_scsi_args *args, u8 *rbuf)
3278 struct ata_device *dev = args->dev;
3279 u8 *cdb = args->cmd->cmnd;
3281 unsigned int err = 0;
3284 ata_dev_warn(dev, "invalid command format %d\n", cdb[2]);
3293 case SERVICE_ACTION_IN_16:
3296 case SYNCHRONIZE_CACHE:
3300 case TEST_UNIT_READY:
3301 case SEND_DIAGNOSTIC:
3302 case MAINTENANCE_IN:
3314 case MODE_SELECT_10:
3320 if (ata_id_zoned_cap(dev->id) ||
3321 dev->class == ATA_DEV_ZAC)
3324 case SECURITY_PROTOCOL_IN:
3325 case SECURITY_PROTOCOL_OUT:
3326 if (dev->flags & ATA_DFLAG_TRUSTED)
3333 rbuf[1] = supported; /* supported */
3338 * ata_scsi_report_zones_complete - convert ATA output
3339 * @qc: command structure returning the data
3341 * Convert T-13 little-endian field representation into
3342 * T-10 big-endian field representation.
3345 static void ata_scsi_report_zones_complete(struct ata_queued_cmd *qc)
3347 struct scsi_cmnd *scmd = qc->scsicmd;
3348 struct sg_mapping_iter miter;
3349 unsigned long flags;
3350 unsigned int bytes = 0;
3352 sg_miter_start(&miter, scsi_sglist(scmd), scsi_sg_count(scmd),
3353 SG_MITER_TO_SG | SG_MITER_ATOMIC);
3355 local_irq_save(flags);
3356 while (sg_miter_next(&miter)) {
3357 unsigned int offset = 0;
3362 u64 max_lba, opt_lba;
3365 /* Swizzle header */
3367 list_length = get_unaligned_le32(&hdr[0]);
3368 same = get_unaligned_le16(&hdr[4]);
3369 max_lba = get_unaligned_le64(&hdr[8]);
3370 opt_lba = get_unaligned_le64(&hdr[16]);
3371 put_unaligned_be32(list_length, &hdr[0]);
3372 hdr[4] = same & 0xf;
3373 put_unaligned_be64(max_lba, &hdr[8]);
3374 put_unaligned_be64(opt_lba, &hdr[16]);
3378 while (offset < miter.length) {
3380 u8 cond, type, non_seq, reset;
3381 u64 size, start, wp;
3383 /* Swizzle zone descriptor */
3384 rec = miter.addr + offset;
3385 type = rec[0] & 0xf;
3386 cond = (rec[1] >> 4) & 0xf;
3387 non_seq = (rec[1] & 2);
3388 reset = (rec[1] & 1);
3389 size = get_unaligned_le64(&rec[8]);
3390 start = get_unaligned_le64(&rec[16]);
3391 wp = get_unaligned_le64(&rec[24]);
3393 rec[1] = (cond << 4) | non_seq | reset;
3394 put_unaligned_be64(size, &rec[8]);
3395 put_unaligned_be64(start, &rec[16]);
3396 put_unaligned_be64(wp, &rec[24]);
3397 WARN_ON(offset + 64 > miter.length);
3402 sg_miter_stop(&miter);
3403 local_irq_restore(flags);
3405 ata_scsi_qc_complete(qc);
3408 static unsigned int ata_scsi_zbc_in_xlat(struct ata_queued_cmd *qc)
3410 struct ata_taskfile *tf = &qc->tf;
3411 struct scsi_cmnd *scmd = qc->scsicmd;
3412 const u8 *cdb = scmd->cmnd;
3413 u16 sect, fp = (u16)-1;
3414 u8 sa, options, bp = 0xff;
3418 if (unlikely(scmd->cmd_len < 16)) {
3419 ata_dev_warn(qc->dev, "invalid cdb length %d\n",
3424 scsi_16_lba_len(cdb, &block, &n_block);
3425 if (n_block != scsi_bufflen(scmd)) {
3426 ata_dev_warn(qc->dev, "non-matching transfer count (%d/%d)\n",
3427 n_block, scsi_bufflen(scmd));
3428 goto invalid_param_len;
3431 if (sa != ZI_REPORT_ZONES) {
3432 ata_dev_warn(qc->dev, "invalid service action %d\n", sa);
3437 * ZAC allows only for transfers in 512 byte blocks,
3438 * and uses a 16 bit value for the transfer count.
3440 if ((n_block / 512) > 0xffff || n_block < 512 || (n_block % 512)) {
3441 ata_dev_warn(qc->dev, "invalid transfer count %d\n", n_block);
3442 goto invalid_param_len;
3444 sect = n_block / 512;
3445 options = cdb[14] & 0xbf;
3447 if (ata_ncq_enabled(qc->dev) &&
3448 ata_fpdma_zac_mgmt_in_supported(qc->dev)) {
3449 tf->protocol = ATA_PROT_NCQ;
3450 tf->command = ATA_CMD_FPDMA_RECV;
3451 tf->hob_nsect = ATA_SUBCMD_FPDMA_RECV_ZAC_MGMT_IN & 0x1f;
3452 tf->nsect = qc->hw_tag << 3;
3453 tf->feature = sect & 0xff;
3454 tf->hob_feature = (sect >> 8) & 0xff;
3455 tf->auxiliary = ATA_SUBCMD_ZAC_MGMT_IN_REPORT_ZONES | (options << 8);
3457 tf->command = ATA_CMD_ZAC_MGMT_IN;
3458 tf->feature = ATA_SUBCMD_ZAC_MGMT_IN_REPORT_ZONES;
3459 tf->protocol = ATA_PROT_DMA;
3460 tf->hob_feature = options;
3461 tf->hob_nsect = (sect >> 8) & 0xff;
3462 tf->nsect = sect & 0xff;
3464 tf->device = ATA_LBA;
3465 tf->lbah = (block >> 16) & 0xff;
3466 tf->lbam = (block >> 8) & 0xff;
3467 tf->lbal = block & 0xff;
3468 tf->hob_lbah = (block >> 40) & 0xff;
3469 tf->hob_lbam = (block >> 32) & 0xff;
3470 tf->hob_lbal = (block >> 24) & 0xff;
3472 tf->flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE | ATA_TFLAG_LBA48;
3473 qc->flags |= ATA_QCFLAG_RESULT_TF;
3475 ata_qc_set_pc_nbytes(qc);
3477 qc->complete_fn = ata_scsi_report_zones_complete;
3482 ata_scsi_set_invalid_field(qc->dev, scmd, fp, bp);
3486 /* "Parameter list length error" */
3487 ata_scsi_set_sense(qc->dev, scmd, ILLEGAL_REQUEST, 0x1a, 0x0);
3491 static unsigned int ata_scsi_zbc_out_xlat(struct ata_queued_cmd *qc)
3493 struct ata_taskfile *tf = &qc->tf;
3494 struct scsi_cmnd *scmd = qc->scsicmd;
3495 struct ata_device *dev = qc->dev;
3496 const u8 *cdb = scmd->cmnd;
3502 if (unlikely(scmd->cmd_len < 16)) {
3508 if ((sa != ZO_CLOSE_ZONE) && (sa != ZO_FINISH_ZONE) &&
3509 (sa != ZO_OPEN_ZONE) && (sa != ZO_RESET_WRITE_POINTER)) {
3514 scsi_16_lba_len(cdb, &block, &n_block);
3517 * ZAC MANAGEMENT OUT doesn't define any length
3519 goto invalid_param_len;
3522 all = cdb[14] & 0x1;
3525 * Ignore the block address (zone ID) as defined by ZBC.
3528 } else if (block >= dev->n_sectors) {
3530 * Block must be a valid zone ID (a zone start LBA).
3536 if (ata_ncq_enabled(qc->dev) &&
3537 ata_fpdma_zac_mgmt_out_supported(qc->dev)) {
3538 tf->protocol = ATA_PROT_NCQ_NODATA;
3539 tf->command = ATA_CMD_NCQ_NON_DATA;
3540 tf->feature = ATA_SUBCMD_NCQ_NON_DATA_ZAC_MGMT_OUT;
3541 tf->nsect = qc->hw_tag << 3;
3542 tf->auxiliary = sa | ((u16)all << 8);
3544 tf->protocol = ATA_PROT_NODATA;
3545 tf->command = ATA_CMD_ZAC_MGMT_OUT;
3547 tf->hob_feature = all;
3549 tf->lbah = (block >> 16) & 0xff;
3550 tf->lbam = (block >> 8) & 0xff;
3551 tf->lbal = block & 0xff;
3552 tf->hob_lbah = (block >> 40) & 0xff;
3553 tf->hob_lbam = (block >> 32) & 0xff;
3554 tf->hob_lbal = (block >> 24) & 0xff;
3555 tf->device = ATA_LBA;
3556 tf->flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE | ATA_TFLAG_LBA48;
3561 ata_scsi_set_invalid_field(qc->dev, scmd, fp, 0xff);
3564 /* "Parameter list length error" */
3565 ata_scsi_set_sense(qc->dev, scmd, ILLEGAL_REQUEST, 0x1a, 0x0);
3570 * ata_mselect_caching - Simulate MODE SELECT for caching info page
3571 * @qc: Storage for translated ATA taskfile
3572 * @buf: input buffer
3573 * @len: number of valid bytes in the input buffer
3574 * @fp: out parameter for the failed field on error
3576 * Prepare a taskfile to modify caching information for the device.
3581 static int ata_mselect_caching(struct ata_queued_cmd *qc,
3582 const u8 *buf, int len, u16 *fp)
3584 struct ata_taskfile *tf = &qc->tf;
3585 struct ata_device *dev = qc->dev;
3586 u8 mpage[CACHE_MPAGE_LEN];
3591 * The first two bytes of def_cache_mpage are a header, so offsets
3592 * in mpage are off by 2 compared to buf. Same for len.
3595 if (len != CACHE_MPAGE_LEN - 2) {
3596 if (len < CACHE_MPAGE_LEN - 2)
3599 *fp = CACHE_MPAGE_LEN - 2;
3603 wce = buf[0] & (1 << 2);
3606 * Check that read-only bits are not modified.
3608 ata_msense_caching(dev->id, mpage, false);
3609 for (i = 0; i < CACHE_MPAGE_LEN - 2; i++) {
3612 if (mpage[i + 2] != buf[i]) {
3618 tf->flags |= ATA_TFLAG_DEVICE | ATA_TFLAG_ISADDR;
3619 tf->protocol = ATA_PROT_NODATA;
3621 tf->command = ATA_CMD_SET_FEATURES;
3622 tf->feature = wce ? SETFEATURES_WC_ON : SETFEATURES_WC_OFF;
3627 * ata_mselect_control - Simulate MODE SELECT for control page
3628 * @qc: Storage for translated ATA taskfile
3629 * @buf: input buffer
3630 * @len: number of valid bytes in the input buffer
3631 * @fp: out parameter for the failed field on error
3633 * Prepare a taskfile to modify caching information for the device.
3638 static int ata_mselect_control(struct ata_queued_cmd *qc,
3639 const u8 *buf, int len, u16 *fp)
3641 struct ata_device *dev = qc->dev;
3642 u8 mpage[CONTROL_MPAGE_LEN];
3647 * The first two bytes of def_control_mpage are a header, so offsets
3648 * in mpage are off by 2 compared to buf. Same for len.
3651 if (len != CONTROL_MPAGE_LEN - 2) {
3652 if (len < CONTROL_MPAGE_LEN - 2)
3655 *fp = CONTROL_MPAGE_LEN - 2;
3659 d_sense = buf[0] & (1 << 2);
3662 * Check that read-only bits are not modified.
3664 ata_msense_control(dev, mpage, false);
3665 for (i = 0; i < CONTROL_MPAGE_LEN - 2; i++) {
3668 if (mpage[2 + i] != buf[i]) {
3673 if (d_sense & (1 << 2))
3674 dev->flags |= ATA_DFLAG_D_SENSE;
3676 dev->flags &= ~ATA_DFLAG_D_SENSE;
3681 * ata_scsi_mode_select_xlat - Simulate MODE SELECT 6, 10 commands
3682 * @qc: Storage for translated ATA taskfile
3684 * Converts a MODE SELECT command to an ATA SET FEATURES taskfile.
3685 * Assume this is invoked for direct access devices (e.g. disks) only.
3686 * There should be no block descriptor for other device types.
3689 * spin_lock_irqsave(host lock)
3691 static unsigned int ata_scsi_mode_select_xlat(struct ata_queued_cmd *qc)
3693 struct scsi_cmnd *scmd = qc->scsicmd;
3694 const u8 *cdb = scmd->cmnd;
3697 unsigned six_byte, pg_len, hdr_len, bd_len;
3704 six_byte = (cdb[0] == MODE_SELECT);
3706 if (scmd->cmd_len < 5) {
3714 if (scmd->cmd_len < 9) {
3719 len = (cdb[7] << 8) + cdb[8];
3723 /* We only support PF=1, SP=0. */
3724 if ((cdb[1] & 0x11) != 0x10) {
3726 bp = (cdb[1] & 0x01) ? 1 : 5;
3730 /* Test early for possible overrun. */
3731 if (!scsi_sg_count(scmd) || scsi_sglist(scmd)->length < len)
3732 goto invalid_param_len;
3734 p = page_address(sg_page(scsi_sglist(scmd)));
3736 /* Move past header and block descriptors. */
3738 goto invalid_param_len;
3743 bd_len = (p[6] << 8) + p[7];
3748 goto invalid_param_len;
3749 if (bd_len != 0 && bd_len != 8) {
3750 fp = (six_byte) ? 3 : 6;
3751 fp += bd_len + hdr_len;
3760 /* Parse both possible formats for the mode page headers. */
3764 goto invalid_param_len;
3767 pg_len = (p[2] << 8) | p[3];
3772 goto invalid_param_len;
3781 * No mode subpages supported (yet) but asking for _all_
3782 * subpages may be valid
3784 if (spg && (spg != ALL_SUB_MPAGES)) {
3785 fp = (p[0] & 0x40) ? 1 : 0;
3786 fp += hdr_len + bd_len;
3790 goto invalid_param_len;
3794 if (ata_mselect_caching(qc, p, pg_len, &fp) < 0) {
3795 fp += hdr_len + bd_len;
3800 if (ata_mselect_control(qc, p, pg_len, &fp) < 0) {
3801 fp += hdr_len + bd_len;
3804 goto skip; /* No ATA command to send */
3807 default: /* invalid page code */
3808 fp = bd_len + hdr_len;
3813 * Only one page has changeable data, so we only support setting one
3822 ata_scsi_set_invalid_field(qc->dev, scmd, fp, bp);
3826 ata_scsi_set_invalid_parameter(qc->dev, scmd, fp);
3830 /* "Parameter list length error" */
3831 ata_scsi_set_sense(qc->dev, scmd, ILLEGAL_REQUEST, 0x1a, 0x0);
3835 scmd->result = SAM_STAT_GOOD;
3839 static u8 ata_scsi_trusted_op(u32 len, bool send, bool dma)
3842 return ATA_CMD_TRUSTED_NONDATA;
3844 return dma ? ATA_CMD_TRUSTED_SND_DMA : ATA_CMD_TRUSTED_SND;
3846 return dma ? ATA_CMD_TRUSTED_RCV_DMA : ATA_CMD_TRUSTED_RCV;
3849 static unsigned int ata_scsi_security_inout_xlat(struct ata_queued_cmd *qc)
3851 struct scsi_cmnd *scmd = qc->scsicmd;
3852 const u8 *cdb = scmd->cmnd;
3853 struct ata_taskfile *tf = &qc->tf;
3855 bool send = (cdb[0] == SECURITY_PROTOCOL_OUT);
3856 u16 spsp = get_unaligned_be16(&cdb[2]);
3857 u32 len = get_unaligned_be32(&cdb[6]);
3858 bool dma = !(qc->dev->flags & ATA_DFLAG_PIO);
3861 * We don't support the ATA "security" protocol.
3864 ata_scsi_set_invalid_field(qc->dev, scmd, 1, 0);
3868 if (cdb[4] & 7) { /* INC_512 */
3870 ata_scsi_set_invalid_field(qc->dev, scmd, 6, 0);
3874 if (len > 0x01fffe00) {
3875 ata_scsi_set_invalid_field(qc->dev, scmd, 6, 0);
3879 /* convert to the sector-based ATA addressing */
3880 len = (len + 511) / 512;
3883 tf->protocol = dma ? ATA_PROT_DMA : ATA_PROT_PIO;
3884 tf->flags |= ATA_TFLAG_DEVICE | ATA_TFLAG_ISADDR | ATA_TFLAG_LBA;
3886 tf->flags |= ATA_TFLAG_WRITE;
3887 tf->command = ata_scsi_trusted_op(len, send, dma);
3889 tf->lbam = spsp & 0xff;
3890 tf->lbah = spsp >> 8;
3893 tf->nsect = len & 0xff;
3894 tf->lbal = len >> 8;
3897 tf->lbah = (1 << 7);
3900 ata_qc_set_pc_nbytes(qc);
3905 * ata_scsi_var_len_cdb_xlat - SATL variable length CDB to Handler
3906 * @qc: Command to be translated
3908 * Translate a SCSI variable length CDB to specified commands.
3909 * It checks a service action value in CDB to call corresponding handler.
3912 * Zero on success, non-zero on failure
3915 static unsigned int ata_scsi_var_len_cdb_xlat(struct ata_queued_cmd *qc)
3917 struct scsi_cmnd *scmd = qc->scsicmd;
3918 const u8 *cdb = scmd->cmnd;
3919 const u16 sa = get_unaligned_be16(&cdb[8]);
3922 * if service action represents a ata pass-thru(32) command,
3923 * then pass it to ata_scsi_pass_thru handler.
3926 return ata_scsi_pass_thru(qc);
3928 /* unsupported service action */
3933 * ata_get_xlat_func - check if SCSI to ATA translation is possible
3935 * @cmd: SCSI command opcode to consider
3937 * Look up the SCSI command given, and determine whether the
3938 * SCSI command is to be translated or simulated.
3941 * Pointer to translation function if possible, %NULL if not.
3944 static inline ata_xlat_func_t ata_get_xlat_func(struct ata_device *dev, u8 cmd)
3954 return ata_scsi_rw_xlat;
3957 return ata_scsi_write_same_xlat;
3959 case SYNCHRONIZE_CACHE:
3960 if (ata_try_flush_cache(dev))
3961 return ata_scsi_flush_xlat;
3966 return ata_scsi_verify_xlat;
3970 return ata_scsi_pass_thru;
3972 case VARIABLE_LENGTH_CMD:
3973 return ata_scsi_var_len_cdb_xlat;
3976 case MODE_SELECT_10:
3977 return ata_scsi_mode_select_xlat;
3981 return ata_scsi_zbc_in_xlat;
3984 return ata_scsi_zbc_out_xlat;
3986 case SECURITY_PROTOCOL_IN:
3987 case SECURITY_PROTOCOL_OUT:
3988 if (!(dev->flags & ATA_DFLAG_TRUSTED))
3990 return ata_scsi_security_inout_xlat;
3993 return ata_scsi_start_stop_xlat;
4000 * ata_scsi_dump_cdb - dump SCSI command contents to dmesg
4001 * @ap: ATA port to which the command was being sent
4002 * @cmd: SCSI command to dump
4004 * Prints the contents of a SCSI command via printk().
4007 void ata_scsi_dump_cdb(struct ata_port *ap, struct scsi_cmnd *cmd)
4009 #ifdef ATA_VERBOSE_DEBUG
4010 struct scsi_device *scsidev = cmd->device;
4012 VPRINTK("CDB (%u:%d,%d,%lld) %9ph\n",
4014 scsidev->channel, scsidev->id, scsidev->lun,
4019 int __ata_scsi_queuecmd(struct scsi_cmnd *scmd, struct ata_device *dev)
4021 u8 scsi_op = scmd->cmnd[0];
4022 ata_xlat_func_t xlat_func;
4025 if (dev->class == ATA_DEV_ATA || dev->class == ATA_DEV_ZAC) {
4026 if (unlikely(!scmd->cmd_len || scmd->cmd_len > dev->cdb_len))
4029 xlat_func = ata_get_xlat_func(dev, scsi_op);
4031 if (unlikely(!scmd->cmd_len))
4035 if (likely((scsi_op != ATA_16) || !atapi_passthru16)) {
4036 /* relay SCSI command to ATAPI device */
4037 int len = COMMAND_SIZE(scsi_op);
4038 if (unlikely(len > scmd->cmd_len ||
4039 len > dev->cdb_len ||
4040 scmd->cmd_len > ATAPI_CDB_LEN))
4043 xlat_func = atapi_xlat;
4045 /* ATA_16 passthru, treat as an ATA command */
4046 if (unlikely(scmd->cmd_len > 16))
4049 xlat_func = ata_get_xlat_func(dev, scsi_op);
4054 rc = ata_scsi_translate(dev, scmd, xlat_func);
4056 ata_scsi_simulate(dev, scmd);
4061 DPRINTK("bad CDB len=%u, scsi_op=0x%02x, max=%u\n",
4062 scmd->cmd_len, scsi_op, dev->cdb_len);
4063 scmd->result = DID_ERROR << 16;
4064 scmd->scsi_done(scmd);
4069 * ata_scsi_queuecmd - Issue SCSI cdb to libata-managed device
4070 * @shost: SCSI host of command to be sent
4071 * @cmd: SCSI command to be sent
4073 * In some cases, this function translates SCSI commands into
4074 * ATA taskfiles, and queues the taskfiles to be sent to
4075 * hardware. In other cases, this function simulates a
4076 * SCSI device by evaluating and responding to certain
4077 * SCSI commands. This creates the overall effect of
4078 * ATA and ATAPI devices appearing as SCSI devices.
4084 * Return value from __ata_scsi_queuecmd() if @cmd can be queued,
4087 int ata_scsi_queuecmd(struct Scsi_Host *shost, struct scsi_cmnd *cmd)
4089 struct ata_port *ap;
4090 struct ata_device *dev;
4091 struct scsi_device *scsidev = cmd->device;
4093 unsigned long irq_flags;
4095 ap = ata_shost_to_port(shost);
4097 spin_lock_irqsave(ap->lock, irq_flags);
4099 ata_scsi_dump_cdb(ap, cmd);
4101 dev = ata_scsi_find_dev(ap, scsidev);
4103 rc = __ata_scsi_queuecmd(cmd, dev);
4105 cmd->result = (DID_BAD_TARGET << 16);
4106 cmd->scsi_done(cmd);
4109 spin_unlock_irqrestore(ap->lock, irq_flags);
4113 EXPORT_SYMBOL_GPL(ata_scsi_queuecmd);
4116 * ata_scsi_simulate - simulate SCSI command on ATA device
4117 * @dev: the target device
4118 * @cmd: SCSI command being sent to device.
4120 * Interprets and directly executes a select list of SCSI commands
4121 * that can be handled internally.
4124 * spin_lock_irqsave(host lock)
4127 void ata_scsi_simulate(struct ata_device *dev, struct scsi_cmnd *cmd)
4129 struct ata_scsi_args args;
4130 const u8 *scsicmd = cmd->cmnd;
4137 switch(scsicmd[0]) {
4139 if (scsicmd[1] & 2) /* is CmdDt set? */
4140 ata_scsi_set_invalid_field(dev, cmd, 1, 0xff);
4141 else if ((scsicmd[1] & 1) == 0) /* is EVPD clear? */
4142 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_std);
4143 else switch (scsicmd[2]) {
4145 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_00);
4148 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_80);
4151 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_83);
4154 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_89);
4157 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_b0);
4160 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_b1);
4163 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_b2);
4166 if (dev->flags & ATA_DFLAG_ZAC) {
4167 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_b6);
4172 ata_scsi_set_invalid_field(dev, cmd, 2, 0xff);
4179 ata_scsi_rbuf_fill(&args, ata_scsiop_mode_sense);
4183 ata_scsi_rbuf_fill(&args, ata_scsiop_read_cap);
4186 case SERVICE_ACTION_IN_16:
4187 if ((scsicmd[1] & 0x1f) == SAI_READ_CAPACITY_16)
4188 ata_scsi_rbuf_fill(&args, ata_scsiop_read_cap);
4190 ata_scsi_set_invalid_field(dev, cmd, 1, 0xff);
4194 ata_scsi_rbuf_fill(&args, ata_scsiop_report_luns);
4198 ata_scsi_set_sense(dev, cmd, 0, 0, 0);
4199 cmd->result = (DRIVER_SENSE << 24);
4202 /* if we reach this, then writeback caching is disabled,
4203 * turning this into a no-op.
4205 case SYNCHRONIZE_CACHE:
4208 /* no-op's, complete with success */
4212 case TEST_UNIT_READY:
4215 case SEND_DIAGNOSTIC:
4216 tmp8 = scsicmd[1] & ~(1 << 3);
4217 if (tmp8 != 0x4 || scsicmd[3] || scsicmd[4])
4218 ata_scsi_set_invalid_field(dev, cmd, 1, 0xff);
4221 case MAINTENANCE_IN:
4222 if (scsicmd[1] == MI_REPORT_SUPPORTED_OPERATION_CODES)
4223 ata_scsi_rbuf_fill(&args, ata_scsiop_maint_in);
4225 ata_scsi_set_invalid_field(dev, cmd, 1, 0xff);
4228 /* all other commands */
4230 ata_scsi_set_sense(dev, cmd, ILLEGAL_REQUEST, 0x20, 0x0);
4231 /* "Invalid command operation code" */
4235 cmd->scsi_done(cmd);
4238 int ata_scsi_add_hosts(struct ata_host *host, struct scsi_host_template *sht)
4242 for (i = 0; i < host->n_ports; i++) {
4243 struct ata_port *ap = host->ports[i];
4244 struct Scsi_Host *shost;
4247 shost = scsi_host_alloc(sht, sizeof(struct ata_port *));
4251 shost->eh_noresume = 1;
4252 *(struct ata_port **)&shost->hostdata[0] = ap;
4253 ap->scsi_host = shost;
4255 shost->transportt = ata_scsi_transport_template;
4256 shost->unique_id = ap->print_id;
4259 shost->max_channel = 1;
4260 shost->max_cmd_len = 32;
4262 /* Schedule policy is determined by ->qc_defer()
4263 * callback and it needs to see every deferred qc.
4264 * Set host_blocked to 1 to prevent SCSI midlayer from
4265 * automatically deferring requests.
4267 shost->max_host_blocked = 1;
4269 rc = scsi_add_host_with_dma(shost, &ap->tdev, ap->host->dev);
4278 struct Scsi_Host *shost = host->ports[i]->scsi_host;
4280 /* scsi_host_put() is in ata_devres_release() */
4281 scsi_remove_host(shost);
4287 static void ata_scsi_assign_ofnode(struct ata_device *dev, struct ata_port *ap)
4289 struct scsi_device *sdev = dev->sdev;
4290 struct device *d = ap->host->dev;
4291 struct device_node *np = d->of_node;
4292 struct device_node *child;
4294 for_each_available_child_of_node(np, child) {
4298 ret = of_property_read_u32(child, "reg", &val);
4301 if (val == dev->devno) {
4302 dev_dbg(d, "found matching device node\n");
4303 sdev->sdev_gendev.of_node = child;
4309 static void ata_scsi_assign_ofnode(struct ata_device *dev, struct ata_port *ap)
4314 void ata_scsi_scan_host(struct ata_port *ap, int sync)
4317 struct ata_device *last_failed_dev = NULL;
4318 struct ata_link *link;
4319 struct ata_device *dev;
4322 ata_for_each_link(link, ap, EDGE) {
4323 ata_for_each_dev(dev, link, ENABLED) {
4324 struct scsi_device *sdev;
4325 int channel = 0, id = 0;
4330 if (ata_is_host_link(link))
4333 channel = link->pmp;
4335 sdev = __scsi_add_device(ap->scsi_host, channel, id, 0,
4337 if (!IS_ERR(sdev)) {
4339 ata_scsi_assign_ofnode(dev, ap);
4340 scsi_device_put(sdev);
4347 /* If we scanned while EH was in progress or allocation
4348 * failure occurred, scan would have failed silently. Check
4349 * whether all devices are attached.
4351 ata_for_each_link(link, ap, EDGE) {
4352 ata_for_each_dev(dev, link, ENABLED) {
4361 /* we're missing some SCSI devices */
4363 /* If caller requested synchrnous scan && we've made
4364 * any progress, sleep briefly and repeat.
4366 if (dev != last_failed_dev) {
4368 last_failed_dev = dev;
4372 /* We might be failing to detect boot device, give it
4373 * a few more chances.
4381 "WARNING: synchronous SCSI scan failed without making any progress, switching to async\n");
4384 queue_delayed_work(system_long_wq, &ap->hotplug_task,
4385 round_jiffies_relative(HZ));
4389 * ata_scsi_offline_dev - offline attached SCSI device
4390 * @dev: ATA device to offline attached SCSI device for
4392 * This function is called from ata_eh_hotplug() and responsible
4393 * for taking the SCSI device attached to @dev offline. This
4394 * function is called with host lock which protects dev->sdev
4398 * spin_lock_irqsave(host lock)
4401 * 1 if attached SCSI device exists, 0 otherwise.
4403 int ata_scsi_offline_dev(struct ata_device *dev)
4406 scsi_device_set_state(dev->sdev, SDEV_OFFLINE);
4413 * ata_scsi_remove_dev - remove attached SCSI device
4414 * @dev: ATA device to remove attached SCSI device for
4416 * This function is called from ata_eh_scsi_hotplug() and
4417 * responsible for removing the SCSI device attached to @dev.
4420 * Kernel thread context (may sleep).
4422 static void ata_scsi_remove_dev(struct ata_device *dev)
4424 struct ata_port *ap = dev->link->ap;
4425 struct scsi_device *sdev;
4426 unsigned long flags;
4428 /* Alas, we need to grab scan_mutex to ensure SCSI device
4429 * state doesn't change underneath us and thus
4430 * scsi_device_get() always succeeds. The mutex locking can
4431 * be removed if there is __scsi_device_get() interface which
4432 * increments reference counts regardless of device state.
4434 mutex_lock(&ap->scsi_host->scan_mutex);
4435 spin_lock_irqsave(ap->lock, flags);
4437 /* clearing dev->sdev is protected by host lock */
4442 /* If user initiated unplug races with us, sdev can go
4443 * away underneath us after the host lock and
4444 * scan_mutex are released. Hold onto it.
4446 if (scsi_device_get(sdev) == 0) {
4447 /* The following ensures the attached sdev is
4448 * offline on return from ata_scsi_offline_dev()
4449 * regardless it wins or loses the race
4450 * against this function.
4452 scsi_device_set_state(sdev, SDEV_OFFLINE);
4459 spin_unlock_irqrestore(ap->lock, flags);
4460 mutex_unlock(&ap->scsi_host->scan_mutex);
4463 ata_dev_info(dev, "detaching (SCSI %s)\n",
4464 dev_name(&sdev->sdev_gendev));
4466 scsi_remove_device(sdev);
4467 scsi_device_put(sdev);
4471 static void ata_scsi_handle_link_detach(struct ata_link *link)
4473 struct ata_port *ap = link->ap;
4474 struct ata_device *dev;
4476 ata_for_each_dev(dev, link, ALL) {
4477 unsigned long flags;
4479 if (!(dev->flags & ATA_DFLAG_DETACHED))
4482 spin_lock_irqsave(ap->lock, flags);
4483 dev->flags &= ~ATA_DFLAG_DETACHED;
4484 spin_unlock_irqrestore(ap->lock, flags);
4486 if (zpodd_dev_enabled(dev))
4489 ata_scsi_remove_dev(dev);
4494 * ata_scsi_media_change_notify - send media change event
4495 * @dev: Pointer to the disk device with media change event
4497 * Tell the block layer to send a media change notification
4501 * spin_lock_irqsave(host lock)
4503 void ata_scsi_media_change_notify(struct ata_device *dev)
4506 sdev_evt_send_simple(dev->sdev, SDEV_EVT_MEDIA_CHANGE,
4511 * ata_scsi_hotplug - SCSI part of hotplug
4512 * @work: Pointer to ATA port to perform SCSI hotplug on
4514 * Perform SCSI part of hotplug. It's executed from a separate
4515 * workqueue after EH completes. This is necessary because SCSI
4516 * hot plugging requires working EH and hot unplugging is
4517 * synchronized with hot plugging with a mutex.
4520 * Kernel thread context (may sleep).
4522 void ata_scsi_hotplug(struct work_struct *work)
4524 struct ata_port *ap =
4525 container_of(work, struct ata_port, hotplug_task.work);
4528 if (ap->pflags & ATA_PFLAG_UNLOADING) {
4529 DPRINTK("ENTER/EXIT - unloading\n");
4534 mutex_lock(&ap->scsi_scan_mutex);
4536 /* Unplug detached devices. We cannot use link iterator here
4537 * because PMP links have to be scanned even if PMP is
4538 * currently not attached. Iterate manually.
4540 ata_scsi_handle_link_detach(&ap->link);
4542 for (i = 0; i < SATA_PMP_MAX_PORTS; i++)
4543 ata_scsi_handle_link_detach(&ap->pmp_link[i]);
4545 /* scan for new ones */
4546 ata_scsi_scan_host(ap, 0);
4548 mutex_unlock(&ap->scsi_scan_mutex);
4553 * ata_scsi_user_scan - indication for user-initiated bus scan
4554 * @shost: SCSI host to scan
4555 * @channel: Channel to scan
4559 * This function is called when user explicitly requests bus
4560 * scan. Set probe pending flag and invoke EH.
4563 * SCSI layer (we don't care)
4568 int ata_scsi_user_scan(struct Scsi_Host *shost, unsigned int channel,
4569 unsigned int id, u64 lun)
4571 struct ata_port *ap = ata_shost_to_port(shost);
4572 unsigned long flags;
4575 if (!ap->ops->error_handler)
4578 if (lun != SCAN_WILD_CARD && lun)
4581 if (!sata_pmp_attached(ap)) {
4582 if (channel != SCAN_WILD_CARD && channel)
4586 if (id != SCAN_WILD_CARD && id)
4591 spin_lock_irqsave(ap->lock, flags);
4593 if (devno == SCAN_WILD_CARD) {
4594 struct ata_link *link;
4596 ata_for_each_link(link, ap, EDGE) {
4597 struct ata_eh_info *ehi = &link->eh_info;
4598 ehi->probe_mask |= ATA_ALL_DEVICES;
4599 ehi->action |= ATA_EH_RESET;
4602 struct ata_device *dev = ata_find_dev(ap, devno);
4605 struct ata_eh_info *ehi = &dev->link->eh_info;
4606 ehi->probe_mask |= 1 << dev->devno;
4607 ehi->action |= ATA_EH_RESET;
4613 ata_port_schedule_eh(ap);
4614 spin_unlock_irqrestore(ap->lock, flags);
4615 ata_port_wait_eh(ap);
4617 spin_unlock_irqrestore(ap->lock, flags);
4623 * ata_scsi_dev_rescan - initiate scsi_rescan_device()
4624 * @work: Pointer to ATA port to perform scsi_rescan_device()
4626 * After ATA pass thru (SAT) commands are executed successfully,
4627 * libata need to propagate the changes to SCSI layer.
4630 * Kernel thread context (may sleep).
4632 void ata_scsi_dev_rescan(struct work_struct *work)
4634 struct ata_port *ap =
4635 container_of(work, struct ata_port, scsi_rescan_task);
4636 struct ata_link *link;
4637 struct ata_device *dev;
4638 unsigned long flags;
4640 mutex_lock(&ap->scsi_scan_mutex);
4641 spin_lock_irqsave(ap->lock, flags);
4643 ata_for_each_link(link, ap, EDGE) {
4644 ata_for_each_dev(dev, link, ENABLED) {
4645 struct scsi_device *sdev = dev->sdev;
4649 if (scsi_device_get(sdev))
4652 spin_unlock_irqrestore(ap->lock, flags);
4653 scsi_rescan_device(&(sdev->sdev_gendev));
4654 scsi_device_put(sdev);
4655 spin_lock_irqsave(ap->lock, flags);
4659 spin_unlock_irqrestore(ap->lock, flags);
4660 mutex_unlock(&ap->scsi_scan_mutex);