2 * libata-scsi.c - helper library for ATA
4 * Maintained by: Jeff Garzik <jgarzik@pobox.com>
5 * Please ALWAYS copy linux-ide@vger.kernel.org
8 * Copyright 2003-2004 Red Hat, Inc. All rights reserved.
9 * Copyright 2003-2004 Jeff Garzik
12 * This program is free software; you can redistribute it and/or modify
13 * it under the terms of the GNU General Public License as published by
14 * the Free Software Foundation; either version 2, or (at your option)
17 * This program is distributed in the hope that it will be useful,
18 * but WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 * GNU General Public License for more details.
22 * You should have received a copy of the GNU General Public License
23 * along with this program; see the file COPYING. If not, write to
24 * the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
27 * libata documentation is available via 'make {ps|pdf}docs',
28 * as Documentation/DocBook/libata.*
30 * Hardware documentation available from
31 * - http://www.t10.org/
32 * - http://www.t13.org/
36 #include <linux/kernel.h>
37 #include <linux/blkdev.h>
38 #include <linux/spinlock.h>
39 #include <scsi/scsi.h>
40 #include <scsi/scsi_host.h>
41 #include <scsi/scsi_cmnd.h>
42 #include <scsi/scsi_eh.h>
43 #include <scsi/scsi_device.h>
44 #include <scsi/scsi_tcq.h>
45 #include <scsi/scsi_transport.h>
46 #include <linux/libata.h>
47 #include <linux/hdreg.h>
48 #include <linux/uaccess.h>
52 #define SECTOR_SIZE 512
54 typedef unsigned int (*ata_xlat_func_t)(struct ata_queued_cmd *qc);
56 static struct ata_device *__ata_scsi_find_dev(struct ata_port *ap,
57 const struct scsi_device *scsidev);
58 static struct ata_device *ata_scsi_find_dev(struct ata_port *ap,
59 const struct scsi_device *scsidev);
60 static int ata_scsi_user_scan(struct Scsi_Host *shost, unsigned int channel,
61 unsigned int id, unsigned int lun);
64 #define RW_RECOVERY_MPAGE 0x1
65 #define RW_RECOVERY_MPAGE_LEN 12
66 #define CACHE_MPAGE 0x8
67 #define CACHE_MPAGE_LEN 20
68 #define CONTROL_MPAGE 0xa
69 #define CONTROL_MPAGE_LEN 12
70 #define ALL_MPAGES 0x3f
71 #define ALL_SUB_MPAGES 0xff
74 static const u8 def_rw_recovery_mpage[RW_RECOVERY_MPAGE_LEN] = {
76 RW_RECOVERY_MPAGE_LEN - 2,
78 0, /* read retry count */
80 0, /* write retry count */
84 static const u8 def_cache_mpage[CACHE_MPAGE_LEN] = {
87 0, /* contains WCE, needs to be 0 for logic */
88 0, 0, 0, 0, 0, 0, 0, 0, 0,
89 0, /* contains DRA, needs to be 0 for logic */
93 static const u8 def_control_mpage[CONTROL_MPAGE_LEN] = {
95 CONTROL_MPAGE_LEN - 2,
96 2, /* DSENSE=0, GLTSD=1 */
97 0, /* [QAM+QERR may be 1, see 05-359r1] */
98 0, 0, 0, 0, 0xff, 0xff,
99 0, 30 /* extended self test time, see 05-359r1 */
103 * libata transport template. libata doesn't do real transport stuff.
104 * It just needs the eh_timed_out hook.
106 static struct scsi_transport_template ata_scsi_transport_template = {
107 .eh_strategy_handler = ata_scsi_error,
108 .eh_timed_out = ata_scsi_timed_out,
109 .user_scan = ata_scsi_user_scan,
113 static const struct {
116 } link_pm_policy[] = {
117 { NOT_AVAILABLE, "max_performance" },
118 { MIN_POWER, "min_power" },
119 { MAX_PERFORMANCE, "max_performance" },
120 { MEDIUM_POWER, "medium_power" },
123 static const char *ata_scsi_lpm_get(enum link_pm policy)
127 for (i = 0; i < ARRAY_SIZE(link_pm_policy); i++)
128 if (link_pm_policy[i].value == policy)
129 return link_pm_policy[i].name;
134 static ssize_t ata_scsi_lpm_put(struct class_device *class_dev,
135 const char *buf, size_t count)
137 struct Scsi_Host *shost = class_to_shost(class_dev);
138 struct ata_port *ap = ata_shost_to_port(shost);
139 enum link_pm policy = 0;
143 * we are skipping array location 0 on purpose - this
144 * is because a value of NOT_AVAILABLE is displayed
145 * to the user as max_performance, but when the user
146 * writes "max_performance", they actually want the
147 * value to match MAX_PERFORMANCE.
149 for (i = 1; i < ARRAY_SIZE(link_pm_policy); i++) {
150 const int len = strlen(link_pm_policy[i].name);
151 if (strncmp(link_pm_policy[i].name, buf, len) == 0 &&
153 policy = link_pm_policy[i].value;
160 ata_lpm_schedule(ap, policy);
165 ata_scsi_lpm_show(struct class_device *class_dev, char *buf)
167 struct Scsi_Host *shost = class_to_shost(class_dev);
168 struct ata_port *ap = ata_shost_to_port(shost);
170 ata_scsi_lpm_get(ap->pm_policy);
175 return snprintf(buf, 23, "%s\n", policy);
177 CLASS_DEVICE_ATTR(link_power_management_policy, S_IRUGO | S_IWUSR,
178 ata_scsi_lpm_show, ata_scsi_lpm_put);
179 EXPORT_SYMBOL_GPL(class_device_attr_link_power_management_policy);
181 static void ata_scsi_invalid_field(struct scsi_cmnd *cmd,
182 void (*done)(struct scsi_cmnd *))
184 ata_scsi_set_sense(cmd, ILLEGAL_REQUEST, 0x24, 0x0);
185 /* "Invalid field in cbd" */
190 * ata_std_bios_param - generic bios head/sector/cylinder calculator used by sd.
191 * @sdev: SCSI device for which BIOS geometry is to be determined
192 * @bdev: block device associated with @sdev
193 * @capacity: capacity of SCSI device
194 * @geom: location to which geometry will be output
196 * Generic bios head/sector/cylinder calculator
197 * used by sd. Most BIOSes nowadays expect a XXX/255/16 (CHS)
198 * mapping. Some situations may arise where the disk is not
199 * bootable if this is not used.
202 * Defined by the SCSI layer. We don't really care.
207 int ata_std_bios_param(struct scsi_device *sdev, struct block_device *bdev,
208 sector_t capacity, int geom[])
212 sector_div(capacity, 255*63);
219 * ata_get_identity - Handler for HDIO_GET_IDENTITY ioctl
220 * @sdev: SCSI device to get identify data for
221 * @arg: User buffer area for identify data
224 * Defined by the SCSI layer. We don't really care.
227 * Zero on success, negative errno on error.
229 static int ata_get_identity(struct scsi_device *sdev, void __user *arg)
231 struct ata_port *ap = ata_shost_to_port(sdev->host);
232 struct ata_device *dev = ata_scsi_find_dev(ap, sdev);
233 u16 __user *dst = arg;
239 if (copy_to_user(dst, dev->id, ATA_ID_WORDS * sizeof(u16)))
242 ata_id_string(dev->id, buf, ATA_ID_PROD, ATA_ID_PROD_LEN);
243 if (copy_to_user(dst + ATA_ID_PROD, buf, ATA_ID_PROD_LEN))
246 ata_id_string(dev->id, buf, ATA_ID_FW_REV, ATA_ID_FW_REV_LEN);
247 if (copy_to_user(dst + ATA_ID_FW_REV, buf, ATA_ID_FW_REV_LEN))
250 ata_id_string(dev->id, buf, ATA_ID_SERNO, ATA_ID_SERNO_LEN);
251 if (copy_to_user(dst + ATA_ID_SERNO, buf, ATA_ID_SERNO_LEN))
258 * ata_cmd_ioctl - Handler for HDIO_DRIVE_CMD ioctl
259 * @scsidev: Device to which we are issuing command
260 * @arg: User provided data for issuing command
263 * Defined by the SCSI layer. We don't really care.
266 * Zero on success, negative errno on error.
268 int ata_cmd_ioctl(struct scsi_device *scsidev, void __user *arg)
271 u8 scsi_cmd[MAX_COMMAND_SIZE];
272 u8 args[4], *argbuf = NULL, *sensebuf = NULL;
274 enum dma_data_direction data_dir;
280 if (copy_from_user(args, arg, sizeof(args)))
283 sensebuf = kzalloc(SCSI_SENSE_BUFFERSIZE, GFP_NOIO);
287 memset(scsi_cmd, 0, sizeof(scsi_cmd));
290 argsize = SECTOR_SIZE * args[3];
291 argbuf = kmalloc(argsize, GFP_KERNEL);
292 if (argbuf == NULL) {
297 scsi_cmd[1] = (4 << 1); /* PIO Data-in */
298 scsi_cmd[2] = 0x0e; /* no off.line or cc, read from dev,
299 block count in sector count field */
300 data_dir = DMA_FROM_DEVICE;
302 scsi_cmd[1] = (3 << 1); /* Non-data */
303 scsi_cmd[2] = 0x20; /* cc but no off.line or data xfer */
307 scsi_cmd[0] = ATA_16;
309 scsi_cmd[4] = args[2];
310 if (args[0] == WIN_SMART) { /* hack -- ide driver does this too... */
311 scsi_cmd[6] = args[3];
312 scsi_cmd[8] = args[1];
316 scsi_cmd[6] = args[1];
318 scsi_cmd[14] = args[0];
320 /* Good values for timeout and retries? Values below
321 from scsi_ioctl_send_command() for default case... */
322 cmd_result = scsi_execute(scsidev, scsi_cmd, data_dir, argbuf, argsize,
323 sensebuf, (10*HZ), 5, 0);
325 if (driver_byte(cmd_result) == DRIVER_SENSE) {/* sense data available */
326 u8 *desc = sensebuf + 8;
327 cmd_result &= ~(0xFF<<24); /* DRIVER_SENSE is not an error */
329 /* If we set cc then ATA pass-through will cause a
330 * check condition even if no error. Filter that. */
331 if (cmd_result & SAM_STAT_CHECK_CONDITION) {
332 struct scsi_sense_hdr sshdr;
333 scsi_normalize_sense(sensebuf, SCSI_SENSE_BUFFERSIZE,
335 if (sshdr.sense_key == 0 &&
336 sshdr.asc == 0 && sshdr.ascq == 0)
337 cmd_result &= ~SAM_STAT_CHECK_CONDITION;
340 /* Send userspace a few ATA registers (same as drivers/ide) */
341 if (sensebuf[0] == 0x72 && /* format is "descriptor" */
342 desc[0] == 0x09) { /* code is "ATA Descriptor" */
343 args[0] = desc[13]; /* status */
344 args[1] = desc[3]; /* error */
345 args[2] = desc[5]; /* sector count (0:7) */
346 if (copy_to_user(arg, args, sizeof(args)))
358 && copy_to_user(arg + sizeof(args), argbuf, argsize))
367 * ata_task_ioctl - Handler for HDIO_DRIVE_TASK ioctl
368 * @scsidev: Device to which we are issuing command
369 * @arg: User provided data for issuing command
372 * Defined by the SCSI layer. We don't really care.
375 * Zero on success, negative errno on error.
377 int ata_task_ioctl(struct scsi_device *scsidev, void __user *arg)
380 u8 scsi_cmd[MAX_COMMAND_SIZE];
381 u8 args[7], *sensebuf = NULL;
387 if (copy_from_user(args, arg, sizeof(args)))
390 sensebuf = kzalloc(SCSI_SENSE_BUFFERSIZE, GFP_NOIO);
394 memset(scsi_cmd, 0, sizeof(scsi_cmd));
395 scsi_cmd[0] = ATA_16;
396 scsi_cmd[1] = (3 << 1); /* Non-data */
397 scsi_cmd[2] = 0x20; /* cc but no off.line or data xfer */
398 scsi_cmd[4] = args[1];
399 scsi_cmd[6] = args[2];
400 scsi_cmd[8] = args[3];
401 scsi_cmd[10] = args[4];
402 scsi_cmd[12] = args[5];
403 scsi_cmd[13] = args[6] & 0x4f;
404 scsi_cmd[14] = args[0];
406 /* Good values for timeout and retries? Values below
407 from scsi_ioctl_send_command() for default case... */
408 cmd_result = scsi_execute(scsidev, scsi_cmd, DMA_NONE, NULL, 0,
409 sensebuf, (10*HZ), 5, 0);
411 if (driver_byte(cmd_result) == DRIVER_SENSE) {/* sense data available */
412 u8 *desc = sensebuf + 8;
413 cmd_result &= ~(0xFF<<24); /* DRIVER_SENSE is not an error */
415 /* If we set cc then ATA pass-through will cause a
416 * check condition even if no error. Filter that. */
417 if (cmd_result & SAM_STAT_CHECK_CONDITION) {
418 struct scsi_sense_hdr sshdr;
419 scsi_normalize_sense(sensebuf, SCSI_SENSE_BUFFERSIZE,
421 if (sshdr.sense_key == 0 &&
422 sshdr.asc == 0 && sshdr.ascq == 0)
423 cmd_result &= ~SAM_STAT_CHECK_CONDITION;
426 /* Send userspace ATA registers */
427 if (sensebuf[0] == 0x72 && /* format is "descriptor" */
428 desc[0] == 0x09) {/* code is "ATA Descriptor" */
429 args[0] = desc[13]; /* status */
430 args[1] = desc[3]; /* error */
431 args[2] = desc[5]; /* sector count (0:7) */
432 args[3] = desc[7]; /* lbal */
433 args[4] = desc[9]; /* lbam */
434 args[5] = desc[11]; /* lbah */
435 args[6] = desc[12]; /* select */
436 if (copy_to_user(arg, args, sizeof(args)))
451 int ata_scsi_ioctl(struct scsi_device *scsidev, int cmd, void __user *arg)
453 int val = -EINVAL, rc = -EINVAL;
456 case ATA_IOC_GET_IO32:
458 if (copy_to_user(arg, &val, 1))
462 case ATA_IOC_SET_IO32:
463 val = (unsigned long) arg;
468 case HDIO_GET_IDENTITY:
469 return ata_get_identity(scsidev, arg);
472 if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
474 return ata_cmd_ioctl(scsidev, arg);
476 case HDIO_DRIVE_TASK:
477 if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
479 return ata_task_ioctl(scsidev, arg);
490 * ata_scsi_qc_new - acquire new ata_queued_cmd reference
491 * @dev: ATA device to which the new command is attached
492 * @cmd: SCSI command that originated this ATA command
493 * @done: SCSI command completion function
495 * Obtain a reference to an unused ata_queued_cmd structure,
496 * which is the basic libata structure representing a single
497 * ATA command sent to the hardware.
499 * If a command was available, fill in the SCSI-specific
500 * portions of the structure with information on the
504 * spin_lock_irqsave(host lock)
507 * Command allocated, or %NULL if none available.
509 static struct ata_queued_cmd *ata_scsi_qc_new(struct ata_device *dev,
510 struct scsi_cmnd *cmd,
511 void (*done)(struct scsi_cmnd *))
513 struct ata_queued_cmd *qc;
515 qc = ata_qc_new_init(dev);
520 qc->sg = scsi_sglist(cmd);
521 qc->n_elem = scsi_sg_count(cmd);
523 cmd->result = (DID_OK << 16) | (QUEUE_FULL << 1);
531 * ata_dump_status - user friendly display of error info
532 * @id: id of the port in question
533 * @tf: ptr to filled out taskfile
535 * Decode and dump the ATA error/status registers for the user so
536 * that they have some idea what really happened at the non
537 * make-believe layer.
540 * inherited from caller
542 static void ata_dump_status(unsigned id, struct ata_taskfile *tf)
544 u8 stat = tf->command, err = tf->feature;
546 printk(KERN_WARNING "ata%u: status=0x%02x { ", id, stat);
547 if (stat & ATA_BUSY) {
548 printk("Busy }\n"); /* Data is not valid in this case */
550 if (stat & 0x40) printk("DriveReady ");
551 if (stat & 0x20) printk("DeviceFault ");
552 if (stat & 0x10) printk("SeekComplete ");
553 if (stat & 0x08) printk("DataRequest ");
554 if (stat & 0x04) printk("CorrectedError ");
555 if (stat & 0x02) printk("Index ");
556 if (stat & 0x01) printk("Error ");
560 printk(KERN_WARNING "ata%u: error=0x%02x { ", id, err);
561 if (err & 0x04) printk("DriveStatusError ");
563 if (err & 0x04) printk("BadCRC ");
564 else printk("Sector ");
566 if (err & 0x40) printk("UncorrectableError ");
567 if (err & 0x10) printk("SectorIdNotFound ");
568 if (err & 0x02) printk("TrackZeroNotFound ");
569 if (err & 0x01) printk("AddrMarkNotFound ");
576 * ata_to_sense_error - convert ATA error to SCSI error
577 * @id: ATA device number
578 * @drv_stat: value contained in ATA status register
579 * @drv_err: value contained in ATA error register
580 * @sk: the sense key we'll fill out
581 * @asc: the additional sense code we'll fill out
582 * @ascq: the additional sense code qualifier we'll fill out
583 * @verbose: be verbose
585 * Converts an ATA error into a SCSI error. Fill out pointers to
586 * SK, ASC, and ASCQ bytes for later use in fixed or descriptor
587 * format sense blocks.
590 * spin_lock_irqsave(host lock)
592 static void ata_to_sense_error(unsigned id, u8 drv_stat, u8 drv_err, u8 *sk,
593 u8 *asc, u8 *ascq, int verbose)
597 /* Based on the 3ware driver translation table */
598 static const unsigned char sense_table[][4] = {
600 {0xd1, ABORTED_COMMAND, 0x00, 0x00}, // Device busy Aborted command
602 {0xd0, ABORTED_COMMAND, 0x00, 0x00}, // Device busy Aborted command
604 {0x61, HARDWARE_ERROR, 0x00, 0x00}, // Device fault Hardware error
605 /* ICRC|ABRT */ /* NB: ICRC & !ABRT is BBD */
606 {0x84, ABORTED_COMMAND, 0x47, 0x00}, // Data CRC error SCSI parity error
607 /* MC|ID|ABRT|TRK0|MARK */
608 {0x37, NOT_READY, 0x04, 0x00}, // Unit offline Not ready
610 {0x09, NOT_READY, 0x04, 0x00}, // Unrecovered disk error Not ready
611 /* Bad address mark */
612 {0x01, MEDIUM_ERROR, 0x13, 0x00}, // Address mark not found Address mark not found for data field
614 {0x02, HARDWARE_ERROR, 0x00, 0x00}, // Track 0 not found Hardware error
616 {0x04, ABORTED_COMMAND, 0x00, 0x00}, // Aborted command Aborted command
617 /* Media change request */
618 {0x08, NOT_READY, 0x04, 0x00}, // Media change request FIXME: faking offline
620 {0x10, ABORTED_COMMAND, 0x14, 0x00}, // ID not found Recorded entity not found
622 {0x08, NOT_READY, 0x04, 0x00}, // Media change FIXME: faking offline
624 {0x40, MEDIUM_ERROR, 0x11, 0x04}, // Uncorrectable ECC error Unrecovered read error
625 /* BBD - block marked bad */
626 {0x80, MEDIUM_ERROR, 0x11, 0x04}, // Block marked bad Medium error, unrecovered read error
627 {0xFF, 0xFF, 0xFF, 0xFF}, // END mark
629 static const unsigned char stat_table[][4] = {
630 /* Must be first because BUSY means no other bits valid */
631 {0x80, ABORTED_COMMAND, 0x47, 0x00}, // Busy, fake parity for now
632 {0x20, HARDWARE_ERROR, 0x00, 0x00}, // Device fault
633 {0x08, ABORTED_COMMAND, 0x47, 0x00}, // Timed out in xfer, fake parity for now
634 {0x04, RECOVERED_ERROR, 0x11, 0x00}, // Recovered ECC error Medium error, recovered
635 {0xFF, 0xFF, 0xFF, 0xFF}, // END mark
639 * Is this an error we can process/parse
641 if (drv_stat & ATA_BUSY) {
642 drv_err = 0; /* Ignore the err bits, they're invalid */
646 /* Look for drv_err */
647 for (i = 0; sense_table[i][0] != 0xFF; i++) {
648 /* Look for best matches first */
649 if ((sense_table[i][0] & drv_err) ==
651 *sk = sense_table[i][1];
652 *asc = sense_table[i][2];
653 *ascq = sense_table[i][3];
657 /* No immediate match */
659 printk(KERN_WARNING "ata%u: no sense translation for "
660 "error 0x%02x\n", id, drv_err);
663 /* Fall back to interpreting status bits */
664 for (i = 0; stat_table[i][0] != 0xFF; i++) {
665 if (stat_table[i][0] & drv_stat) {
666 *sk = stat_table[i][1];
667 *asc = stat_table[i][2];
668 *ascq = stat_table[i][3];
672 /* No error? Undecoded? */
674 printk(KERN_WARNING "ata%u: no sense translation for "
675 "status: 0x%02x\n", id, drv_stat);
677 /* We need a sensible error return here, which is tricky, and one
678 that won't cause people to do things like return a disk wrongly */
679 *sk = ABORTED_COMMAND;
685 printk(KERN_ERR "ata%u: translated ATA stat/err 0x%02x/%02x "
686 "to SCSI SK/ASC/ASCQ 0x%x/%02x/%02x\n",
687 id, drv_stat, drv_err, *sk, *asc, *ascq);
692 * ata_gen_passthru_sense - Generate check condition sense block.
693 * @qc: Command that completed.
695 * This function is specific to the ATA descriptor format sense
696 * block specified for the ATA pass through commands. Regardless
697 * of whether the command errored or not, return a sense
698 * block. Copy all controller registers into the sense
699 * block. Clear sense key, ASC & ASCQ if there is no error.
704 static void ata_gen_passthru_sense(struct ata_queued_cmd *qc)
706 struct scsi_cmnd *cmd = qc->scsicmd;
707 struct ata_taskfile *tf = &qc->result_tf;
708 unsigned char *sb = cmd->sense_buffer;
709 unsigned char *desc = sb + 8;
710 int verbose = qc->ap->ops->error_handler == NULL;
712 memset(sb, 0, SCSI_SENSE_BUFFERSIZE);
714 cmd->result = (DRIVER_SENSE << 24) | SAM_STAT_CHECK_CONDITION;
717 * Use ata_to_sense_error() to map status register bits
718 * onto sense key, asc & ascq.
721 tf->command & (ATA_BUSY | ATA_DF | ATA_ERR | ATA_DRQ)) {
722 ata_to_sense_error(qc->ap->print_id, tf->command, tf->feature,
723 &sb[1], &sb[2], &sb[3], verbose);
728 * Sense data is current and format is descriptor.
734 /* set length of additional sense data */
739 * Copy registers into sense buffer.
742 desc[3] = tf->feature; /* == error reg */
747 desc[12] = tf->device;
748 desc[13] = tf->command; /* == status reg */
751 * Fill in Extend bit, and the high order bytes
754 if (tf->flags & ATA_TFLAG_LBA48) {
756 desc[4] = tf->hob_nsect;
757 desc[6] = tf->hob_lbal;
758 desc[8] = tf->hob_lbam;
759 desc[10] = tf->hob_lbah;
764 * ata_gen_ata_sense - generate a SCSI fixed sense block
765 * @qc: Command that we are erroring out
767 * Generate sense block for a failed ATA command @qc. Descriptor
768 * format is used to accomodate LBA48 block address.
773 static void ata_gen_ata_sense(struct ata_queued_cmd *qc)
775 struct ata_device *dev = qc->dev;
776 struct scsi_cmnd *cmd = qc->scsicmd;
777 struct ata_taskfile *tf = &qc->result_tf;
778 unsigned char *sb = cmd->sense_buffer;
779 unsigned char *desc = sb + 8;
780 int verbose = qc->ap->ops->error_handler == NULL;
783 memset(sb, 0, SCSI_SENSE_BUFFERSIZE);
785 cmd->result = (DRIVER_SENSE << 24) | SAM_STAT_CHECK_CONDITION;
787 /* sense data is current and format is descriptor */
790 /* Use ata_to_sense_error() to map status register bits
791 * onto sense key, asc & ascq.
794 tf->command & (ATA_BUSY | ATA_DF | ATA_ERR | ATA_DRQ)) {
795 ata_to_sense_error(qc->ap->print_id, tf->command, tf->feature,
796 &sb[1], &sb[2], &sb[3], verbose);
800 block = ata_tf_read_block(&qc->result_tf, dev);
802 /* information sense data descriptor */
807 desc[2] |= 0x80; /* valid */
808 desc[6] = block >> 40;
809 desc[7] = block >> 32;
810 desc[8] = block >> 24;
811 desc[9] = block >> 16;
812 desc[10] = block >> 8;
816 static void ata_scsi_sdev_config(struct scsi_device *sdev)
818 sdev->use_10_for_rw = 1;
819 sdev->use_10_for_ms = 1;
821 /* Schedule policy is determined by ->qc_defer() callback and
822 * it needs to see every deferred qc. Set dev_blocked to 1 to
823 * prevent SCSI midlayer from automatically deferring
826 sdev->max_device_blocked = 1;
830 * atapi_drain_needed - Check whether data transfer may overflow
831 * @rq: request to be checked
833 * ATAPI commands which transfer variable length data to host
834 * might overflow due to application error or hardare bug. This
835 * function checks whether overflow should be drained and ignored
842 * 1 if ; otherwise, 0.
844 static int atapi_drain_needed(struct request *rq)
846 if (likely(!blk_pc_request(rq)))
849 if (!rq->data_len || (rq->cmd_flags & REQ_RW))
852 return atapi_cmd_type(rq->cmd[0]) == ATAPI_MISC;
855 static int ata_scsi_dev_config(struct scsi_device *sdev,
856 struct ata_device *dev)
858 /* configure max sectors */
859 blk_queue_max_sectors(sdev->request_queue, dev->max_sectors);
861 if (dev->class == ATA_DEV_ATAPI) {
862 struct request_queue *q = sdev->request_queue;
865 /* set the min alignment */
866 blk_queue_update_dma_alignment(sdev->request_queue,
869 /* configure draining */
870 buf = kmalloc(ATAPI_MAX_DRAIN, q->bounce_gfp | GFP_KERNEL);
872 ata_dev_printk(dev, KERN_ERR,
873 "drain buffer allocation failed\n");
877 blk_queue_dma_drain(q, atapi_drain_needed, buf, ATAPI_MAX_DRAIN);
879 /* ATA devices must be sector aligned */
880 blk_queue_update_dma_alignment(sdev->request_queue,
882 sdev->manage_start_stop = 1;
885 if (dev->flags & ATA_DFLAG_AN)
886 set_bit(SDEV_EVT_MEDIA_CHANGE, sdev->supported_events);
888 if (dev->flags & ATA_DFLAG_NCQ) {
891 depth = min(sdev->host->can_queue, ata_id_queue_depth(dev->id));
892 depth = min(ATA_MAX_QUEUE - 1, depth);
893 scsi_adjust_queue_depth(sdev, MSG_SIMPLE_TAG, depth);
900 * ata_scsi_slave_config - Set SCSI device attributes
901 * @sdev: SCSI device to examine
903 * This is called before we actually start reading
904 * and writing to the device, to configure certain
905 * SCSI mid-layer behaviors.
908 * Defined by SCSI layer. We don't really care.
911 int ata_scsi_slave_config(struct scsi_device *sdev)
913 struct ata_port *ap = ata_shost_to_port(sdev->host);
914 struct ata_device *dev = __ata_scsi_find_dev(ap, sdev);
917 ata_scsi_sdev_config(sdev);
920 rc = ata_scsi_dev_config(sdev, dev);
926 * ata_scsi_slave_destroy - SCSI device is about to be destroyed
927 * @sdev: SCSI device to be destroyed
929 * @sdev is about to be destroyed for hot/warm unplugging. If
930 * this unplugging was initiated by libata as indicated by NULL
931 * dev->sdev, this function doesn't have to do anything.
932 * Otherwise, SCSI layer initiated warm-unplug is in progress.
933 * Clear dev->sdev, schedule the device for ATA detach and invoke
937 * Defined by SCSI layer. We don't really care.
939 void ata_scsi_slave_destroy(struct scsi_device *sdev)
941 struct ata_port *ap = ata_shost_to_port(sdev->host);
942 struct request_queue *q = sdev->request_queue;
944 struct ata_device *dev;
946 if (!ap->ops->error_handler)
949 spin_lock_irqsave(ap->lock, flags);
950 dev = __ata_scsi_find_dev(ap, sdev);
951 if (dev && dev->sdev) {
952 /* SCSI device already in CANCEL state, no need to offline it */
954 dev->flags |= ATA_DFLAG_DETACH;
955 ata_port_schedule_eh(ap);
957 spin_unlock_irqrestore(ap->lock, flags);
959 kfree(q->dma_drain_buffer);
960 q->dma_drain_buffer = NULL;
961 q->dma_drain_size = 0;
965 * ata_scsi_change_queue_depth - SCSI callback for queue depth config
966 * @sdev: SCSI device to configure queue depth for
967 * @queue_depth: new queue depth
969 * This is libata standard hostt->change_queue_depth callback.
970 * SCSI will call into this callback when user tries to set queue
974 * SCSI layer (we don't care)
977 * Newly configured queue depth.
979 int ata_scsi_change_queue_depth(struct scsi_device *sdev, int queue_depth)
981 struct ata_port *ap = ata_shost_to_port(sdev->host);
982 struct ata_device *dev;
985 if (queue_depth < 1 || queue_depth == sdev->queue_depth)
986 return sdev->queue_depth;
988 dev = ata_scsi_find_dev(ap, sdev);
989 if (!dev || !ata_dev_enabled(dev))
990 return sdev->queue_depth;
993 spin_lock_irqsave(ap->lock, flags);
994 dev->flags &= ~ATA_DFLAG_NCQ_OFF;
995 if (queue_depth == 1 || !ata_ncq_enabled(dev)) {
996 dev->flags |= ATA_DFLAG_NCQ_OFF;
999 spin_unlock_irqrestore(ap->lock, flags);
1001 /* limit and apply queue depth */
1002 queue_depth = min(queue_depth, sdev->host->can_queue);
1003 queue_depth = min(queue_depth, ata_id_queue_depth(dev->id));
1004 queue_depth = min(queue_depth, ATA_MAX_QUEUE - 1);
1006 if (sdev->queue_depth == queue_depth)
1009 scsi_adjust_queue_depth(sdev, MSG_SIMPLE_TAG, queue_depth);
1013 /* XXX: for spindown warning */
1014 static void ata_delayed_done_timerfn(unsigned long arg)
1016 struct scsi_cmnd *scmd = (void *)arg;
1018 scmd->scsi_done(scmd);
1021 /* XXX: for spindown warning */
1022 static void ata_delayed_done(struct scsi_cmnd *scmd)
1024 static struct timer_list timer;
1026 setup_timer(&timer, ata_delayed_done_timerfn, (unsigned long)scmd);
1027 mod_timer(&timer, jiffies + 5 * HZ);
1031 * ata_scsi_start_stop_xlat - Translate SCSI START STOP UNIT command
1032 * @qc: Storage for translated ATA taskfile
1034 * Sets up an ATA taskfile to issue STANDBY (to stop) or READ VERIFY
1035 * (to start). Perhaps these commands should be preceded by
1036 * CHECK POWER MODE to see what power mode the device is already in.
1037 * [See SAT revision 5 at www.t10.org]
1040 * spin_lock_irqsave(host lock)
1043 * Zero on success, non-zero on error.
1045 static unsigned int ata_scsi_start_stop_xlat(struct ata_queued_cmd *qc)
1047 struct scsi_cmnd *scmd = qc->scsicmd;
1048 struct ata_taskfile *tf = &qc->tf;
1049 const u8 *cdb = scmd->cmnd;
1051 if (scmd->cmd_len < 5)
1054 tf->flags |= ATA_TFLAG_DEVICE | ATA_TFLAG_ISADDR;
1055 tf->protocol = ATA_PROT_NODATA;
1057 ; /* ignore IMMED bit, violates sat-r05 */
1060 goto invalid_fld; /* LOEJ bit set not supported */
1061 if (((cdb[4] >> 4) & 0xf) != 0)
1062 goto invalid_fld; /* power conditions not supported */
1064 if (qc->dev->horkage & ATA_HORKAGE_SKIP_PM) {
1065 /* the device lacks PM support, finish without doing anything */
1066 scmd->result = SAM_STAT_GOOD;
1071 tf->nsect = 1; /* 1 sector, lba=0 */
1073 if (qc->dev->flags & ATA_DFLAG_LBA) {
1074 tf->flags |= ATA_TFLAG_LBA;
1079 tf->device |= ATA_LBA;
1082 tf->lbal = 0x1; /* sect */
1083 tf->lbam = 0x0; /* cyl low */
1084 tf->lbah = 0x0; /* cyl high */
1087 tf->command = ATA_CMD_VERIFY; /* READ VERIFY */
1089 /* XXX: This is for backward compatibility, will be
1090 * removed. Read Documentation/feature-removal-schedule.txt
1093 if ((qc->dev->flags & ATA_DFLAG_SPUNDOWN) &&
1094 (system_state == SYSTEM_HALT ||
1095 system_state == SYSTEM_POWER_OFF)) {
1096 static unsigned long warned;
1098 if (!test_and_set_bit(0, &warned)) {
1099 ata_dev_printk(qc->dev, KERN_WARNING,
1100 "DISK MIGHT NOT BE SPUN DOWN PROPERLY. "
1101 "UPDATE SHUTDOWN UTILITY\n");
1102 ata_dev_printk(qc->dev, KERN_WARNING,
1103 "For more info, visit "
1104 "http://linux-ata.org/shutdown.html\n");
1106 /* ->scsi_done is not used, use it for
1107 * delayed completion.
1109 scmd->scsi_done = qc->scsidone;
1110 qc->scsidone = ata_delayed_done;
1112 scmd->result = SAM_STAT_GOOD;
1116 /* Issue ATA STANDBY IMMEDIATE command */
1117 tf->command = ATA_CMD_STANDBYNOW1;
1121 * Standby and Idle condition timers could be implemented but that
1122 * would require libata to implement the Power condition mode page
1123 * and allow the user to change it. Changing mode pages requires
1124 * MODE SELECT to be implemented.
1130 ata_scsi_set_sense(scmd, ILLEGAL_REQUEST, 0x24, 0x0);
1131 /* "Invalid field in cbd" */
1137 * ata_scsi_flush_xlat - Translate SCSI SYNCHRONIZE CACHE command
1138 * @qc: Storage for translated ATA taskfile
1140 * Sets up an ATA taskfile to issue FLUSH CACHE or
1144 * spin_lock_irqsave(host lock)
1147 * Zero on success, non-zero on error.
1149 static unsigned int ata_scsi_flush_xlat(struct ata_queued_cmd *qc)
1151 struct ata_taskfile *tf = &qc->tf;
1153 tf->flags |= ATA_TFLAG_DEVICE;
1154 tf->protocol = ATA_PROT_NODATA;
1156 if (qc->dev->flags & ATA_DFLAG_FLUSH_EXT)
1157 tf->command = ATA_CMD_FLUSH_EXT;
1159 tf->command = ATA_CMD_FLUSH;
1161 /* flush is critical for IO integrity, consider it an IO command */
1162 qc->flags |= ATA_QCFLAG_IO;
1168 * scsi_6_lba_len - Get LBA and transfer length
1169 * @cdb: SCSI command to translate
1171 * Calculate LBA and transfer length for 6-byte commands.
1175 * @plen: the transfer length
1177 static void scsi_6_lba_len(const u8 *cdb, u64 *plba, u32 *plen)
1182 VPRINTK("six-byte command\n");
1184 lba |= ((u64)(cdb[1] & 0x1f)) << 16;
1185 lba |= ((u64)cdb[2]) << 8;
1186 lba |= ((u64)cdb[3]);
1195 * scsi_10_lba_len - Get LBA and transfer length
1196 * @cdb: SCSI command to translate
1198 * Calculate LBA and transfer length for 10-byte commands.
1202 * @plen: the transfer length
1204 static void scsi_10_lba_len(const u8 *cdb, u64 *plba, u32 *plen)
1209 VPRINTK("ten-byte command\n");
1211 lba |= ((u64)cdb[2]) << 24;
1212 lba |= ((u64)cdb[3]) << 16;
1213 lba |= ((u64)cdb[4]) << 8;
1214 lba |= ((u64)cdb[5]);
1216 len |= ((u32)cdb[7]) << 8;
1217 len |= ((u32)cdb[8]);
1224 * scsi_16_lba_len - Get LBA and transfer length
1225 * @cdb: SCSI command to translate
1227 * Calculate LBA and transfer length for 16-byte commands.
1231 * @plen: the transfer length
1233 static void scsi_16_lba_len(const u8 *cdb, u64 *plba, u32 *plen)
1238 VPRINTK("sixteen-byte command\n");
1240 lba |= ((u64)cdb[2]) << 56;
1241 lba |= ((u64)cdb[3]) << 48;
1242 lba |= ((u64)cdb[4]) << 40;
1243 lba |= ((u64)cdb[5]) << 32;
1244 lba |= ((u64)cdb[6]) << 24;
1245 lba |= ((u64)cdb[7]) << 16;
1246 lba |= ((u64)cdb[8]) << 8;
1247 lba |= ((u64)cdb[9]);
1249 len |= ((u32)cdb[10]) << 24;
1250 len |= ((u32)cdb[11]) << 16;
1251 len |= ((u32)cdb[12]) << 8;
1252 len |= ((u32)cdb[13]);
1259 * ata_scsi_verify_xlat - Translate SCSI VERIFY command into an ATA one
1260 * @qc: Storage for translated ATA taskfile
1262 * Converts SCSI VERIFY command to an ATA READ VERIFY command.
1265 * spin_lock_irqsave(host lock)
1268 * Zero on success, non-zero on error.
1270 static unsigned int ata_scsi_verify_xlat(struct ata_queued_cmd *qc)
1272 struct scsi_cmnd *scmd = qc->scsicmd;
1273 struct ata_taskfile *tf = &qc->tf;
1274 struct ata_device *dev = qc->dev;
1275 u64 dev_sectors = qc->dev->n_sectors;
1276 const u8 *cdb = scmd->cmnd;
1280 tf->flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
1281 tf->protocol = ATA_PROT_NODATA;
1283 if (cdb[0] == VERIFY) {
1284 if (scmd->cmd_len < 10)
1286 scsi_10_lba_len(cdb, &block, &n_block);
1287 } else if (cdb[0] == VERIFY_16) {
1288 if (scmd->cmd_len < 16)
1290 scsi_16_lba_len(cdb, &block, &n_block);
1296 if (block >= dev_sectors)
1298 if ((block + n_block) > dev_sectors)
1301 if (dev->flags & ATA_DFLAG_LBA) {
1302 tf->flags |= ATA_TFLAG_LBA;
1304 if (lba_28_ok(block, n_block)) {
1306 tf->command = ATA_CMD_VERIFY;
1307 tf->device |= (block >> 24) & 0xf;
1308 } else if (lba_48_ok(block, n_block)) {
1309 if (!(dev->flags & ATA_DFLAG_LBA48))
1313 tf->flags |= ATA_TFLAG_LBA48;
1314 tf->command = ATA_CMD_VERIFY_EXT;
1316 tf->hob_nsect = (n_block >> 8) & 0xff;
1318 tf->hob_lbah = (block >> 40) & 0xff;
1319 tf->hob_lbam = (block >> 32) & 0xff;
1320 tf->hob_lbal = (block >> 24) & 0xff;
1322 /* request too large even for LBA48 */
1325 tf->nsect = n_block & 0xff;
1327 tf->lbah = (block >> 16) & 0xff;
1328 tf->lbam = (block >> 8) & 0xff;
1329 tf->lbal = block & 0xff;
1331 tf->device |= ATA_LBA;
1334 u32 sect, head, cyl, track;
1336 if (!lba_28_ok(block, n_block))
1339 /* Convert LBA to CHS */
1340 track = (u32)block / dev->sectors;
1341 cyl = track / dev->heads;
1342 head = track % dev->heads;
1343 sect = (u32)block % dev->sectors + 1;
1345 DPRINTK("block %u track %u cyl %u head %u sect %u\n",
1346 (u32)block, track, cyl, head, sect);
1348 /* Check whether the converted CHS can fit.
1352 if ((cyl >> 16) || (head >> 4) || (sect >> 8) || (!sect))
1355 tf->command = ATA_CMD_VERIFY;
1356 tf->nsect = n_block & 0xff; /* Sector count 0 means 256 sectors */
1359 tf->lbah = cyl >> 8;
1366 ata_scsi_set_sense(scmd, ILLEGAL_REQUEST, 0x24, 0x0);
1367 /* "Invalid field in cbd" */
1371 ata_scsi_set_sense(scmd, ILLEGAL_REQUEST, 0x21, 0x0);
1372 /* "Logical Block Address out of range" */
1376 scmd->result = SAM_STAT_GOOD;
1381 * ata_scsi_rw_xlat - Translate SCSI r/w command into an ATA one
1382 * @qc: Storage for translated ATA taskfile
1384 * Converts any of six SCSI read/write commands into the
1385 * ATA counterpart, including starting sector (LBA),
1386 * sector count, and taking into account the device's LBA48
1389 * Commands %READ_6, %READ_10, %READ_16, %WRITE_6, %WRITE_10, and
1390 * %WRITE_16 are currently supported.
1393 * spin_lock_irqsave(host lock)
1396 * Zero on success, non-zero on error.
1398 static unsigned int ata_scsi_rw_xlat(struct ata_queued_cmd *qc)
1400 struct scsi_cmnd *scmd = qc->scsicmd;
1401 const u8 *cdb = scmd->cmnd;
1402 unsigned int tf_flags = 0;
1407 if (cdb[0] == WRITE_10 || cdb[0] == WRITE_6 || cdb[0] == WRITE_16)
1408 tf_flags |= ATA_TFLAG_WRITE;
1410 /* Calculate the SCSI LBA, transfer length and FUA. */
1414 if (unlikely(scmd->cmd_len < 10))
1416 scsi_10_lba_len(cdb, &block, &n_block);
1417 if (unlikely(cdb[1] & (1 << 3)))
1418 tf_flags |= ATA_TFLAG_FUA;
1422 if (unlikely(scmd->cmd_len < 6))
1424 scsi_6_lba_len(cdb, &block, &n_block);
1426 /* for 6-byte r/w commands, transfer length 0
1427 * means 256 blocks of data, not 0 block.
1434 if (unlikely(scmd->cmd_len < 16))
1436 scsi_16_lba_len(cdb, &block, &n_block);
1437 if (unlikely(cdb[1] & (1 << 3)))
1438 tf_flags |= ATA_TFLAG_FUA;
1441 DPRINTK("no-byte command\n");
1445 /* Check and compose ATA command */
1447 /* For 10-byte and 16-byte SCSI R/W commands, transfer
1448 * length 0 means transfer 0 block of data.
1449 * However, for ATA R/W commands, sector count 0 means
1450 * 256 or 65536 sectors, not 0 sectors as in SCSI.
1452 * WARNING: one or two older ATA drives treat 0 as 0...
1456 qc->flags |= ATA_QCFLAG_IO;
1457 qc->nbytes = n_block * ATA_SECT_SIZE;
1459 rc = ata_build_rw_tf(&qc->tf, qc->dev, block, n_block, tf_flags,
1461 if (likely(rc == 0))
1466 /* treat all other errors as -EINVAL, fall through */
1468 ata_scsi_set_sense(scmd, ILLEGAL_REQUEST, 0x24, 0x0);
1469 /* "Invalid field in cbd" */
1473 ata_scsi_set_sense(scmd, ILLEGAL_REQUEST, 0x21, 0x0);
1474 /* "Logical Block Address out of range" */
1478 scmd->result = SAM_STAT_GOOD;
1482 static void ata_scsi_qc_complete(struct ata_queued_cmd *qc)
1484 struct ata_port *ap = qc->ap;
1485 struct scsi_cmnd *cmd = qc->scsicmd;
1486 u8 *cdb = cmd->cmnd;
1487 int need_sense = (qc->err_mask != 0);
1489 /* For ATA pass thru (SAT) commands, generate a sense block if
1490 * user mandated it or if there's an error. Note that if we
1491 * generate because the user forced us to, a check condition
1492 * is generated and the ATA register values are returned
1493 * whether the command completed successfully or not. If there
1494 * was no error, SK, ASC and ASCQ will all be zero.
1496 if (((cdb[0] == ATA_16) || (cdb[0] == ATA_12)) &&
1497 ((cdb[2] & 0x20) || need_sense)) {
1498 ata_gen_passthru_sense(qc);
1501 cmd->result = SAM_STAT_GOOD;
1503 /* TODO: decide which descriptor format to use
1504 * for 48b LBA devices and call that here
1505 * instead of the fixed desc, which is only
1506 * good for smaller LBA (and maybe CHS?)
1509 ata_gen_ata_sense(qc);
1513 /* XXX: track spindown state for spindown skipping and warning */
1514 if (unlikely(qc->tf.command == ATA_CMD_STANDBY ||
1515 qc->tf.command == ATA_CMD_STANDBYNOW1))
1516 qc->dev->flags |= ATA_DFLAG_SPUNDOWN;
1517 else if (likely(system_state != SYSTEM_HALT &&
1518 system_state != SYSTEM_POWER_OFF))
1519 qc->dev->flags &= ~ATA_DFLAG_SPUNDOWN;
1521 if (need_sense && !ap->ops->error_handler)
1522 ata_dump_status(ap->print_id, &qc->result_tf);
1530 * ata_scsi_translate - Translate then issue SCSI command to ATA device
1531 * @dev: ATA device to which the command is addressed
1532 * @cmd: SCSI command to execute
1533 * @done: SCSI command completion function
1534 * @xlat_func: Actor which translates @cmd to an ATA taskfile
1536 * Our ->queuecommand() function has decided that the SCSI
1537 * command issued can be directly translated into an ATA
1538 * command, rather than handled internally.
1540 * This function sets up an ata_queued_cmd structure for the
1541 * SCSI command, and sends that ata_queued_cmd to the hardware.
1543 * The xlat_func argument (actor) returns 0 if ready to execute
1544 * ATA command, else 1 to finish translation. If 1 is returned
1545 * then cmd->result (and possibly cmd->sense_buffer) are assumed
1546 * to be set reflecting an error condition or clean (early)
1550 * spin_lock_irqsave(host lock)
1553 * 0 on success, SCSI_ML_QUEUE_DEVICE_BUSY if the command
1554 * needs to be deferred.
1556 static int ata_scsi_translate(struct ata_device *dev, struct scsi_cmnd *cmd,
1557 void (*done)(struct scsi_cmnd *),
1558 ata_xlat_func_t xlat_func)
1560 struct ata_port *ap = dev->link->ap;
1561 struct ata_queued_cmd *qc;
1566 qc = ata_scsi_qc_new(dev, cmd, done);
1570 /* data is present; dma-map it */
1571 if (cmd->sc_data_direction == DMA_FROM_DEVICE ||
1572 cmd->sc_data_direction == DMA_TO_DEVICE) {
1573 if (unlikely(scsi_bufflen(cmd) < 1)) {
1574 ata_dev_printk(dev, KERN_WARNING,
1575 "WARNING: zero len r/w req\n");
1579 ata_sg_init(qc, scsi_sglist(cmd), scsi_sg_count(cmd));
1581 qc->dma_dir = cmd->sc_data_direction;
1584 qc->complete_fn = ata_scsi_qc_complete;
1589 if (ap->ops->qc_defer) {
1590 if ((rc = ap->ops->qc_defer(qc)))
1594 /* select device, send command to hardware */
1603 DPRINTK("EXIT - early finish (good or error)\n");
1608 cmd->result = (DID_ERROR << 16);
1611 DPRINTK("EXIT - internal\n");
1616 DPRINTK("EXIT - defer\n");
1617 if (rc == ATA_DEFER_LINK)
1618 return SCSI_MLQUEUE_DEVICE_BUSY;
1620 return SCSI_MLQUEUE_HOST_BUSY;
1624 * ata_scsi_rbuf_get - Map response buffer.
1625 * @cmd: SCSI command containing buffer to be mapped.
1626 * @buf_out: Pointer to mapped area.
1628 * Maps buffer contained within SCSI command @cmd.
1631 * spin_lock_irqsave(host lock)
1634 * Length of response buffer.
1637 static unsigned int ata_scsi_rbuf_get(struct scsi_cmnd *cmd, u8 **buf_out)
1640 unsigned int buflen;
1642 struct scatterlist *sg = scsi_sglist(cmd);
1645 buf = kmap_atomic(sg_page(sg), KM_IRQ0) + sg->offset;
1646 buflen = sg->length;
1657 * ata_scsi_rbuf_put - Unmap response buffer.
1658 * @cmd: SCSI command containing buffer to be unmapped.
1659 * @buf: buffer to unmap
1661 * Unmaps response buffer contained within @cmd.
1664 * spin_lock_irqsave(host lock)
1667 static inline void ata_scsi_rbuf_put(struct scsi_cmnd *cmd, u8 *buf)
1669 struct scatterlist *sg = scsi_sglist(cmd);
1671 kunmap_atomic(buf - sg->offset, KM_IRQ0);
1675 * ata_scsi_rbuf_fill - wrapper for SCSI command simulators
1676 * @args: device IDENTIFY data / SCSI command of interest.
1677 * @actor: Callback hook for desired SCSI command simulator
1679 * Takes care of the hard work of simulating a SCSI command...
1680 * Mapping the response buffer, calling the command's handler,
1681 * and handling the handler's return value. This return value
1682 * indicates whether the handler wishes the SCSI command to be
1683 * completed successfully (0), or not (in which case cmd->result
1684 * and sense buffer are assumed to be set).
1687 * spin_lock_irqsave(host lock)
1690 void ata_scsi_rbuf_fill(struct ata_scsi_args *args,
1691 unsigned int (*actor) (struct ata_scsi_args *args,
1692 u8 *rbuf, unsigned int buflen))
1695 unsigned int buflen, rc;
1696 struct scsi_cmnd *cmd = args->cmd;
1697 unsigned long flags;
1699 local_irq_save(flags);
1701 buflen = ata_scsi_rbuf_get(cmd, &rbuf);
1702 memset(rbuf, 0, buflen);
1703 rc = actor(args, rbuf, buflen);
1704 ata_scsi_rbuf_put(cmd, rbuf);
1706 local_irq_restore(flags);
1709 cmd->result = SAM_STAT_GOOD;
1714 * ATA_SCSI_RBUF_SET - helper to set values in SCSI response buffer
1715 * @idx: byte index into SCSI response buffer
1716 * @val: value to set
1718 * To be used by SCSI command simulator functions. This macros
1719 * expects two local variables, u8 *rbuf and unsigned int buflen,
1725 #define ATA_SCSI_RBUF_SET(idx, val) do { \
1726 if ((idx) < buflen) rbuf[(idx)] = (u8)(val); \
1730 * ata_scsiop_inq_std - Simulate INQUIRY command
1731 * @args: device IDENTIFY data / SCSI command of interest.
1732 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1733 * @buflen: Response buffer length.
1735 * Returns standard device identification data associated
1736 * with non-VPD INQUIRY command output.
1739 * spin_lock_irqsave(host lock)
1742 unsigned int ata_scsiop_inq_std(struct ata_scsi_args *args, u8 *rbuf,
1743 unsigned int buflen)
1748 0x5, /* claim SPC-3 version compatibility */
1753 /* set scsi removeable (RMB) bit per ata bit */
1754 if (ata_id_removeable(args->id))
1759 memcpy(rbuf, hdr, sizeof(hdr));
1762 memcpy(&rbuf[8], "ATA ", 8);
1763 ata_id_string(args->id, &rbuf[16], ATA_ID_PROD, 16);
1764 ata_id_string(args->id, &rbuf[32], ATA_ID_FW_REV, 4);
1765 if (rbuf[32] == 0 || rbuf[32] == ' ')
1766 memcpy(&rbuf[32], "n/a ", 4);
1770 const u8 versions[] = {
1771 0x60, /* SAM-3 (no version claimed) */
1774 0x20, /* SBC-2 (no version claimed) */
1777 0x60 /* SPC-3 (no version claimed) */
1780 memcpy(rbuf + 59, versions, sizeof(versions));
1787 * ata_scsiop_inq_00 - Simulate INQUIRY VPD page 0, list of pages
1788 * @args: device IDENTIFY data / SCSI command of interest.
1789 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1790 * @buflen: Response buffer length.
1792 * Returns list of inquiry VPD pages available.
1795 * spin_lock_irqsave(host lock)
1798 unsigned int ata_scsiop_inq_00(struct ata_scsi_args *args, u8 *rbuf,
1799 unsigned int buflen)
1801 const u8 pages[] = {
1802 0x00, /* page 0x00, this page */
1803 0x80, /* page 0x80, unit serial no page */
1804 0x83 /* page 0x83, device ident page */
1806 rbuf[3] = sizeof(pages); /* number of supported VPD pages */
1809 memcpy(rbuf + 4, pages, sizeof(pages));
1815 * ata_scsiop_inq_80 - Simulate INQUIRY VPD page 80, device serial number
1816 * @args: device IDENTIFY data / SCSI command of interest.
1817 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1818 * @buflen: Response buffer length.
1820 * Returns ATA device serial number.
1823 * spin_lock_irqsave(host lock)
1826 unsigned int ata_scsiop_inq_80(struct ata_scsi_args *args, u8 *rbuf,
1827 unsigned int buflen)
1831 0x80, /* this page code */
1833 ATA_ID_SERNO_LEN, /* page len */
1835 memcpy(rbuf, hdr, sizeof(hdr));
1837 if (buflen > (ATA_ID_SERNO_LEN + 4 - 1))
1838 ata_id_string(args->id, (unsigned char *) &rbuf[4],
1839 ATA_ID_SERNO, ATA_ID_SERNO_LEN);
1845 * ata_scsiop_inq_83 - Simulate INQUIRY VPD page 83, device identity
1846 * @args: device IDENTIFY data / SCSI command of interest.
1847 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1848 * @buflen: Response buffer length.
1850 * Yields two logical unit device identification designators:
1851 * - vendor specific ASCII containing the ATA serial number
1852 * - SAT defined "t10 vendor id based" containing ASCII vendor
1853 * name ("ATA "), model and serial numbers.
1856 * spin_lock_irqsave(host lock)
1859 unsigned int ata_scsiop_inq_83(struct ata_scsi_args *args, u8 *rbuf,
1860 unsigned int buflen)
1863 const int sat_model_serial_desc_len = 68;
1865 rbuf[1] = 0x83; /* this page code */
1868 if (buflen > (ATA_ID_SERNO_LEN + num + 3)) {
1869 /* piv=0, assoc=lu, code_set=ACSII, designator=vendor */
1871 rbuf[num + 3] = ATA_ID_SERNO_LEN;
1873 ata_id_string(args->id, (unsigned char *) rbuf + num,
1874 ATA_ID_SERNO, ATA_ID_SERNO_LEN);
1875 num += ATA_ID_SERNO_LEN;
1877 if (buflen > (sat_model_serial_desc_len + num + 3)) {
1878 /* SAT defined lu model and serial numbers descriptor */
1879 /* piv=0, assoc=lu, code_set=ACSII, designator=t10 vendor id */
1882 rbuf[num + 3] = sat_model_serial_desc_len;
1884 memcpy(rbuf + num, "ATA ", 8);
1886 ata_id_string(args->id, (unsigned char *) rbuf + num,
1887 ATA_ID_PROD, ATA_ID_PROD_LEN);
1888 num += ATA_ID_PROD_LEN;
1889 ata_id_string(args->id, (unsigned char *) rbuf + num,
1890 ATA_ID_SERNO, ATA_ID_SERNO_LEN);
1891 num += ATA_ID_SERNO_LEN;
1893 rbuf[3] = num - 4; /* page len (assume less than 256 bytes) */
1898 * ata_scsiop_inq_89 - Simulate INQUIRY VPD page 89, ATA info
1899 * @args: device IDENTIFY data / SCSI command of interest.
1900 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1901 * @buflen: Response buffer length.
1903 * Yields SAT-specified ATA VPD page.
1906 * spin_lock_irqsave(host lock)
1909 static unsigned int ata_scsiop_inq_89(struct ata_scsi_args *args, u8 *rbuf,
1910 unsigned int buflen)
1913 struct ata_taskfile tf;
1919 memset(&pbuf, 0, sizeof(pbuf));
1920 memset(&tf, 0, sizeof(tf));
1922 pbuf[1] = 0x89; /* our page code */
1923 pbuf[2] = (0x238 >> 8); /* page size fixed at 238h */
1924 pbuf[3] = (0x238 & 0xff);
1926 memcpy(&pbuf[8], "linux ", 8);
1927 memcpy(&pbuf[16], "libata ", 16);
1928 memcpy(&pbuf[32], DRV_VERSION, 4);
1929 ata_id_string(args->id, &pbuf[32], ATA_ID_FW_REV, 4);
1931 /* we don't store the ATA device signature, so we fake it */
1933 tf.command = ATA_DRDY; /* really, this is Status reg */
1937 ata_tf_to_fis(&tf, 0, 1, &pbuf[36]); /* TODO: PMP? */
1938 pbuf[36] = 0x34; /* force D2H Reg FIS (34h) */
1940 pbuf[56] = ATA_CMD_ID_ATA;
1942 i = min(buflen, 60U);
1943 memcpy(rbuf, &pbuf[0], i);
1949 memcpy(&rbuf[60], &args->id[0], min(buflen, 512U));
1954 * ata_scsiop_noop - Command handler that simply returns success.
1955 * @args: device IDENTIFY data / SCSI command of interest.
1956 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1957 * @buflen: Response buffer length.
1959 * No operation. Simply returns success to caller, to indicate
1960 * that the caller should successfully complete this SCSI command.
1963 * spin_lock_irqsave(host lock)
1966 unsigned int ata_scsiop_noop(struct ata_scsi_args *args, u8 *rbuf,
1967 unsigned int buflen)
1974 * ata_msense_push - Push data onto MODE SENSE data output buffer
1975 * @ptr_io: (input/output) Location to store more output data
1976 * @last: End of output data buffer
1977 * @buf: Pointer to BLOB being added to output buffer
1978 * @buflen: Length of BLOB
1980 * Store MODE SENSE data on an output buffer.
1986 static void ata_msense_push(u8 **ptr_io, const u8 *last,
1987 const u8 *buf, unsigned int buflen)
1991 if ((ptr + buflen - 1) > last)
1994 memcpy(ptr, buf, buflen);
2002 * ata_msense_caching - Simulate MODE SENSE caching info page
2003 * @id: device IDENTIFY data
2004 * @ptr_io: (input/output) Location to store more output data
2005 * @last: End of output data buffer
2007 * Generate a caching info page, which conditionally indicates
2008 * write caching to the SCSI layer, depending on device
2015 static unsigned int ata_msense_caching(u16 *id, u8 **ptr_io,
2018 u8 page[CACHE_MPAGE_LEN];
2020 memcpy(page, def_cache_mpage, sizeof(page));
2021 if (ata_id_wcache_enabled(id))
2022 page[2] |= (1 << 2); /* write cache enable */
2023 if (!ata_id_rahead_enabled(id))
2024 page[12] |= (1 << 5); /* disable read ahead */
2026 ata_msense_push(ptr_io, last, page, sizeof(page));
2027 return sizeof(page);
2031 * ata_msense_ctl_mode - Simulate MODE SENSE control mode page
2032 * @dev: Device associated with this MODE SENSE command
2033 * @ptr_io: (input/output) Location to store more output data
2034 * @last: End of output data buffer
2036 * Generate a generic MODE SENSE control mode page.
2042 static unsigned int ata_msense_ctl_mode(u8 **ptr_io, const u8 *last)
2044 ata_msense_push(ptr_io, last, def_control_mpage,
2045 sizeof(def_control_mpage));
2046 return sizeof(def_control_mpage);
2050 * ata_msense_rw_recovery - Simulate MODE SENSE r/w error recovery page
2051 * @dev: Device associated with this MODE SENSE command
2052 * @ptr_io: (input/output) Location to store more output data
2053 * @last: End of output data buffer
2055 * Generate a generic MODE SENSE r/w error recovery page.
2061 static unsigned int ata_msense_rw_recovery(u8 **ptr_io, const u8 *last)
2064 ata_msense_push(ptr_io, last, def_rw_recovery_mpage,
2065 sizeof(def_rw_recovery_mpage));
2066 return sizeof(def_rw_recovery_mpage);
2070 * We can turn this into a real blacklist if it's needed, for now just
2071 * blacklist any Maxtor BANC1G10 revision firmware
2073 static int ata_dev_supports_fua(u16 *id)
2075 unsigned char model[ATA_ID_PROD_LEN + 1], fw[ATA_ID_FW_REV_LEN + 1];
2079 if (!ata_id_has_fua(id))
2082 ata_id_c_string(id, model, ATA_ID_PROD, sizeof(model));
2083 ata_id_c_string(id, fw, ATA_ID_FW_REV, sizeof(fw));
2085 if (strcmp(model, "Maxtor"))
2087 if (strcmp(fw, "BANC1G10"))
2090 return 0; /* blacklisted */
2094 * ata_scsiop_mode_sense - Simulate MODE SENSE 6, 10 commands
2095 * @args: device IDENTIFY data / SCSI command of interest.
2096 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2097 * @buflen: Response buffer length.
2099 * Simulate MODE SENSE commands. Assume this is invoked for direct
2100 * access devices (e.g. disks) only. There should be no block
2101 * descriptor for other device types.
2104 * spin_lock_irqsave(host lock)
2107 unsigned int ata_scsiop_mode_sense(struct ata_scsi_args *args, u8 *rbuf,
2108 unsigned int buflen)
2110 struct ata_device *dev = args->dev;
2111 u8 *scsicmd = args->cmd->cmnd, *p, *last;
2112 const u8 sat_blk_desc[] = {
2113 0, 0, 0, 0, /* number of blocks: sat unspecified */
2115 0, 0x2, 0x0 /* block length: 512 bytes */
2118 unsigned int ebd, page_control, six_byte, output_len, alloc_len, minlen;
2123 six_byte = (scsicmd[0] == MODE_SENSE);
2124 ebd = !(scsicmd[1] & 0x8); /* dbd bit inverted == edb */
2126 * LLBA bit in msense(10) ignored (compliant)
2129 page_control = scsicmd[2] >> 6;
2130 switch (page_control) {
2131 case 0: /* current */
2132 break; /* supported */
2134 goto saving_not_supp;
2135 case 1: /* changeable */
2136 case 2: /* defaults */
2142 output_len = 4 + (ebd ? 8 : 0);
2143 alloc_len = scsicmd[4];
2145 output_len = 8 + (ebd ? 8 : 0);
2146 alloc_len = (scsicmd[7] << 8) + scsicmd[8];
2148 minlen = (alloc_len < buflen) ? alloc_len : buflen;
2150 p = rbuf + output_len;
2151 last = rbuf + minlen - 1;
2153 pg = scsicmd[2] & 0x3f;
2156 * No mode subpages supported (yet) but asking for _all_
2157 * subpages may be valid
2159 if (spg && (spg != ALL_SUB_MPAGES))
2163 case RW_RECOVERY_MPAGE:
2164 output_len += ata_msense_rw_recovery(&p, last);
2168 output_len += ata_msense_caching(args->id, &p, last);
2171 case CONTROL_MPAGE: {
2172 output_len += ata_msense_ctl_mode(&p, last);
2177 output_len += ata_msense_rw_recovery(&p, last);
2178 output_len += ata_msense_caching(args->id, &p, last);
2179 output_len += ata_msense_ctl_mode(&p, last);
2182 default: /* invalid page code */
2190 if (ata_dev_supports_fua(args->id) && (dev->flags & ATA_DFLAG_LBA48) &&
2191 (!(dev->flags & ATA_DFLAG_PIO) || dev->multi_count))
2196 rbuf[0] = output_len;
2201 rbuf[3] = sizeof(sat_blk_desc);
2203 memcpy(rbuf + 4, sat_blk_desc,
2204 sizeof(sat_blk_desc));
2208 rbuf[0] = output_len >> 8;
2210 rbuf[1] = output_len;
2215 rbuf[7] = sizeof(sat_blk_desc);
2217 memcpy(rbuf + 8, sat_blk_desc,
2218 sizeof(sat_blk_desc));
2224 ata_scsi_set_sense(args->cmd, ILLEGAL_REQUEST, 0x24, 0x0);
2225 /* "Invalid field in cbd" */
2229 ata_scsi_set_sense(args->cmd, ILLEGAL_REQUEST, 0x39, 0x0);
2230 /* "Saving parameters not supported" */
2235 * ata_scsiop_read_cap - Simulate READ CAPACITY[ 16] commands
2236 * @args: device IDENTIFY data / SCSI command of interest.
2237 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2238 * @buflen: Response buffer length.
2240 * Simulate READ CAPACITY commands.
2245 unsigned int ata_scsiop_read_cap(struct ata_scsi_args *args, u8 *rbuf,
2246 unsigned int buflen)
2248 u64 last_lba = args->dev->n_sectors - 1; /* LBA of the last block */
2252 if (args->cmd->cmnd[0] == READ_CAPACITY) {
2253 if (last_lba >= 0xffffffffULL)
2254 last_lba = 0xffffffff;
2256 /* sector count, 32-bit */
2257 ATA_SCSI_RBUF_SET(0, last_lba >> (8 * 3));
2258 ATA_SCSI_RBUF_SET(1, last_lba >> (8 * 2));
2259 ATA_SCSI_RBUF_SET(2, last_lba >> (8 * 1));
2260 ATA_SCSI_RBUF_SET(3, last_lba);
2263 ATA_SCSI_RBUF_SET(6, ATA_SECT_SIZE >> 8);
2264 ATA_SCSI_RBUF_SET(7, ATA_SECT_SIZE & 0xff);
2266 /* sector count, 64-bit */
2267 ATA_SCSI_RBUF_SET(0, last_lba >> (8 * 7));
2268 ATA_SCSI_RBUF_SET(1, last_lba >> (8 * 6));
2269 ATA_SCSI_RBUF_SET(2, last_lba >> (8 * 5));
2270 ATA_SCSI_RBUF_SET(3, last_lba >> (8 * 4));
2271 ATA_SCSI_RBUF_SET(4, last_lba >> (8 * 3));
2272 ATA_SCSI_RBUF_SET(5, last_lba >> (8 * 2));
2273 ATA_SCSI_RBUF_SET(6, last_lba >> (8 * 1));
2274 ATA_SCSI_RBUF_SET(7, last_lba);
2277 ATA_SCSI_RBUF_SET(10, ATA_SECT_SIZE >> 8);
2278 ATA_SCSI_RBUF_SET(11, ATA_SECT_SIZE & 0xff);
2285 * ata_scsiop_report_luns - Simulate REPORT LUNS command
2286 * @args: device IDENTIFY data / SCSI command of interest.
2287 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2288 * @buflen: Response buffer length.
2290 * Simulate REPORT LUNS command.
2293 * spin_lock_irqsave(host lock)
2296 unsigned int ata_scsiop_report_luns(struct ata_scsi_args *args, u8 *rbuf,
2297 unsigned int buflen)
2300 rbuf[3] = 8; /* just one lun, LUN 0, size 8 bytes */
2306 * ata_scsi_set_sense - Set SCSI sense data and status
2307 * @cmd: SCSI request to be handled
2308 * @sk: SCSI-defined sense key
2309 * @asc: SCSI-defined additional sense code
2310 * @ascq: SCSI-defined additional sense code qualifier
2312 * Helper function that builds a valid fixed format, current
2313 * response code and the given sense key (sk), additional sense
2314 * code (asc) and additional sense code qualifier (ascq) with
2315 * a SCSI command status of %SAM_STAT_CHECK_CONDITION and
2316 * DRIVER_SENSE set in the upper bits of scsi_cmnd::result .
2322 void ata_scsi_set_sense(struct scsi_cmnd *cmd, u8 sk, u8 asc, u8 ascq)
2324 cmd->result = (DRIVER_SENSE << 24) | SAM_STAT_CHECK_CONDITION;
2326 cmd->sense_buffer[0] = 0x70; /* fixed format, current */
2327 cmd->sense_buffer[2] = sk;
2328 cmd->sense_buffer[7] = 18 - 8; /* additional sense length */
2329 cmd->sense_buffer[12] = asc;
2330 cmd->sense_buffer[13] = ascq;
2334 * ata_scsi_badcmd - End a SCSI request with an error
2335 * @cmd: SCSI request to be handled
2336 * @done: SCSI command completion function
2337 * @asc: SCSI-defined additional sense code
2338 * @ascq: SCSI-defined additional sense code qualifier
2340 * Helper function that completes a SCSI command with
2341 * %SAM_STAT_CHECK_CONDITION, with a sense key %ILLEGAL_REQUEST
2342 * and the specified additional sense codes.
2345 * spin_lock_irqsave(host lock)
2348 void ata_scsi_badcmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *), u8 asc, u8 ascq)
2351 ata_scsi_set_sense(cmd, ILLEGAL_REQUEST, asc, ascq);
2356 static void atapi_sense_complete(struct ata_queued_cmd *qc)
2358 if (qc->err_mask && ((qc->err_mask & AC_ERR_DEV) == 0)) {
2359 /* FIXME: not quite right; we don't want the
2360 * translation of taskfile registers into
2361 * a sense descriptors, since that's only
2362 * correct for ATA, not ATAPI
2364 ata_gen_passthru_sense(qc);
2367 qc->scsidone(qc->scsicmd);
2371 /* is it pointless to prefer PIO for "safety reasons"? */
2372 static inline int ata_pio_use_silly(struct ata_port *ap)
2374 return (ap->flags & ATA_FLAG_PIO_DMA);
2377 static void atapi_request_sense(struct ata_queued_cmd *qc)
2379 struct ata_port *ap = qc->ap;
2380 struct scsi_cmnd *cmd = qc->scsicmd;
2382 DPRINTK("ATAPI request sense\n");
2384 /* FIXME: is this needed? */
2385 memset(cmd->sense_buffer, 0, SCSI_SENSE_BUFFERSIZE);
2387 ap->ops->tf_read(ap, &qc->tf);
2389 /* fill these in, for the case where they are -not- overwritten */
2390 cmd->sense_buffer[0] = 0x70;
2391 cmd->sense_buffer[2] = qc->tf.feature >> 4;
2395 /* setup sg table and init transfer direction */
2396 sg_init_one(&qc->sgent, cmd->sense_buffer, SCSI_SENSE_BUFFERSIZE);
2397 ata_sg_init(qc, &qc->sgent, 1);
2398 qc->dma_dir = DMA_FROM_DEVICE;
2400 memset(&qc->cdb, 0, qc->dev->cdb_len);
2401 qc->cdb[0] = REQUEST_SENSE;
2402 qc->cdb[4] = SCSI_SENSE_BUFFERSIZE;
2404 qc->tf.flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
2405 qc->tf.command = ATA_CMD_PACKET;
2407 if (ata_pio_use_silly(ap)) {
2408 qc->tf.protocol = ATAPI_PROT_DMA;
2409 qc->tf.feature |= ATAPI_PKT_DMA;
2411 qc->tf.protocol = ATAPI_PROT_PIO;
2412 qc->tf.lbam = SCSI_SENSE_BUFFERSIZE;
2415 qc->nbytes = SCSI_SENSE_BUFFERSIZE;
2417 qc->complete_fn = atapi_sense_complete;
2424 static void atapi_qc_complete(struct ata_queued_cmd *qc)
2426 struct scsi_cmnd *cmd = qc->scsicmd;
2427 unsigned int err_mask = qc->err_mask;
2429 VPRINTK("ENTER, err_mask 0x%X\n", err_mask);
2431 /* handle completion from new EH */
2432 if (unlikely(qc->ap->ops->error_handler &&
2433 (err_mask || qc->flags & ATA_QCFLAG_SENSE_VALID))) {
2435 if (!(qc->flags & ATA_QCFLAG_SENSE_VALID)) {
2436 /* FIXME: not quite right; we don't want the
2437 * translation of taskfile registers into a
2438 * sense descriptors, since that's only
2439 * correct for ATA, not ATAPI
2441 ata_gen_passthru_sense(qc);
2444 /* SCSI EH automatically locks door if sdev->locked is
2445 * set. Sometimes door lock request continues to
2446 * fail, for example, when no media is present. This
2447 * creates a loop - SCSI EH issues door lock which
2448 * fails and gets invoked again to acquire sense data
2449 * for the failed command.
2451 * If door lock fails, always clear sdev->locked to
2452 * avoid this infinite loop.
2454 if (qc->cdb[0] == ALLOW_MEDIUM_REMOVAL)
2455 qc->dev->sdev->locked = 0;
2457 qc->scsicmd->result = SAM_STAT_CHECK_CONDITION;
2463 /* successful completion or old EH failure path */
2464 if (unlikely(err_mask & AC_ERR_DEV)) {
2465 cmd->result = SAM_STAT_CHECK_CONDITION;
2466 atapi_request_sense(qc);
2468 } else if (unlikely(err_mask)) {
2469 /* FIXME: not quite right; we don't want the
2470 * translation of taskfile registers into
2471 * a sense descriptors, since that's only
2472 * correct for ATA, not ATAPI
2474 ata_gen_passthru_sense(qc);
2476 u8 *scsicmd = cmd->cmnd;
2478 if ((scsicmd[0] == INQUIRY) && ((scsicmd[1] & 0x03) == 0)) {
2480 unsigned int buflen;
2481 unsigned long flags;
2483 local_irq_save(flags);
2485 buflen = ata_scsi_rbuf_get(cmd, &buf);
2487 /* ATAPI devices typically report zero for their SCSI version,
2488 * and sometimes deviate from the spec WRT response data
2489 * format. If SCSI version is reported as zero like normal,
2490 * then we make the following fixups: 1) Fake MMC-5 version,
2491 * to indicate to the Linux scsi midlayer this is a modern
2492 * device. 2) Ensure response data format / ATAPI information
2493 * are always correct.
2500 ata_scsi_rbuf_put(cmd, buf);
2502 local_irq_restore(flags);
2505 cmd->result = SAM_STAT_GOOD;
2512 * atapi_xlat - Initialize PACKET taskfile
2513 * @qc: command structure to be initialized
2516 * spin_lock_irqsave(host lock)
2519 * Zero on success, non-zero on failure.
2521 static unsigned int atapi_xlat(struct ata_queued_cmd *qc)
2523 struct scsi_cmnd *scmd = qc->scsicmd;
2524 struct ata_device *dev = qc->dev;
2525 int using_pio = (dev->flags & ATA_DFLAG_PIO);
2526 int nodata = (scmd->sc_data_direction == DMA_NONE);
2527 unsigned int nbytes;
2529 memset(qc->cdb, 0, dev->cdb_len);
2530 memcpy(qc->cdb, scmd->cmnd, scmd->cmd_len);
2532 qc->complete_fn = atapi_qc_complete;
2534 qc->tf.flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
2535 if (scmd->sc_data_direction == DMA_TO_DEVICE) {
2536 qc->tf.flags |= ATA_TFLAG_WRITE;
2537 DPRINTK("direction: write\n");
2540 qc->tf.command = ATA_CMD_PACKET;
2541 qc->nbytes = scsi_bufflen(scmd);
2543 /* check whether ATAPI DMA is safe */
2544 if (!using_pio && ata_check_atapi_dma(qc))
2547 /* Some controller variants snoop this value for Packet
2548 * transfers to do state machine and FIFO management. Thus we
2549 * want to set it properly, and for DMA where it is
2550 * effectively meaningless.
2552 nbytes = min(scmd->request->raw_data_len, (unsigned int)63 * 1024);
2554 /* Most ATAPI devices which honor transfer chunk size don't
2555 * behave according to the spec when odd chunk size which
2556 * matches the transfer length is specified. If the number of
2557 * bytes to transfer is 2n+1. According to the spec, what
2558 * should happen is to indicate that 2n+1 is going to be
2559 * transferred and transfer 2n+2 bytes where the last byte is
2562 * In practice, this doesn't happen. ATAPI devices first
2563 * indicate and transfer 2n bytes and then indicate and
2564 * transfer 2 bytes where the last byte is padding.
2566 * This inconsistency confuses several controllers which
2567 * perform PIO using DMA such as Intel AHCIs and sil3124/32.
2568 * These controllers use actual number of transferred bytes to
2569 * update DMA poitner and transfer of 4n+2 bytes make those
2570 * controller push DMA pointer by 4n+4 bytes because SATA data
2571 * FISes are aligned to 4 bytes. This causes data corruption
2572 * and buffer overrun.
2574 * Always setting nbytes to even number solves this problem
2575 * because then ATAPI devices don't have to split data at 2n
2581 qc->tf.lbam = (nbytes & 0xFF);
2582 qc->tf.lbah = (nbytes >> 8);
2584 if (using_pio || nodata) {
2585 /* no data, or PIO data xfer */
2587 qc->tf.protocol = ATAPI_PROT_NODATA;
2589 qc->tf.protocol = ATAPI_PROT_PIO;
2592 qc->tf.protocol = ATAPI_PROT_DMA;
2593 qc->tf.feature |= ATAPI_PKT_DMA;
2595 if ((dev->flags & ATA_DFLAG_DMADIR) &&
2596 (scmd->sc_data_direction != DMA_TO_DEVICE))
2597 /* some SATA bridges need us to indicate data xfer direction */
2598 qc->tf.feature |= ATAPI_DMADIR;
2602 /* FIXME: We need to translate 0x05 READ_BLOCK_LIMITS to a MODE_SENSE
2603 as ATAPI tape drives don't get this right otherwise */
2607 static struct ata_device *ata_find_dev(struct ata_port *ap, int devno)
2609 if (ap->nr_pmp_links == 0) {
2610 if (likely(devno < ata_link_max_devices(&ap->link)))
2611 return &ap->link.device[devno];
2613 if (likely(devno < ap->nr_pmp_links))
2614 return &ap->pmp_link[devno].device[0];
2620 static struct ata_device *__ata_scsi_find_dev(struct ata_port *ap,
2621 const struct scsi_device *scsidev)
2625 /* skip commands not addressed to targets we simulate */
2626 if (ap->nr_pmp_links == 0) {
2627 if (unlikely(scsidev->channel || scsidev->lun))
2629 devno = scsidev->id;
2631 if (unlikely(scsidev->id || scsidev->lun))
2633 devno = scsidev->channel;
2636 return ata_find_dev(ap, devno);
2640 * ata_scsi_dev_enabled - determine if device is enabled
2643 * Determine if commands should be sent to the specified device.
2646 * spin_lock_irqsave(host lock)
2649 * 0 if commands are not allowed / 1 if commands are allowed
2652 static int ata_scsi_dev_enabled(struct ata_device *dev)
2654 if (unlikely(!ata_dev_enabled(dev)))
2657 if (!atapi_enabled || (dev->link->ap->flags & ATA_FLAG_NO_ATAPI)) {
2658 if (unlikely(dev->class == ATA_DEV_ATAPI)) {
2659 ata_dev_printk(dev, KERN_WARNING,
2660 "WARNING: ATAPI is %s, device ignored.\n",
2661 atapi_enabled ? "not supported with this driver" : "disabled");
2670 * ata_scsi_find_dev - lookup ata_device from scsi_cmnd
2671 * @ap: ATA port to which the device is attached
2672 * @scsidev: SCSI device from which we derive the ATA device
2674 * Given various information provided in struct scsi_cmnd,
2675 * map that onto an ATA bus, and using that mapping
2676 * determine which ata_device is associated with the
2677 * SCSI command to be sent.
2680 * spin_lock_irqsave(host lock)
2683 * Associated ATA device, or %NULL if not found.
2685 static struct ata_device *
2686 ata_scsi_find_dev(struct ata_port *ap, const struct scsi_device *scsidev)
2688 struct ata_device *dev = __ata_scsi_find_dev(ap, scsidev);
2690 if (unlikely(!dev || !ata_scsi_dev_enabled(dev)))
2697 * ata_scsi_map_proto - Map pass-thru protocol value to taskfile value.
2698 * @byte1: Byte 1 from pass-thru CDB.
2701 * ATA_PROT_UNKNOWN if mapping failed/unimplemented, protocol otherwise.
2704 ata_scsi_map_proto(u8 byte1)
2706 switch((byte1 & 0x1e) >> 1) {
2707 case 3: /* Non-data */
2708 return ATA_PROT_NODATA;
2711 case 10: /* UDMA Data-in */
2712 case 11: /* UDMA Data-Out */
2713 return ATA_PROT_DMA;
2715 case 4: /* PIO Data-in */
2716 case 5: /* PIO Data-out */
2717 return ATA_PROT_PIO;
2719 case 0: /* Hard Reset */
2721 case 8: /* Device Diagnostic */
2722 case 9: /* Device Reset */
2723 case 7: /* DMA Queued */
2724 case 12: /* FPDMA */
2725 case 15: /* Return Response Info */
2726 default: /* Reserved */
2730 return ATA_PROT_UNKNOWN;
2734 * ata_scsi_pass_thru - convert ATA pass-thru CDB to taskfile
2735 * @qc: command structure to be initialized
2737 * Handles either 12 or 16-byte versions of the CDB.
2740 * Zero on success, non-zero on failure.
2742 static unsigned int ata_scsi_pass_thru(struct ata_queued_cmd *qc)
2744 struct ata_taskfile *tf = &(qc->tf);
2745 struct scsi_cmnd *scmd = qc->scsicmd;
2746 struct ata_device *dev = qc->dev;
2747 const u8 *cdb = scmd->cmnd;
2749 if ((tf->protocol = ata_scsi_map_proto(cdb[1])) == ATA_PROT_UNKNOWN)
2753 * Filter TPM commands by default. These provide an
2754 * essentially uncontrolled encrypted "back door" between
2755 * applications and the disk. Set libata.allow_tpm=1 if you
2756 * have a real reason for wanting to use them. This ensures
2757 * that installed software cannot easily mess stuff up without
2758 * user intent. DVR type users will probably ship with this enabled
2759 * for movie content management.
2761 * Note that for ATA8 we can issue a DCS change and DCS freeze lock
2762 * for this and should do in future but that it is not sufficient as
2763 * DCS is an optional feature set. Thus we also do the software filter
2764 * so that we comply with the TC consortium stated goal that the user
2765 * can turn off TC features of their system.
2767 if (tf->command >= 0x5C && tf->command <= 0x5F && !libata_allow_tpm)
2770 /* We may not issue DMA commands if no DMA mode is set */
2771 if (tf->protocol == ATA_PROT_DMA && dev->dma_mode == 0)
2775 * 12 and 16 byte CDBs use different offsets to
2776 * provide the various register values.
2778 if (cdb[0] == ATA_16) {
2780 * 16-byte CDB - may contain extended commands.
2782 * If that is the case, copy the upper byte register values.
2784 if (cdb[1] & 0x01) {
2785 tf->hob_feature = cdb[3];
2786 tf->hob_nsect = cdb[5];
2787 tf->hob_lbal = cdb[7];
2788 tf->hob_lbam = cdb[9];
2789 tf->hob_lbah = cdb[11];
2790 tf->flags |= ATA_TFLAG_LBA48;
2792 tf->flags &= ~ATA_TFLAG_LBA48;
2795 * Always copy low byte, device and command registers.
2797 tf->feature = cdb[4];
2802 tf->device = cdb[13];
2803 tf->command = cdb[14];
2806 * 12-byte CDB - incapable of extended commands.
2808 tf->flags &= ~ATA_TFLAG_LBA48;
2810 tf->feature = cdb[3];
2815 tf->device = cdb[8];
2816 tf->command = cdb[9];
2819 /* enforce correct master/slave bit */
2820 tf->device = dev->devno ?
2821 tf->device | ATA_DEV1 : tf->device & ~ATA_DEV1;
2823 /* sanity check for pio multi commands */
2824 if ((cdb[1] & 0xe0) && !is_multi_taskfile(tf))
2827 if (is_multi_taskfile(tf)) {
2828 unsigned int multi_count = 1 << (cdb[1] >> 5);
2830 /* compare the passed through multi_count
2831 * with the cached multi_count of libata
2833 if (multi_count != dev->multi_count)
2834 ata_dev_printk(dev, KERN_WARNING,
2835 "invalid multi_count %u ignored\n",
2839 /* READ/WRITE LONG use a non-standard sect_size */
2840 qc->sect_size = ATA_SECT_SIZE;
2841 switch (tf->command) {
2842 case ATA_CMD_READ_LONG:
2843 case ATA_CMD_READ_LONG_ONCE:
2844 case ATA_CMD_WRITE_LONG:
2845 case ATA_CMD_WRITE_LONG_ONCE:
2846 if (tf->protocol != ATA_PROT_PIO || tf->nsect != 1)
2848 qc->sect_size = scsi_bufflen(scmd);
2852 * Filter SET_FEATURES - XFER MODE command -- otherwise,
2853 * SET_FEATURES - XFER MODE must be preceded/succeeded
2854 * by an update to hardware-specific registers for each
2855 * controller (i.e. the reason for ->set_piomode(),
2856 * ->set_dmamode(), and ->post_set_mode() hooks).
2858 if ((tf->command == ATA_CMD_SET_FEATURES)
2859 && (tf->feature == SETFEATURES_XFER))
2863 * Set flags so that all registers will be written,
2864 * and pass on write indication (used for PIO/DMA
2867 tf->flags |= (ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE);
2869 if (scmd->sc_data_direction == DMA_TO_DEVICE)
2870 tf->flags |= ATA_TFLAG_WRITE;
2873 * Set transfer length.
2875 * TODO: find out if we need to do more here to
2876 * cover scatter/gather case.
2878 qc->nbytes = scsi_bufflen(scmd);
2880 /* request result TF and be quiet about device error */
2881 qc->flags |= ATA_QCFLAG_RESULT_TF | ATA_QCFLAG_QUIET;
2886 ata_scsi_set_sense(scmd, ILLEGAL_REQUEST, 0x24, 0x00);
2887 /* "Invalid field in cdb" */
2892 * ata_get_xlat_func - check if SCSI to ATA translation is possible
2894 * @cmd: SCSI command opcode to consider
2896 * Look up the SCSI command given, and determine whether the
2897 * SCSI command is to be translated or simulated.
2900 * Pointer to translation function if possible, %NULL if not.
2903 static inline ata_xlat_func_t ata_get_xlat_func(struct ata_device *dev, u8 cmd)
2913 return ata_scsi_rw_xlat;
2915 case SYNCHRONIZE_CACHE:
2916 if (ata_try_flush_cache(dev))
2917 return ata_scsi_flush_xlat;
2922 return ata_scsi_verify_xlat;
2926 return ata_scsi_pass_thru;
2929 return ata_scsi_start_stop_xlat;
2936 * ata_scsi_dump_cdb - dump SCSI command contents to dmesg
2937 * @ap: ATA port to which the command was being sent
2938 * @cmd: SCSI command to dump
2940 * Prints the contents of a SCSI command via printk().
2943 static inline void ata_scsi_dump_cdb(struct ata_port *ap,
2944 struct scsi_cmnd *cmd)
2947 struct scsi_device *scsidev = cmd->device;
2948 u8 *scsicmd = cmd->cmnd;
2950 DPRINTK("CDB (%u:%d,%d,%d) %02x %02x %02x %02x %02x %02x %02x %02x %02x\n",
2952 scsidev->channel, scsidev->id, scsidev->lun,
2953 scsicmd[0], scsicmd[1], scsicmd[2], scsicmd[3],
2954 scsicmd[4], scsicmd[5], scsicmd[6], scsicmd[7],
2959 static inline int __ata_scsi_queuecmd(struct scsi_cmnd *scmd,
2960 void (*done)(struct scsi_cmnd *),
2961 struct ata_device *dev)
2963 u8 scsi_op = scmd->cmnd[0];
2964 ata_xlat_func_t xlat_func;
2967 if (dev->class == ATA_DEV_ATA) {
2968 if (unlikely(!scmd->cmd_len || scmd->cmd_len > dev->cdb_len))
2971 xlat_func = ata_get_xlat_func(dev, scsi_op);
2973 if (unlikely(!scmd->cmd_len))
2977 if (likely((scsi_op != ATA_16) || !atapi_passthru16)) {
2978 /* relay SCSI command to ATAPI device */
2979 int len = COMMAND_SIZE(scsi_op);
2980 if (unlikely(len > scmd->cmd_len || len > dev->cdb_len))
2983 xlat_func = atapi_xlat;
2985 /* ATA_16 passthru, treat as an ATA command */
2986 if (unlikely(scmd->cmd_len > 16))
2989 xlat_func = ata_get_xlat_func(dev, scsi_op);
2994 rc = ata_scsi_translate(dev, scmd, done, xlat_func);
2996 ata_scsi_simulate(dev, scmd, done);
3001 DPRINTK("bad CDB len=%u, scsi_op=0x%02x, max=%u\n",
3002 scmd->cmd_len, scsi_op, dev->cdb_len);
3003 scmd->result = DID_ERROR << 16;
3009 * ata_scsi_queuecmd - Issue SCSI cdb to libata-managed device
3010 * @cmd: SCSI command to be sent
3011 * @done: Completion function, called when command is complete
3013 * In some cases, this function translates SCSI commands into
3014 * ATA taskfiles, and queues the taskfiles to be sent to
3015 * hardware. In other cases, this function simulates a
3016 * SCSI device by evaluating and responding to certain
3017 * SCSI commands. This creates the overall effect of
3018 * ATA and ATAPI devices appearing as SCSI devices.
3021 * Releases scsi-layer-held lock, and obtains host lock.
3024 * Return value from __ata_scsi_queuecmd() if @cmd can be queued,
3027 int ata_scsi_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *))
3029 struct ata_port *ap;
3030 struct ata_device *dev;
3031 struct scsi_device *scsidev = cmd->device;
3032 struct Scsi_Host *shost = scsidev->host;
3035 ap = ata_shost_to_port(shost);
3037 spin_unlock(shost->host_lock);
3038 spin_lock(ap->lock);
3040 ata_scsi_dump_cdb(ap, cmd);
3042 dev = ata_scsi_find_dev(ap, scsidev);
3044 rc = __ata_scsi_queuecmd(cmd, done, dev);
3046 cmd->result = (DID_BAD_TARGET << 16);
3050 spin_unlock(ap->lock);
3051 spin_lock(shost->host_lock);
3056 * ata_scsi_simulate - simulate SCSI command on ATA device
3057 * @dev: the target device
3058 * @cmd: SCSI command being sent to device.
3059 * @done: SCSI command completion function.
3061 * Interprets and directly executes a select list of SCSI commands
3062 * that can be handled internally.
3065 * spin_lock_irqsave(host lock)
3068 void ata_scsi_simulate(struct ata_device *dev, struct scsi_cmnd *cmd,
3069 void (*done)(struct scsi_cmnd *))
3071 struct ata_scsi_args args;
3072 const u8 *scsicmd = cmd->cmnd;
3080 switch(scsicmd[0]) {
3081 /* TODO: worth improving? */
3083 ata_scsi_invalid_field(cmd, done);
3087 if (scsicmd[1] & 2) /* is CmdDt set? */
3088 ata_scsi_invalid_field(cmd, done);
3089 else if ((scsicmd[1] & 1) == 0) /* is EVPD clear? */
3090 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_std);
3091 else switch (scsicmd[2]) {
3093 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_00);
3096 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_80);
3099 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_83);
3102 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_89);
3105 ata_scsi_invalid_field(cmd, done);
3112 ata_scsi_rbuf_fill(&args, ata_scsiop_mode_sense);
3115 case MODE_SELECT: /* unconditionally return */
3116 case MODE_SELECT_10: /* bad-field-in-cdb */
3117 ata_scsi_invalid_field(cmd, done);
3121 ata_scsi_rbuf_fill(&args, ata_scsiop_read_cap);
3124 case SERVICE_ACTION_IN:
3125 if ((scsicmd[1] & 0x1f) == SAI_READ_CAPACITY_16)
3126 ata_scsi_rbuf_fill(&args, ata_scsiop_read_cap);
3128 ata_scsi_invalid_field(cmd, done);
3132 ata_scsi_rbuf_fill(&args, ata_scsiop_report_luns);
3136 ata_scsi_set_sense(cmd, 0, 0, 0);
3137 cmd->result = (DRIVER_SENSE << 24);
3141 /* if we reach this, then writeback caching is disabled,
3142 * turning this into a no-op.
3144 case SYNCHRONIZE_CACHE:
3147 /* no-op's, complete with success */
3151 case TEST_UNIT_READY:
3152 ata_scsi_rbuf_fill(&args, ata_scsiop_noop);
3155 case SEND_DIAGNOSTIC:
3156 tmp8 = scsicmd[1] & ~(1 << 3);
3157 if ((tmp8 == 0x4) && (!scsicmd[3]) && (!scsicmd[4]))
3158 ata_scsi_rbuf_fill(&args, ata_scsiop_noop);
3160 ata_scsi_invalid_field(cmd, done);
3163 /* all other commands */
3165 ata_scsi_set_sense(cmd, ILLEGAL_REQUEST, 0x20, 0x0);
3166 /* "Invalid command operation code" */
3172 int ata_scsi_add_hosts(struct ata_host *host, struct scsi_host_template *sht)
3176 for (i = 0; i < host->n_ports; i++) {
3177 struct ata_port *ap = host->ports[i];
3178 struct Scsi_Host *shost;
3181 shost = scsi_host_alloc(sht, sizeof(struct ata_port *));
3185 *(struct ata_port **)&shost->hostdata[0] = ap;
3186 ap->scsi_host = shost;
3188 shost->transportt = &ata_scsi_transport_template;
3189 shost->unique_id = ap->print_id;
3192 shost->max_channel = 1;
3193 shost->max_cmd_len = 16;
3195 /* Schedule policy is determined by ->qc_defer()
3196 * callback and it needs to see every deferred qc.
3197 * Set host_blocked to 1 to prevent SCSI midlayer from
3198 * automatically deferring requests.
3200 shost->max_host_blocked = 1;
3202 rc = scsi_add_host(ap->scsi_host, ap->host->dev);
3210 scsi_host_put(host->ports[i]->scsi_host);
3213 struct Scsi_Host *shost = host->ports[i]->scsi_host;
3215 scsi_remove_host(shost);
3216 scsi_host_put(shost);
3221 void ata_scsi_scan_host(struct ata_port *ap, int sync)
3224 struct ata_device *last_failed_dev = NULL;
3225 struct ata_link *link;
3226 struct ata_device *dev;
3228 if (ap->flags & ATA_FLAG_DISABLED)
3232 ata_port_for_each_link(link, ap) {
3233 ata_link_for_each_dev(dev, link) {
3234 struct scsi_device *sdev;
3235 int channel = 0, id = 0;
3237 if (!ata_dev_enabled(dev) || dev->sdev)
3240 if (ata_is_host_link(link))
3243 channel = link->pmp;
3245 sdev = __scsi_add_device(ap->scsi_host, channel, id, 0,
3247 if (!IS_ERR(sdev)) {
3249 scsi_device_put(sdev);
3254 /* If we scanned while EH was in progress or allocation
3255 * failure occurred, scan would have failed silently. Check
3256 * whether all devices are attached.
3258 ata_port_for_each_link(link, ap) {
3259 ata_link_for_each_dev(dev, link) {
3260 if (ata_dev_enabled(dev) && !dev->sdev)
3268 /* we're missing some SCSI devices */
3270 /* If caller requested synchrnous scan && we've made
3271 * any progress, sleep briefly and repeat.
3273 if (dev != last_failed_dev) {
3275 last_failed_dev = dev;
3279 /* We might be failing to detect boot device, give it
3280 * a few more chances.
3287 ata_port_printk(ap, KERN_ERR, "WARNING: synchronous SCSI scan "
3288 "failed without making any progress,\n"
3289 " switching to async\n");
3292 queue_delayed_work(ata_aux_wq, &ap->hotplug_task,
3293 round_jiffies_relative(HZ));
3297 * ata_scsi_offline_dev - offline attached SCSI device
3298 * @dev: ATA device to offline attached SCSI device for
3300 * This function is called from ata_eh_hotplug() and responsible
3301 * for taking the SCSI device attached to @dev offline. This
3302 * function is called with host lock which protects dev->sdev
3306 * spin_lock_irqsave(host lock)
3309 * 1 if attached SCSI device exists, 0 otherwise.
3311 int ata_scsi_offline_dev(struct ata_device *dev)
3314 scsi_device_set_state(dev->sdev, SDEV_OFFLINE);
3321 * ata_scsi_remove_dev - remove attached SCSI device
3322 * @dev: ATA device to remove attached SCSI device for
3324 * This function is called from ata_eh_scsi_hotplug() and
3325 * responsible for removing the SCSI device attached to @dev.
3328 * Kernel thread context (may sleep).
3330 static void ata_scsi_remove_dev(struct ata_device *dev)
3332 struct ata_port *ap = dev->link->ap;
3333 struct scsi_device *sdev;
3334 unsigned long flags;
3336 /* Alas, we need to grab scan_mutex to ensure SCSI device
3337 * state doesn't change underneath us and thus
3338 * scsi_device_get() always succeeds. The mutex locking can
3339 * be removed if there is __scsi_device_get() interface which
3340 * increments reference counts regardless of device state.
3342 mutex_lock(&ap->scsi_host->scan_mutex);
3343 spin_lock_irqsave(ap->lock, flags);
3345 /* clearing dev->sdev is protected by host lock */
3350 /* If user initiated unplug races with us, sdev can go
3351 * away underneath us after the host lock and
3352 * scan_mutex are released. Hold onto it.
3354 if (scsi_device_get(sdev) == 0) {
3355 /* The following ensures the attached sdev is
3356 * offline on return from ata_scsi_offline_dev()
3357 * regardless it wins or loses the race
3358 * against this function.
3360 scsi_device_set_state(sdev, SDEV_OFFLINE);
3367 spin_unlock_irqrestore(ap->lock, flags);
3368 mutex_unlock(&ap->scsi_host->scan_mutex);
3371 ata_dev_printk(dev, KERN_INFO, "detaching (SCSI %s)\n",
3372 sdev->sdev_gendev.bus_id);
3374 scsi_remove_device(sdev);
3375 scsi_device_put(sdev);
3379 static void ata_scsi_handle_link_detach(struct ata_link *link)
3381 struct ata_port *ap = link->ap;
3382 struct ata_device *dev;
3384 ata_link_for_each_dev(dev, link) {
3385 unsigned long flags;
3387 if (!(dev->flags & ATA_DFLAG_DETACHED))
3390 spin_lock_irqsave(ap->lock, flags);
3391 dev->flags &= ~ATA_DFLAG_DETACHED;
3392 spin_unlock_irqrestore(ap->lock, flags);
3394 ata_scsi_remove_dev(dev);
3399 * ata_scsi_media_change_notify - send media change event
3400 * @dev: Pointer to the disk device with media change event
3402 * Tell the block layer to send a media change notification
3406 * spin_lock_irqsave(host lock)
3408 void ata_scsi_media_change_notify(struct ata_device *dev)
3411 sdev_evt_send_simple(dev->sdev, SDEV_EVT_MEDIA_CHANGE,
3416 * ata_scsi_hotplug - SCSI part of hotplug
3417 * @work: Pointer to ATA port to perform SCSI hotplug on
3419 * Perform SCSI part of hotplug. It's executed from a separate
3420 * workqueue after EH completes. This is necessary because SCSI
3421 * hot plugging requires working EH and hot unplugging is
3422 * synchronized with hot plugging with a mutex.
3425 * Kernel thread context (may sleep).
3427 void ata_scsi_hotplug(struct work_struct *work)
3429 struct ata_port *ap =
3430 container_of(work, struct ata_port, hotplug_task.work);
3433 if (ap->pflags & ATA_PFLAG_UNLOADING) {
3434 DPRINTK("ENTER/EXIT - unloading\n");
3440 /* Unplug detached devices. We cannot use link iterator here
3441 * because PMP links have to be scanned even if PMP is
3442 * currently not attached. Iterate manually.
3444 ata_scsi_handle_link_detach(&ap->link);
3446 for (i = 0; i < SATA_PMP_MAX_PORTS; i++)
3447 ata_scsi_handle_link_detach(&ap->pmp_link[i]);
3449 /* scan for new ones */
3450 ata_scsi_scan_host(ap, 0);
3456 * ata_scsi_user_scan - indication for user-initiated bus scan
3457 * @shost: SCSI host to scan
3458 * @channel: Channel to scan
3462 * This function is called when user explicitly requests bus
3463 * scan. Set probe pending flag and invoke EH.
3466 * SCSI layer (we don't care)
3471 static int ata_scsi_user_scan(struct Scsi_Host *shost, unsigned int channel,
3472 unsigned int id, unsigned int lun)
3474 struct ata_port *ap = ata_shost_to_port(shost);
3475 unsigned long flags;
3478 if (!ap->ops->error_handler)
3481 if (lun != SCAN_WILD_CARD && lun)
3484 if (ap->nr_pmp_links == 0) {
3485 if (channel != SCAN_WILD_CARD && channel)
3489 if (id != SCAN_WILD_CARD && id)
3494 spin_lock_irqsave(ap->lock, flags);
3496 if (devno == SCAN_WILD_CARD) {
3497 struct ata_link *link;
3499 ata_port_for_each_link(link, ap) {
3500 struct ata_eh_info *ehi = &link->eh_info;
3501 ehi->probe_mask |= (1 << ata_link_max_devices(link)) - 1;
3502 ehi->action |= ATA_EH_SOFTRESET;
3505 struct ata_device *dev = ata_find_dev(ap, devno);
3508 struct ata_eh_info *ehi = &dev->link->eh_info;
3509 ehi->probe_mask |= 1 << dev->devno;
3510 ehi->action |= ATA_EH_SOFTRESET;
3511 ehi->flags |= ATA_EHI_RESUME_LINK;
3517 ata_port_schedule_eh(ap);
3518 spin_unlock_irqrestore(ap->lock, flags);
3519 ata_port_wait_eh(ap);
3521 spin_unlock_irqrestore(ap->lock, flags);
3527 * ata_scsi_dev_rescan - initiate scsi_rescan_device()
3528 * @work: Pointer to ATA port to perform scsi_rescan_device()
3530 * After ATA pass thru (SAT) commands are executed successfully,
3531 * libata need to propagate the changes to SCSI layer. This
3532 * function must be executed from ata_aux_wq such that sdev
3533 * attach/detach don't race with rescan.
3536 * Kernel thread context (may sleep).
3538 void ata_scsi_dev_rescan(struct work_struct *work)
3540 struct ata_port *ap =
3541 container_of(work, struct ata_port, scsi_rescan_task);
3542 struct ata_link *link;
3543 struct ata_device *dev;
3544 unsigned long flags;
3546 spin_lock_irqsave(ap->lock, flags);
3548 ata_port_for_each_link(link, ap) {
3549 ata_link_for_each_dev(dev, link) {
3550 struct scsi_device *sdev = dev->sdev;
3552 if (!ata_dev_enabled(dev) || !sdev)
3554 if (scsi_device_get(sdev))
3557 spin_unlock_irqrestore(ap->lock, flags);
3558 scsi_rescan_device(&(sdev->sdev_gendev));
3559 scsi_device_put(sdev);
3560 spin_lock_irqsave(ap->lock, flags);
3564 spin_unlock_irqrestore(ap->lock, flags);
3568 * ata_sas_port_alloc - Allocate port for a SAS attached SATA device
3569 * @host: ATA host container for all SAS ports
3570 * @port_info: Information from low-level host driver
3571 * @shost: SCSI host that the scsi device is attached to
3574 * PCI/etc. bus probe sem.
3577 * ata_port pointer on success / NULL on failure.
3580 struct ata_port *ata_sas_port_alloc(struct ata_host *host,
3581 struct ata_port_info *port_info,
3582 struct Scsi_Host *shost)
3584 struct ata_port *ap;
3586 ap = ata_port_alloc(host);
3591 ap->lock = shost->host_lock;
3592 ap->pio_mask = port_info->pio_mask;
3593 ap->mwdma_mask = port_info->mwdma_mask;
3594 ap->udma_mask = port_info->udma_mask;
3595 ap->flags |= port_info->flags;
3596 ap->ops = port_info->port_ops;
3597 ap->cbl = ATA_CBL_SATA;
3601 EXPORT_SYMBOL_GPL(ata_sas_port_alloc);
3604 * ata_sas_port_start - Set port up for dma.
3605 * @ap: Port to initialize
3607 * Called just after data structures for each port are
3610 * May be used as the port_start() entry in ata_port_operations.
3613 * Inherited from caller.
3615 int ata_sas_port_start(struct ata_port *ap)
3619 EXPORT_SYMBOL_GPL(ata_sas_port_start);
3622 * ata_port_stop - Undo ata_sas_port_start()
3623 * @ap: Port to shut down
3625 * May be used as the port_stop() entry in ata_port_operations.
3628 * Inherited from caller.
3631 void ata_sas_port_stop(struct ata_port *ap)
3634 EXPORT_SYMBOL_GPL(ata_sas_port_stop);
3637 * ata_sas_port_init - Initialize a SATA device
3638 * @ap: SATA port to initialize
3641 * PCI/etc. bus probe sem.
3644 * Zero on success, non-zero on error.
3647 int ata_sas_port_init(struct ata_port *ap)
3649 int rc = ap->ops->port_start(ap);
3652 ap->print_id = ata_print_id++;
3653 rc = ata_bus_probe(ap);
3658 EXPORT_SYMBOL_GPL(ata_sas_port_init);
3661 * ata_sas_port_destroy - Destroy a SATA port allocated by ata_sas_port_alloc
3662 * @ap: SATA port to destroy
3666 void ata_sas_port_destroy(struct ata_port *ap)
3668 if (ap->ops->port_stop)
3669 ap->ops->port_stop(ap);
3672 EXPORT_SYMBOL_GPL(ata_sas_port_destroy);
3675 * ata_sas_slave_configure - Default slave_config routine for libata devices
3676 * @sdev: SCSI device to configure
3677 * @ap: ATA port to which SCSI device is attached
3683 int ata_sas_slave_configure(struct scsi_device *sdev, struct ata_port *ap)
3685 ata_scsi_sdev_config(sdev);
3686 ata_scsi_dev_config(sdev, ap->link.device);
3689 EXPORT_SYMBOL_GPL(ata_sas_slave_configure);
3692 * ata_sas_queuecmd - Issue SCSI cdb to libata-managed device
3693 * @cmd: SCSI command to be sent
3694 * @done: Completion function, called when command is complete
3695 * @ap: ATA port to which the command is being sent
3698 * Return value from __ata_scsi_queuecmd() if @cmd can be queued,
3702 int ata_sas_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *),
3703 struct ata_port *ap)
3707 ata_scsi_dump_cdb(ap, cmd);
3709 if (likely(ata_scsi_dev_enabled(ap->link.device)))
3710 rc = __ata_scsi_queuecmd(cmd, done, ap->link.device);
3712 cmd->result = (DID_BAD_TARGET << 16);
3717 EXPORT_SYMBOL_GPL(ata_sas_queuecmd);