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 <asm/uaccess.h>
52 #define SECTOR_SIZE 512
54 typedef unsigned int (*ata_xlat_func_t)(struct ata_queued_cmd *qc, const u8 *cdb);
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[] = {
76 RW_RECOVERY_MPAGE_LEN - 2,
77 (1 << 7) | /* AWRE, sat-r06 say it shall be 0 */
78 (1 << 6), /* ARRE (auto read reallocation) */
79 0, /* read retry count */
81 0, /* write retry count */
85 static const u8 def_cache_mpage[CACHE_MPAGE_LEN] = {
88 0, /* contains WCE, needs to be 0 for logic */
89 0, 0, 0, 0, 0, 0, 0, 0, 0,
90 0, /* contains DRA, needs to be 0 for logic */
94 static const u8 def_control_mpage[CONTROL_MPAGE_LEN] = {
96 CONTROL_MPAGE_LEN - 2,
97 2, /* DSENSE=0, GLTSD=1 */
98 0, /* [QAM+QERR may be 1, see 05-359r1] */
99 0, 0, 0, 0, 0xff, 0xff,
100 0, 30 /* extended self test time, see 05-359r1 */
104 * libata transport template. libata doesn't do real transport stuff.
105 * It just needs the eh_timed_out hook.
107 struct scsi_transport_template ata_scsi_transport_template = {
108 .eh_strategy_handler = ata_scsi_error,
109 .eh_timed_out = ata_scsi_timed_out,
110 .user_scan = ata_scsi_user_scan,
114 static void ata_scsi_invalid_field(struct scsi_cmnd *cmd,
115 void (*done)(struct scsi_cmnd *))
117 ata_scsi_set_sense(cmd, ILLEGAL_REQUEST, 0x24, 0x0);
118 /* "Invalid field in cbd" */
123 * ata_std_bios_param - generic bios head/sector/cylinder calculator used by sd.
124 * @sdev: SCSI device for which BIOS geometry is to be determined
125 * @bdev: block device associated with @sdev
126 * @capacity: capacity of SCSI device
127 * @geom: location to which geometry will be output
129 * Generic bios head/sector/cylinder calculator
130 * used by sd. Most BIOSes nowadays expect a XXX/255/16 (CHS)
131 * mapping. Some situations may arise where the disk is not
132 * bootable if this is not used.
135 * Defined by the SCSI layer. We don't really care.
140 int ata_std_bios_param(struct scsi_device *sdev, struct block_device *bdev,
141 sector_t capacity, int geom[])
145 sector_div(capacity, 255*63);
152 * ata_cmd_ioctl - Handler for HDIO_DRIVE_CMD ioctl
153 * @scsidev: Device to which we are issuing command
154 * @arg: User provided data for issuing command
157 * Defined by the SCSI layer. We don't really care.
160 * Zero on success, negative errno on error.
163 int ata_cmd_ioctl(struct scsi_device *scsidev, void __user *arg)
166 u8 scsi_cmd[MAX_COMMAND_SIZE];
167 u8 args[4], *argbuf = NULL, *sensebuf = NULL;
169 enum dma_data_direction data_dir;
175 if (copy_from_user(args, arg, sizeof(args)))
178 sensebuf = kzalloc(SCSI_SENSE_BUFFERSIZE, GFP_NOIO);
182 memset(scsi_cmd, 0, sizeof(scsi_cmd));
185 argsize = SECTOR_SIZE * args[3];
186 argbuf = kmalloc(argsize, GFP_KERNEL);
187 if (argbuf == NULL) {
192 scsi_cmd[1] = (4 << 1); /* PIO Data-in */
193 scsi_cmd[2] = 0x0e; /* no off.line or cc, read from dev,
194 block count in sector count field */
195 data_dir = DMA_FROM_DEVICE;
197 scsi_cmd[1] = (3 << 1); /* Non-data */
198 scsi_cmd[2] = 0x20; /* cc but no off.line or data xfer */
202 scsi_cmd[0] = ATA_16;
204 scsi_cmd[4] = args[2];
205 if (args[0] == WIN_SMART) { /* hack -- ide driver does this too... */
206 scsi_cmd[6] = args[3];
207 scsi_cmd[8] = args[1];
211 scsi_cmd[6] = args[1];
213 scsi_cmd[14] = args[0];
215 /* Good values for timeout and retries? Values below
216 from scsi_ioctl_send_command() for default case... */
217 cmd_result = scsi_execute(scsidev, scsi_cmd, data_dir, argbuf, argsize,
218 sensebuf, (10*HZ), 5, 0);
220 if (driver_byte(cmd_result) == DRIVER_SENSE) {/* sense data available */
221 u8 *desc = sensebuf + 8;
222 cmd_result &= ~(0xFF<<24); /* DRIVER_SENSE is not an error */
224 /* If we set cc then ATA pass-through will cause a
225 * check condition even if no error. Filter that. */
226 if (cmd_result & SAM_STAT_CHECK_CONDITION) {
227 struct scsi_sense_hdr sshdr;
228 scsi_normalize_sense(sensebuf, SCSI_SENSE_BUFFERSIZE,
230 if (sshdr.sense_key==0 &&
231 sshdr.asc==0 && sshdr.ascq==0)
232 cmd_result &= ~SAM_STAT_CHECK_CONDITION;
235 /* Send userspace a few ATA registers (same as drivers/ide) */
236 if (sensebuf[0] == 0x72 && /* format is "descriptor" */
237 desc[0] == 0x09 ) { /* code is "ATA Descriptor" */
238 args[0] = desc[13]; /* status */
239 args[1] = desc[3]; /* error */
240 args[2] = desc[5]; /* sector count (0:7) */
241 if (copy_to_user(arg, args, sizeof(args)))
253 && copy_to_user(arg + sizeof(args), argbuf, argsize))
262 * ata_task_ioctl - Handler for HDIO_DRIVE_TASK ioctl
263 * @scsidev: Device to which we are issuing command
264 * @arg: User provided data for issuing command
267 * Defined by the SCSI layer. We don't really care.
270 * Zero on success, negative errno on error.
272 int ata_task_ioctl(struct scsi_device *scsidev, void __user *arg)
275 u8 scsi_cmd[MAX_COMMAND_SIZE];
277 struct scsi_sense_hdr sshdr;
282 if (copy_from_user(args, arg, sizeof(args)))
285 memset(scsi_cmd, 0, sizeof(scsi_cmd));
286 scsi_cmd[0] = ATA_16;
287 scsi_cmd[1] = (3 << 1); /* Non-data */
288 /* scsi_cmd[2] is already 0 -- no off.line, cc, or data xfer */
289 scsi_cmd[4] = args[1];
290 scsi_cmd[6] = args[2];
291 scsi_cmd[8] = args[3];
292 scsi_cmd[10] = args[4];
293 scsi_cmd[12] = args[5];
294 scsi_cmd[14] = args[0];
296 /* Good values for timeout and retries? Values below
297 from scsi_ioctl_send_command() for default case... */
298 if (scsi_execute_req(scsidev, scsi_cmd, DMA_NONE, NULL, 0, &sshdr,
302 /* Need code to retrieve data from check condition? */
306 int ata_scsi_ioctl(struct scsi_device *scsidev, int cmd, void __user *arg)
308 int val = -EINVAL, rc = -EINVAL;
311 case ATA_IOC_GET_IO32:
313 if (copy_to_user(arg, &val, 1))
317 case ATA_IOC_SET_IO32:
318 val = (unsigned long) arg;
324 if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
326 return ata_cmd_ioctl(scsidev, arg);
328 case HDIO_DRIVE_TASK:
329 if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
331 return ata_task_ioctl(scsidev, arg);
342 * ata_scsi_qc_new - acquire new ata_queued_cmd reference
343 * @dev: ATA device to which the new command is attached
344 * @cmd: SCSI command that originated this ATA command
345 * @done: SCSI command completion function
347 * Obtain a reference to an unused ata_queued_cmd structure,
348 * which is the basic libata structure representing a single
349 * ATA command sent to the hardware.
351 * If a command was available, fill in the SCSI-specific
352 * portions of the structure with information on the
356 * spin_lock_irqsave(host lock)
359 * Command allocated, or %NULL if none available.
361 struct ata_queued_cmd *ata_scsi_qc_new(struct ata_device *dev,
362 struct scsi_cmnd *cmd,
363 void (*done)(struct scsi_cmnd *))
365 struct ata_queued_cmd *qc;
367 qc = ata_qc_new_init(dev);
373 qc->__sg = (struct scatterlist *) cmd->request_buffer;
374 qc->n_elem = cmd->use_sg;
376 qc->__sg = &qc->sgent;
380 cmd->result = (DID_OK << 16) | (QUEUE_FULL << 1);
388 * ata_dump_status - user friendly display of error info
389 * @id: id of the port in question
390 * @tf: ptr to filled out taskfile
392 * Decode and dump the ATA error/status registers for the user so
393 * that they have some idea what really happened at the non
394 * make-believe layer.
397 * inherited from caller
399 void ata_dump_status(unsigned id, struct ata_taskfile *tf)
401 u8 stat = tf->command, err = tf->feature;
403 printk(KERN_WARNING "ata%u: status=0x%02x { ", id, stat);
404 if (stat & ATA_BUSY) {
405 printk("Busy }\n"); /* Data is not valid in this case */
407 if (stat & 0x40) printk("DriveReady ");
408 if (stat & 0x20) printk("DeviceFault ");
409 if (stat & 0x10) printk("SeekComplete ");
410 if (stat & 0x08) printk("DataRequest ");
411 if (stat & 0x04) printk("CorrectedError ");
412 if (stat & 0x02) printk("Index ");
413 if (stat & 0x01) printk("Error ");
417 printk(KERN_WARNING "ata%u: error=0x%02x { ", id, err);
418 if (err & 0x04) printk("DriveStatusError ");
420 if (err & 0x04) printk("BadCRC ");
421 else printk("Sector ");
423 if (err & 0x40) printk("UncorrectableError ");
424 if (err & 0x10) printk("SectorIdNotFound ");
425 if (err & 0x02) printk("TrackZeroNotFound ");
426 if (err & 0x01) printk("AddrMarkNotFound ");
433 * ata_scsi_device_suspend - suspend ATA device associated with sdev
434 * @sdev: the SCSI device to suspend
435 * @mesg: target power management message
437 * Request suspend EH action on the ATA device associated with
438 * @sdev and wait for the operation to complete.
441 * Kernel thread context (may sleep).
444 * 0 on success, -errno otherwise.
446 int ata_scsi_device_suspend(struct scsi_device *sdev, pm_message_t mesg)
448 struct ata_port *ap = ata_shost_to_port(sdev->host);
449 struct ata_device *dev = ata_scsi_find_dev(ap, sdev);
457 spin_lock_irqsave(ap->lock, flags);
459 /* wait for the previous resume to complete */
460 while (dev->flags & ATA_DFLAG_SUSPENDED) {
461 spin_unlock_irqrestore(ap->lock, flags);
462 ata_port_wait_eh(ap);
463 spin_lock_irqsave(ap->lock, flags);
466 /* if @sdev is already detached, nothing to do */
467 if (sdev->sdev_state == SDEV_OFFLINE ||
468 sdev->sdev_state == SDEV_CANCEL || sdev->sdev_state == SDEV_DEL)
471 /* request suspend */
472 action = ATA_EH_SUSPEND;
473 if (mesg.event != PM_EVENT_SUSPEND)
474 action |= ATA_EH_PM_FREEZE;
475 ap->eh_info.dev_action[dev->devno] |= action;
476 ap->eh_info.flags |= ATA_EHI_QUIET;
477 ata_port_schedule_eh(ap);
479 spin_unlock_irqrestore(ap->lock, flags);
481 /* wait for EH to do the job */
482 ata_port_wait_eh(ap);
484 spin_lock_irqsave(ap->lock, flags);
486 /* If @sdev is still attached but the associated ATA device
487 * isn't suspended, the operation failed.
489 if (sdev->sdev_state != SDEV_OFFLINE &&
490 sdev->sdev_state != SDEV_CANCEL && sdev->sdev_state != SDEV_DEL &&
491 !(dev->flags & ATA_DFLAG_SUSPENDED))
495 spin_unlock_irqrestore(ap->lock, flags);
498 sdev->sdev_gendev.power.power_state = mesg;
503 * ata_scsi_device_resume - resume ATA device associated with sdev
504 * @sdev: the SCSI device to resume
506 * Request resume EH action on the ATA device associated with
507 * @sdev and return immediately. This enables parallel
508 * wakeup/spinup of devices.
511 * Kernel thread context (may sleep).
516 int ata_scsi_device_resume(struct scsi_device *sdev)
518 struct ata_port *ap = ata_shost_to_port(sdev->host);
519 struct ata_device *dev = ata_scsi_find_dev(ap, sdev);
520 struct ata_eh_info *ehi = &ap->eh_info;
527 spin_lock_irqsave(ap->lock, flags);
529 /* if @sdev is already detached, nothing to do */
530 if (sdev->sdev_state == SDEV_OFFLINE ||
531 sdev->sdev_state == SDEV_CANCEL || sdev->sdev_state == SDEV_DEL)
535 action = ATA_EH_RESUME;
536 if (sdev->sdev_gendev.power.power_state.event == PM_EVENT_SUSPEND)
537 __ata_ehi_hotplugged(ehi);
539 action |= ATA_EH_PM_FREEZE | ATA_EH_SOFTRESET;
540 ehi->dev_action[dev->devno] |= action;
542 /* We don't want autopsy and verbose EH messages. Disable
543 * those if we're the only device on this link.
545 if (ata_port_max_devices(ap) == 1)
546 ehi->flags |= ATA_EHI_NO_AUTOPSY | ATA_EHI_QUIET;
548 ata_port_schedule_eh(ap);
551 spin_unlock_irqrestore(ap->lock, flags);
553 sdev->sdev_gendev.power.power_state = PMSG_ON;
558 * ata_to_sense_error - convert ATA error to SCSI error
559 * @id: ATA device number
560 * @drv_stat: value contained in ATA status register
561 * @drv_err: value contained in ATA error register
562 * @sk: the sense key we'll fill out
563 * @asc: the additional sense code we'll fill out
564 * @ascq: the additional sense code qualifier we'll fill out
565 * @verbose: be verbose
567 * Converts an ATA error into a SCSI error. Fill out pointers to
568 * SK, ASC, and ASCQ bytes for later use in fixed or descriptor
569 * format sense blocks.
572 * spin_lock_irqsave(host lock)
574 void ata_to_sense_error(unsigned id, u8 drv_stat, u8 drv_err, u8 *sk, u8 *asc,
575 u8 *ascq, int verbose)
579 /* Based on the 3ware driver translation table */
580 static const unsigned char sense_table[][4] = {
582 {0xd1, ABORTED_COMMAND, 0x00, 0x00}, // Device busy Aborted command
584 {0xd0, ABORTED_COMMAND, 0x00, 0x00}, // Device busy Aborted command
586 {0x61, HARDWARE_ERROR, 0x00, 0x00}, // Device fault Hardware error
587 /* ICRC|ABRT */ /* NB: ICRC & !ABRT is BBD */
588 {0x84, ABORTED_COMMAND, 0x47, 0x00}, // Data CRC error SCSI parity error
589 /* MC|ID|ABRT|TRK0|MARK */
590 {0x37, NOT_READY, 0x04, 0x00}, // Unit offline Not ready
592 {0x09, NOT_READY, 0x04, 0x00}, // Unrecovered disk error Not ready
593 /* Bad address mark */
594 {0x01, MEDIUM_ERROR, 0x13, 0x00}, // Address mark not found Address mark not found for data field
596 {0x02, HARDWARE_ERROR, 0x00, 0x00}, // Track 0 not found Hardware error
598 {0x04, ABORTED_COMMAND, 0x00, 0x00}, // Aborted command Aborted command
599 /* Media change request */
600 {0x08, NOT_READY, 0x04, 0x00}, // Media change request FIXME: faking offline
602 {0x10, ABORTED_COMMAND, 0x14, 0x00}, // ID not found Recorded entity not found
604 {0x08, NOT_READY, 0x04, 0x00}, // Media change FIXME: faking offline
606 {0x40, MEDIUM_ERROR, 0x11, 0x04}, // Uncorrectable ECC error Unrecovered read error
607 /* BBD - block marked bad */
608 {0x80, MEDIUM_ERROR, 0x11, 0x04}, // Block marked bad Medium error, unrecovered read error
609 {0xFF, 0xFF, 0xFF, 0xFF}, // END mark
611 static const unsigned char stat_table[][4] = {
612 /* Must be first because BUSY means no other bits valid */
613 {0x80, ABORTED_COMMAND, 0x47, 0x00}, // Busy, fake parity for now
614 {0x20, HARDWARE_ERROR, 0x00, 0x00}, // Device fault
615 {0x08, ABORTED_COMMAND, 0x47, 0x00}, // Timed out in xfer, fake parity for now
616 {0x04, RECOVERED_ERROR, 0x11, 0x00}, // Recovered ECC error Medium error, recovered
617 {0xFF, 0xFF, 0xFF, 0xFF}, // END mark
621 * Is this an error we can process/parse
623 if (drv_stat & ATA_BUSY) {
624 drv_err = 0; /* Ignore the err bits, they're invalid */
628 /* Look for drv_err */
629 for (i = 0; sense_table[i][0] != 0xFF; i++) {
630 /* Look for best matches first */
631 if ((sense_table[i][0] & drv_err) ==
633 *sk = sense_table[i][1];
634 *asc = sense_table[i][2];
635 *ascq = sense_table[i][3];
639 /* No immediate match */
641 printk(KERN_WARNING "ata%u: no sense translation for "
642 "error 0x%02x\n", id, drv_err);
645 /* Fall back to interpreting status bits */
646 for (i = 0; stat_table[i][0] != 0xFF; i++) {
647 if (stat_table[i][0] & drv_stat) {
648 *sk = stat_table[i][1];
649 *asc = stat_table[i][2];
650 *ascq = stat_table[i][3];
654 /* No error? Undecoded? */
656 printk(KERN_WARNING "ata%u: no sense translation for "
657 "status: 0x%02x\n", id, drv_stat);
659 /* We need a sensible error return here, which is tricky, and one
660 that won't cause people to do things like return a disk wrongly */
661 *sk = ABORTED_COMMAND;
667 printk(KERN_ERR "ata%u: translated ATA stat/err 0x%02x/%02x "
668 "to SCSI SK/ASC/ASCQ 0x%x/%02x/%02x\n",
669 id, drv_stat, drv_err, *sk, *asc, *ascq);
674 * ata_gen_passthru_sense - Generate check condition sense block.
675 * @qc: Command that completed.
677 * This function is specific to the ATA descriptor format sense
678 * block specified for the ATA pass through commands. Regardless
679 * of whether the command errored or not, return a sense
680 * block. Copy all controller registers into the sense
681 * block. Clear sense key, ASC & ASCQ if there is no error.
686 static void ata_gen_passthru_sense(struct ata_queued_cmd *qc)
688 struct scsi_cmnd *cmd = qc->scsicmd;
689 struct ata_taskfile *tf = &qc->result_tf;
690 unsigned char *sb = cmd->sense_buffer;
691 unsigned char *desc = sb + 8;
692 int verbose = qc->ap->ops->error_handler == NULL;
694 memset(sb, 0, SCSI_SENSE_BUFFERSIZE);
696 cmd->result = (DRIVER_SENSE << 24) | SAM_STAT_CHECK_CONDITION;
699 * Use ata_to_sense_error() to map status register bits
700 * onto sense key, asc & ascq.
703 tf->command & (ATA_BUSY | ATA_DF | ATA_ERR | ATA_DRQ)) {
704 ata_to_sense_error(qc->ap->id, tf->command, tf->feature,
705 &sb[1], &sb[2], &sb[3], verbose);
710 * Sense data is current and format is descriptor.
716 /* set length of additional sense data */
721 * Copy registers into sense buffer.
724 desc[3] = tf->feature; /* == error reg */
729 desc[12] = tf->device;
730 desc[13] = tf->command; /* == status reg */
733 * Fill in Extend bit, and the high order bytes
736 if (tf->flags & ATA_TFLAG_LBA48) {
738 desc[4] = tf->hob_nsect;
739 desc[6] = tf->hob_lbal;
740 desc[8] = tf->hob_lbam;
741 desc[10] = tf->hob_lbah;
746 * ata_gen_ata_sense - generate a SCSI fixed sense block
747 * @qc: Command that we are erroring out
749 * Generate sense block for a failed ATA command @qc. Descriptor
750 * format is used to accomodate LBA48 block address.
755 static void ata_gen_ata_sense(struct ata_queued_cmd *qc)
757 struct ata_device *dev = qc->dev;
758 struct scsi_cmnd *cmd = qc->scsicmd;
759 struct ata_taskfile *tf = &qc->result_tf;
760 unsigned char *sb = cmd->sense_buffer;
761 unsigned char *desc = sb + 8;
762 int verbose = qc->ap->ops->error_handler == NULL;
765 memset(sb, 0, SCSI_SENSE_BUFFERSIZE);
767 cmd->result = (DRIVER_SENSE << 24) | SAM_STAT_CHECK_CONDITION;
769 /* sense data is current and format is descriptor */
772 /* Use ata_to_sense_error() to map status register bits
773 * onto sense key, asc & ascq.
776 tf->command & (ATA_BUSY | ATA_DF | ATA_ERR | ATA_DRQ)) {
777 ata_to_sense_error(qc->ap->id, tf->command, tf->feature,
778 &sb[1], &sb[2], &sb[3], verbose);
782 block = ata_tf_read_block(&qc->result_tf, dev);
784 /* information sense data descriptor */
789 desc[2] |= 0x80; /* valid */
790 desc[6] = block >> 40;
791 desc[7] = block >> 32;
792 desc[8] = block >> 24;
793 desc[9] = block >> 16;
794 desc[10] = block >> 8;
798 static void ata_scsi_sdev_config(struct scsi_device *sdev)
800 sdev->use_10_for_rw = 1;
801 sdev->use_10_for_ms = 1;
804 static void ata_scsi_dev_config(struct scsi_device *sdev,
805 struct ata_device *dev)
807 /* configure max sectors */
808 blk_queue_max_sectors(sdev->request_queue, dev->max_sectors);
810 /* SATA DMA transfers must be multiples of 4 byte, so
811 * we need to pad ATAPI transfers using an extra sg.
812 * Decrement max hw segments accordingly.
814 if (dev->class == ATA_DEV_ATAPI) {
815 request_queue_t *q = sdev->request_queue;
816 blk_queue_max_hw_segments(q, q->max_hw_segments - 1);
819 if (dev->flags & ATA_DFLAG_NCQ) {
822 depth = min(sdev->host->can_queue, ata_id_queue_depth(dev->id));
823 depth = min(ATA_MAX_QUEUE - 1, depth);
824 scsi_adjust_queue_depth(sdev, MSG_SIMPLE_TAG, depth);
829 * ata_scsi_slave_config - Set SCSI device attributes
830 * @sdev: SCSI device to examine
832 * This is called before we actually start reading
833 * and writing to the device, to configure certain
834 * SCSI mid-layer behaviors.
837 * Defined by SCSI layer. We don't really care.
840 int ata_scsi_slave_config(struct scsi_device *sdev)
842 struct ata_port *ap = ata_shost_to_port(sdev->host);
843 struct ata_device *dev = __ata_scsi_find_dev(ap, sdev);
845 ata_scsi_sdev_config(sdev);
847 blk_queue_max_phys_segments(sdev->request_queue, LIBATA_MAX_PRD);
850 ata_scsi_dev_config(sdev, dev);
852 return 0; /* scsi layer doesn't check return value, sigh */
856 * ata_scsi_slave_destroy - SCSI device is about to be destroyed
857 * @sdev: SCSI device to be destroyed
859 * @sdev is about to be destroyed for hot/warm unplugging. If
860 * this unplugging was initiated by libata as indicated by NULL
861 * dev->sdev, this function doesn't have to do anything.
862 * Otherwise, SCSI layer initiated warm-unplug is in progress.
863 * Clear dev->sdev, schedule the device for ATA detach and invoke
867 * Defined by SCSI layer. We don't really care.
869 void ata_scsi_slave_destroy(struct scsi_device *sdev)
871 struct ata_port *ap = ata_shost_to_port(sdev->host);
873 struct ata_device *dev;
875 if (!ap->ops->error_handler)
878 spin_lock_irqsave(ap->lock, flags);
879 dev = __ata_scsi_find_dev(ap, sdev);
880 if (dev && dev->sdev) {
881 /* SCSI device already in CANCEL state, no need to offline it */
883 dev->flags |= ATA_DFLAG_DETACH;
884 ata_port_schedule_eh(ap);
886 spin_unlock_irqrestore(ap->lock, flags);
890 * ata_scsi_change_queue_depth - SCSI callback for queue depth config
891 * @sdev: SCSI device to configure queue depth for
892 * @queue_depth: new queue depth
894 * This is libata standard hostt->change_queue_depth callback.
895 * SCSI will call into this callback when user tries to set queue
899 * SCSI layer (we don't care)
902 * Newly configured queue depth.
904 int ata_scsi_change_queue_depth(struct scsi_device *sdev, int queue_depth)
906 struct ata_port *ap = ata_shost_to_port(sdev->host);
907 struct ata_device *dev;
912 return sdev->queue_depth;
914 dev = ata_scsi_find_dev(ap, sdev);
915 if (!dev || !ata_dev_enabled(dev))
916 return sdev->queue_depth;
918 max_depth = min(sdev->host->can_queue, ata_id_queue_depth(dev->id));
919 max_depth = min(ATA_MAX_QUEUE - 1, max_depth);
920 if (queue_depth > max_depth)
921 queue_depth = max_depth;
923 scsi_adjust_queue_depth(sdev, MSG_SIMPLE_TAG, queue_depth);
925 spin_lock_irqsave(ap->lock, flags);
927 dev->flags &= ~ATA_DFLAG_NCQ_OFF;
929 dev->flags |= ATA_DFLAG_NCQ_OFF;
930 spin_unlock_irqrestore(ap->lock, flags);
936 * ata_scsi_start_stop_xlat - Translate SCSI START STOP UNIT command
937 * @qc: Storage for translated ATA taskfile
938 * @cdb: SCSI command to translate
940 * Sets up an ATA taskfile to issue STANDBY (to stop) or READ VERIFY
941 * (to start). Perhaps these commands should be preceded by
942 * CHECK POWER MODE to see what power mode the device is already in.
943 * [See SAT revision 5 at www.t10.org]
946 * spin_lock_irqsave(host lock)
949 * Zero on success, non-zero on error.
951 static unsigned int ata_scsi_start_stop_xlat(struct ata_queued_cmd *qc,
954 struct scsi_cmnd *scmd = qc->scsicmd;
955 struct ata_taskfile *tf = &qc->tf;
957 tf->flags |= ATA_TFLAG_DEVICE | ATA_TFLAG_ISADDR;
958 tf->protocol = ATA_PROT_NODATA;
960 ; /* ignore IMMED bit, violates sat-r05 */
963 goto invalid_fld; /* LOEJ bit set not supported */
964 if (((cdb[4] >> 4) & 0xf) != 0)
965 goto invalid_fld; /* power conditions not supported */
967 tf->nsect = 1; /* 1 sector, lba=0 */
969 if (qc->dev->flags & ATA_DFLAG_LBA) {
970 tf->flags |= ATA_TFLAG_LBA;
975 tf->device |= ATA_LBA;
978 tf->lbal = 0x1; /* sect */
979 tf->lbam = 0x0; /* cyl low */
980 tf->lbah = 0x0; /* cyl high */
983 tf->command = ATA_CMD_VERIFY; /* READ VERIFY */
985 tf->nsect = 0; /* time period value (0 implies now) */
986 tf->command = ATA_CMD_STANDBY;
987 /* Consider: ATA STANDBY IMMEDIATE command */
990 * Standby and Idle condition timers could be implemented but that
991 * would require libata to implement the Power condition mode page
992 * and allow the user to change it. Changing mode pages requires
993 * MODE SELECT to be implemented.
999 ata_scsi_set_sense(scmd, ILLEGAL_REQUEST, 0x24, 0x0);
1000 /* "Invalid field in cbd" */
1006 * ata_scsi_flush_xlat - Translate SCSI SYNCHRONIZE CACHE command
1007 * @qc: Storage for translated ATA taskfile
1008 * @cdb: SCSI command to translate (ignored)
1010 * Sets up an ATA taskfile to issue FLUSH CACHE or
1014 * spin_lock_irqsave(host lock)
1017 * Zero on success, non-zero on error.
1019 static unsigned int ata_scsi_flush_xlat(struct ata_queued_cmd *qc, const u8 *cdb)
1021 struct ata_taskfile *tf = &qc->tf;
1023 tf->flags |= ATA_TFLAG_DEVICE;
1024 tf->protocol = ATA_PROT_NODATA;
1026 if (qc->dev->flags & ATA_DFLAG_FLUSH_EXT)
1027 tf->command = ATA_CMD_FLUSH_EXT;
1029 tf->command = ATA_CMD_FLUSH;
1035 * scsi_6_lba_len - Get LBA and transfer length
1036 * @cdb: SCSI command to translate
1038 * Calculate LBA and transfer length for 6-byte commands.
1042 * @plen: the transfer length
1044 static void scsi_6_lba_len(const u8 *cdb, u64 *plba, u32 *plen)
1049 VPRINTK("six-byte command\n");
1051 lba |= ((u64)cdb[2]) << 8;
1052 lba |= ((u64)cdb[3]);
1054 len |= ((u32)cdb[4]);
1061 * scsi_10_lba_len - Get LBA and transfer length
1062 * @cdb: SCSI command to translate
1064 * Calculate LBA and transfer length for 10-byte commands.
1068 * @plen: the transfer length
1070 static void scsi_10_lba_len(const u8 *cdb, u64 *plba, u32 *plen)
1075 VPRINTK("ten-byte command\n");
1077 lba |= ((u64)cdb[2]) << 24;
1078 lba |= ((u64)cdb[3]) << 16;
1079 lba |= ((u64)cdb[4]) << 8;
1080 lba |= ((u64)cdb[5]);
1082 len |= ((u32)cdb[7]) << 8;
1083 len |= ((u32)cdb[8]);
1090 * scsi_16_lba_len - Get LBA and transfer length
1091 * @cdb: SCSI command to translate
1093 * Calculate LBA and transfer length for 16-byte commands.
1097 * @plen: the transfer length
1099 static void scsi_16_lba_len(const u8 *cdb, u64 *plba, u32 *plen)
1104 VPRINTK("sixteen-byte command\n");
1106 lba |= ((u64)cdb[2]) << 56;
1107 lba |= ((u64)cdb[3]) << 48;
1108 lba |= ((u64)cdb[4]) << 40;
1109 lba |= ((u64)cdb[5]) << 32;
1110 lba |= ((u64)cdb[6]) << 24;
1111 lba |= ((u64)cdb[7]) << 16;
1112 lba |= ((u64)cdb[8]) << 8;
1113 lba |= ((u64)cdb[9]);
1115 len |= ((u32)cdb[10]) << 24;
1116 len |= ((u32)cdb[11]) << 16;
1117 len |= ((u32)cdb[12]) << 8;
1118 len |= ((u32)cdb[13]);
1125 * ata_scsi_verify_xlat - Translate SCSI VERIFY command into an ATA one
1126 * @qc: Storage for translated ATA taskfile
1127 * @cdb: SCSI command to translate
1129 * Converts SCSI VERIFY command to an ATA READ VERIFY command.
1132 * spin_lock_irqsave(host lock)
1135 * Zero on success, non-zero on error.
1137 static unsigned int ata_scsi_verify_xlat(struct ata_queued_cmd *qc, const u8 *cdb)
1139 struct scsi_cmnd *scmd = qc->scsicmd;
1140 struct ata_taskfile *tf = &qc->tf;
1141 struct ata_device *dev = qc->dev;
1142 u64 dev_sectors = qc->dev->n_sectors;
1146 tf->flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
1147 tf->protocol = ATA_PROT_NODATA;
1149 if (cdb[0] == VERIFY)
1150 scsi_10_lba_len(cdb, &block, &n_block);
1151 else if (cdb[0] == VERIFY_16)
1152 scsi_16_lba_len(cdb, &block, &n_block);
1158 if (block >= dev_sectors)
1160 if ((block + n_block) > dev_sectors)
1163 if (dev->flags & ATA_DFLAG_LBA) {
1164 tf->flags |= ATA_TFLAG_LBA;
1166 if (lba_28_ok(block, n_block)) {
1168 tf->command = ATA_CMD_VERIFY;
1169 tf->device |= (block >> 24) & 0xf;
1170 } else if (lba_48_ok(block, n_block)) {
1171 if (!(dev->flags & ATA_DFLAG_LBA48))
1175 tf->flags |= ATA_TFLAG_LBA48;
1176 tf->command = ATA_CMD_VERIFY_EXT;
1178 tf->hob_nsect = (n_block >> 8) & 0xff;
1180 tf->hob_lbah = (block >> 40) & 0xff;
1181 tf->hob_lbam = (block >> 32) & 0xff;
1182 tf->hob_lbal = (block >> 24) & 0xff;
1184 /* request too large even for LBA48 */
1187 tf->nsect = n_block & 0xff;
1189 tf->lbah = (block >> 16) & 0xff;
1190 tf->lbam = (block >> 8) & 0xff;
1191 tf->lbal = block & 0xff;
1193 tf->device |= ATA_LBA;
1196 u32 sect, head, cyl, track;
1198 if (!lba_28_ok(block, n_block))
1201 /* Convert LBA to CHS */
1202 track = (u32)block / dev->sectors;
1203 cyl = track / dev->heads;
1204 head = track % dev->heads;
1205 sect = (u32)block % dev->sectors + 1;
1207 DPRINTK("block %u track %u cyl %u head %u sect %u\n",
1208 (u32)block, track, cyl, head, sect);
1210 /* Check whether the converted CHS can fit.
1214 if ((cyl >> 16) || (head >> 4) || (sect >> 8) || (!sect))
1217 tf->command = ATA_CMD_VERIFY;
1218 tf->nsect = n_block & 0xff; /* Sector count 0 means 256 sectors */
1221 tf->lbah = cyl >> 8;
1228 ata_scsi_set_sense(scmd, ILLEGAL_REQUEST, 0x24, 0x0);
1229 /* "Invalid field in cbd" */
1233 ata_scsi_set_sense(scmd, ILLEGAL_REQUEST, 0x21, 0x0);
1234 /* "Logical Block Address out of range" */
1238 scmd->result = SAM_STAT_GOOD;
1243 * ata_scsi_rw_xlat - Translate SCSI r/w command into an ATA one
1244 * @qc: Storage for translated ATA taskfile
1245 * @cdb: SCSI command to translate
1247 * Converts any of six SCSI read/write commands into the
1248 * ATA counterpart, including starting sector (LBA),
1249 * sector count, and taking into account the device's LBA48
1252 * Commands %READ_6, %READ_10, %READ_16, %WRITE_6, %WRITE_10, and
1253 * %WRITE_16 are currently supported.
1256 * spin_lock_irqsave(host lock)
1259 * Zero on success, non-zero on error.
1261 static unsigned int ata_scsi_rw_xlat(struct ata_queued_cmd *qc, const u8 *cdb)
1263 struct scsi_cmnd *scmd = qc->scsicmd;
1264 unsigned int tf_flags = 0;
1269 if (cdb[0] == WRITE_10 || cdb[0] == WRITE_6 || cdb[0] == WRITE_16)
1270 tf_flags |= ATA_TFLAG_WRITE;
1272 /* Calculate the SCSI LBA, transfer length and FUA. */
1276 scsi_10_lba_len(cdb, &block, &n_block);
1277 if (unlikely(cdb[1] & (1 << 3)))
1278 tf_flags |= ATA_TFLAG_FUA;
1282 scsi_6_lba_len(cdb, &block, &n_block);
1284 /* for 6-byte r/w commands, transfer length 0
1285 * means 256 blocks of data, not 0 block.
1292 scsi_16_lba_len(cdb, &block, &n_block);
1293 if (unlikely(cdb[1] & (1 << 3)))
1294 tf_flags |= ATA_TFLAG_FUA;
1297 DPRINTK("no-byte command\n");
1301 /* Check and compose ATA command */
1303 /* For 10-byte and 16-byte SCSI R/W commands, transfer
1304 * length 0 means transfer 0 block of data.
1305 * However, for ATA R/W commands, sector count 0 means
1306 * 256 or 65536 sectors, not 0 sectors as in SCSI.
1308 * WARNING: one or two older ATA drives treat 0 as 0...
1312 qc->flags |= ATA_QCFLAG_IO;
1313 qc->nsect = n_block;
1315 rc = ata_build_rw_tf(&qc->tf, qc->dev, block, n_block, tf_flags,
1317 if (likely(rc == 0))
1322 /* treat all other errors as -EINVAL, fall through */
1324 ata_scsi_set_sense(scmd, ILLEGAL_REQUEST, 0x24, 0x0);
1325 /* "Invalid field in cbd" */
1329 ata_scsi_set_sense(scmd, ILLEGAL_REQUEST, 0x21, 0x0);
1330 /* "Logical Block Address out of range" */
1334 scmd->result = SAM_STAT_GOOD;
1338 static void ata_scsi_qc_complete(struct ata_queued_cmd *qc)
1340 struct ata_port *ap = qc->ap;
1341 struct scsi_cmnd *cmd = qc->scsicmd;
1342 u8 *cdb = cmd->cmnd;
1343 int need_sense = (qc->err_mask != 0);
1345 /* We snoop the SET_FEATURES - Write Cache ON/OFF command, and
1346 * schedule EH_REVALIDATE operation to update the IDENTIFY DEVICE
1349 if (ap->ops->error_handler &&
1350 !need_sense && (qc->tf.command == ATA_CMD_SET_FEATURES) &&
1351 ((qc->tf.feature == SETFEATURES_WC_ON) ||
1352 (qc->tf.feature == SETFEATURES_WC_OFF))) {
1353 ap->eh_info.action |= ATA_EH_REVALIDATE;
1354 ata_port_schedule_eh(ap);
1357 /* For ATA pass thru (SAT) commands, generate a sense block if
1358 * user mandated it or if there's an error. Note that if we
1359 * generate because the user forced us to, a check condition
1360 * is generated and the ATA register values are returned
1361 * whether the command completed successfully or not. If there
1362 * was no error, SK, ASC and ASCQ will all be zero.
1364 if (((cdb[0] == ATA_16) || (cdb[0] == ATA_12)) &&
1365 ((cdb[2] & 0x20) || need_sense)) {
1366 ata_gen_passthru_sense(qc);
1369 cmd->result = SAM_STAT_GOOD;
1371 /* TODO: decide which descriptor format to use
1372 * for 48b LBA devices and call that here
1373 * instead of the fixed desc, which is only
1374 * good for smaller LBA (and maybe CHS?)
1377 ata_gen_ata_sense(qc);
1381 if (need_sense && !ap->ops->error_handler)
1382 ata_dump_status(ap->id, &qc->result_tf);
1390 * ata_scmd_need_defer - Check whether we need to defer scmd
1391 * @dev: ATA device to which the command is addressed
1392 * @is_io: Is the command IO (and thus possibly NCQ)?
1394 * NCQ and non-NCQ commands cannot run together. As upper layer
1395 * only knows the queue depth, we are responsible for maintaining
1396 * exclusion. This function checks whether a new command can be
1400 * spin_lock_irqsave(host lock)
1403 * 1 if deferring is needed, 0 otherwise.
1405 static int ata_scmd_need_defer(struct ata_device *dev, int is_io)
1407 struct ata_port *ap = dev->ap;
1409 if (!(dev->flags & ATA_DFLAG_NCQ))
1413 if (!ata_tag_valid(ap->active_tag))
1416 if (!ata_tag_valid(ap->active_tag) && !ap->sactive)
1423 * ata_scsi_translate - Translate then issue SCSI command to ATA device
1424 * @dev: ATA device to which the command is addressed
1425 * @cmd: SCSI command to execute
1426 * @done: SCSI command completion function
1427 * @xlat_func: Actor which translates @cmd to an ATA taskfile
1429 * Our ->queuecommand() function has decided that the SCSI
1430 * command issued can be directly translated into an ATA
1431 * command, rather than handled internally.
1433 * This function sets up an ata_queued_cmd structure for the
1434 * SCSI command, and sends that ata_queued_cmd to the hardware.
1436 * The xlat_func argument (actor) returns 0 if ready to execute
1437 * ATA command, else 1 to finish translation. If 1 is returned
1438 * then cmd->result (and possibly cmd->sense_buffer) are assumed
1439 * to be set reflecting an error condition or clean (early)
1443 * spin_lock_irqsave(host lock)
1446 * 0 on success, SCSI_ML_QUEUE_DEVICE_BUSY if the command
1447 * needs to be deferred.
1449 static int ata_scsi_translate(struct ata_device *dev, struct scsi_cmnd *cmd,
1450 void (*done)(struct scsi_cmnd *),
1451 ata_xlat_func_t xlat_func)
1453 struct ata_queued_cmd *qc;
1454 u8 *cdb = cmd->cmnd;
1455 int is_io = xlat_func == ata_scsi_rw_xlat;
1459 if (unlikely(ata_scmd_need_defer(dev, is_io)))
1462 qc = ata_scsi_qc_new(dev, cmd, done);
1466 /* data is present; dma-map it */
1467 if (cmd->sc_data_direction == DMA_FROM_DEVICE ||
1468 cmd->sc_data_direction == DMA_TO_DEVICE) {
1469 if (unlikely(cmd->request_bufflen < 1)) {
1470 ata_dev_printk(dev, KERN_WARNING,
1471 "WARNING: zero len r/w req\n");
1476 ata_sg_init(qc, cmd->request_buffer, cmd->use_sg);
1478 ata_sg_init_one(qc, cmd->request_buffer,
1479 cmd->request_bufflen);
1481 qc->dma_dir = cmd->sc_data_direction;
1484 qc->complete_fn = ata_scsi_qc_complete;
1486 if (xlat_func(qc, cdb))
1489 /* select device, send command to hardware */
1498 DPRINTK("EXIT - early finish (good or error)\n");
1503 cmd->result = (DID_ERROR << 16);
1506 DPRINTK("EXIT - internal\n");
1510 DPRINTK("EXIT - defer\n");
1511 return SCSI_MLQUEUE_DEVICE_BUSY;
1515 * ata_scsi_rbuf_get - Map response buffer.
1516 * @cmd: SCSI command containing buffer to be mapped.
1517 * @buf_out: Pointer to mapped area.
1519 * Maps buffer contained within SCSI command @cmd.
1522 * spin_lock_irqsave(host lock)
1525 * Length of response buffer.
1528 static unsigned int ata_scsi_rbuf_get(struct scsi_cmnd *cmd, u8 **buf_out)
1531 unsigned int buflen;
1534 struct scatterlist *sg;
1536 sg = (struct scatterlist *) cmd->request_buffer;
1537 buf = kmap_atomic(sg->page, KM_IRQ0) + sg->offset;
1538 buflen = sg->length;
1540 buf = cmd->request_buffer;
1541 buflen = cmd->request_bufflen;
1549 * ata_scsi_rbuf_put - Unmap response buffer.
1550 * @cmd: SCSI command containing buffer to be unmapped.
1551 * @buf: buffer to unmap
1553 * Unmaps response buffer contained within @cmd.
1556 * spin_lock_irqsave(host lock)
1559 static inline void ata_scsi_rbuf_put(struct scsi_cmnd *cmd, u8 *buf)
1562 struct scatterlist *sg;
1564 sg = (struct scatterlist *) cmd->request_buffer;
1565 kunmap_atomic(buf - sg->offset, KM_IRQ0);
1570 * ata_scsi_rbuf_fill - wrapper for SCSI command simulators
1571 * @args: device IDENTIFY data / SCSI command of interest.
1572 * @actor: Callback hook for desired SCSI command simulator
1574 * Takes care of the hard work of simulating a SCSI command...
1575 * Mapping the response buffer, calling the command's handler,
1576 * and handling the handler's return value. This return value
1577 * indicates whether the handler wishes the SCSI command to be
1578 * completed successfully (0), or not (in which case cmd->result
1579 * and sense buffer are assumed to be set).
1582 * spin_lock_irqsave(host lock)
1585 void ata_scsi_rbuf_fill(struct ata_scsi_args *args,
1586 unsigned int (*actor) (struct ata_scsi_args *args,
1587 u8 *rbuf, unsigned int buflen))
1590 unsigned int buflen, rc;
1591 struct scsi_cmnd *cmd = args->cmd;
1593 buflen = ata_scsi_rbuf_get(cmd, &rbuf);
1594 memset(rbuf, 0, buflen);
1595 rc = actor(args, rbuf, buflen);
1596 ata_scsi_rbuf_put(cmd, rbuf);
1599 cmd->result = SAM_STAT_GOOD;
1604 * ATA_SCSI_RBUF_SET - helper to set values in SCSI response buffer
1605 * @idx: byte index into SCSI response buffer
1606 * @val: value to set
1608 * To be used by SCSI command simulator functions. This macros
1609 * expects two local variables, u8 *rbuf and unsigned int buflen,
1615 #define ATA_SCSI_RBUF_SET(idx, val) do { \
1616 if ((idx) < buflen) rbuf[(idx)] = (u8)(val); \
1620 * ata_scsiop_inq_std - Simulate INQUIRY command
1621 * @args: device IDENTIFY data / SCSI command of interest.
1622 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1623 * @buflen: Response buffer length.
1625 * Returns standard device identification data associated
1626 * with non-VPD INQUIRY command output.
1629 * spin_lock_irqsave(host lock)
1632 unsigned int ata_scsiop_inq_std(struct ata_scsi_args *args, u8 *rbuf,
1633 unsigned int buflen)
1638 0x5, /* claim SPC-3 version compatibility */
1643 /* set scsi removeable (RMB) bit per ata bit */
1644 if (ata_id_removeable(args->id))
1649 memcpy(rbuf, hdr, sizeof(hdr));
1652 memcpy(&rbuf[8], "ATA ", 8);
1653 ata_id_string(args->id, &rbuf[16], ATA_ID_PROD_OFS, 16);
1654 ata_id_string(args->id, &rbuf[32], ATA_ID_FW_REV_OFS, 4);
1655 if (rbuf[32] == 0 || rbuf[32] == ' ')
1656 memcpy(&rbuf[32], "n/a ", 4);
1660 const u8 versions[] = {
1661 0x60, /* SAM-3 (no version claimed) */
1664 0x20, /* SBC-2 (no version claimed) */
1667 0x60 /* SPC-3 (no version claimed) */
1670 memcpy(rbuf + 59, versions, sizeof(versions));
1677 * ata_scsiop_inq_00 - Simulate INQUIRY VPD page 0, list of pages
1678 * @args: device IDENTIFY data / SCSI command of interest.
1679 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1680 * @buflen: Response buffer length.
1682 * Returns list of inquiry VPD pages available.
1685 * spin_lock_irqsave(host lock)
1688 unsigned int ata_scsiop_inq_00(struct ata_scsi_args *args, u8 *rbuf,
1689 unsigned int buflen)
1691 const u8 pages[] = {
1692 0x00, /* page 0x00, this page */
1693 0x80, /* page 0x80, unit serial no page */
1694 0x83 /* page 0x83, device ident page */
1696 rbuf[3] = sizeof(pages); /* number of supported VPD pages */
1699 memcpy(rbuf + 4, pages, sizeof(pages));
1705 * ata_scsiop_inq_80 - Simulate INQUIRY VPD page 80, device serial number
1706 * @args: device IDENTIFY data / SCSI command of interest.
1707 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1708 * @buflen: Response buffer length.
1710 * Returns ATA device serial number.
1713 * spin_lock_irqsave(host lock)
1716 unsigned int ata_scsiop_inq_80(struct ata_scsi_args *args, u8 *rbuf,
1717 unsigned int buflen)
1721 0x80, /* this page code */
1723 ATA_SERNO_LEN, /* page len */
1725 memcpy(rbuf, hdr, sizeof(hdr));
1727 if (buflen > (ATA_SERNO_LEN + 4 - 1))
1728 ata_id_string(args->id, (unsigned char *) &rbuf[4],
1729 ATA_ID_SERNO_OFS, ATA_SERNO_LEN);
1735 * ata_scsiop_inq_83 - Simulate INQUIRY VPD page 83, device identity
1736 * @args: device IDENTIFY data / SCSI command of interest.
1737 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1738 * @buflen: Response buffer length.
1740 * Yields two logical unit device identification designators:
1741 * - vendor specific ASCII containing the ATA serial number
1742 * - SAT defined "t10 vendor id based" containing ASCII vendor
1743 * name ("ATA "), model and serial numbers.
1746 * spin_lock_irqsave(host lock)
1749 unsigned int ata_scsiop_inq_83(struct ata_scsi_args *args, u8 *rbuf,
1750 unsigned int buflen)
1753 const int sat_model_serial_desc_len = 68;
1754 const int ata_model_byte_len = 40;
1756 rbuf[1] = 0x83; /* this page code */
1759 if (buflen > (ATA_SERNO_LEN + num + 3)) {
1760 /* piv=0, assoc=lu, code_set=ACSII, designator=vendor */
1762 rbuf[num + 3] = ATA_SERNO_LEN;
1764 ata_id_string(args->id, (unsigned char *) rbuf + num,
1765 ATA_ID_SERNO_OFS, ATA_SERNO_LEN);
1766 num += ATA_SERNO_LEN;
1768 if (buflen > (sat_model_serial_desc_len + num + 3)) {
1769 /* SAT defined lu model and serial numbers descriptor */
1770 /* piv=0, assoc=lu, code_set=ACSII, designator=t10 vendor id */
1773 rbuf[num + 3] = sat_model_serial_desc_len;
1775 memcpy(rbuf + num, "ATA ", 8);
1777 ata_id_string(args->id, (unsigned char *) rbuf + num,
1778 ATA_ID_PROD_OFS, ata_model_byte_len);
1779 num += ata_model_byte_len;
1780 ata_id_string(args->id, (unsigned char *) rbuf + num,
1781 ATA_ID_SERNO_OFS, ATA_SERNO_LEN);
1782 num += ATA_SERNO_LEN;
1784 rbuf[3] = num - 4; /* page len (assume less than 256 bytes) */
1789 * ata_scsiop_noop - Command handler that simply returns success.
1790 * @args: device IDENTIFY data / SCSI command of interest.
1791 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1792 * @buflen: Response buffer length.
1794 * No operation. Simply returns success to caller, to indicate
1795 * that the caller should successfully complete this SCSI command.
1798 * spin_lock_irqsave(host lock)
1801 unsigned int ata_scsiop_noop(struct ata_scsi_args *args, u8 *rbuf,
1802 unsigned int buflen)
1809 * ata_msense_push - Push data onto MODE SENSE data output buffer
1810 * @ptr_io: (input/output) Location to store more output data
1811 * @last: End of output data buffer
1812 * @buf: Pointer to BLOB being added to output buffer
1813 * @buflen: Length of BLOB
1815 * Store MODE SENSE data on an output buffer.
1821 static void ata_msense_push(u8 **ptr_io, const u8 *last,
1822 const u8 *buf, unsigned int buflen)
1826 if ((ptr + buflen - 1) > last)
1829 memcpy(ptr, buf, buflen);
1837 * ata_msense_caching - Simulate MODE SENSE caching info page
1838 * @id: device IDENTIFY data
1839 * @ptr_io: (input/output) Location to store more output data
1840 * @last: End of output data buffer
1842 * Generate a caching info page, which conditionally indicates
1843 * write caching to the SCSI layer, depending on device
1850 static unsigned int ata_msense_caching(u16 *id, u8 **ptr_io,
1853 u8 page[CACHE_MPAGE_LEN];
1855 memcpy(page, def_cache_mpage, sizeof(page));
1856 if (ata_id_wcache_enabled(id))
1857 page[2] |= (1 << 2); /* write cache enable */
1858 if (!ata_id_rahead_enabled(id))
1859 page[12] |= (1 << 5); /* disable read ahead */
1861 ata_msense_push(ptr_io, last, page, sizeof(page));
1862 return sizeof(page);
1866 * ata_msense_ctl_mode - Simulate MODE SENSE control mode page
1867 * @dev: Device associated with this MODE SENSE command
1868 * @ptr_io: (input/output) Location to store more output data
1869 * @last: End of output data buffer
1871 * Generate a generic MODE SENSE control mode page.
1877 static unsigned int ata_msense_ctl_mode(u8 **ptr_io, const u8 *last)
1879 ata_msense_push(ptr_io, last, def_control_mpage,
1880 sizeof(def_control_mpage));
1881 return sizeof(def_control_mpage);
1885 * ata_msense_rw_recovery - Simulate MODE SENSE r/w error recovery page
1886 * @dev: Device associated with this MODE SENSE command
1887 * @ptr_io: (input/output) Location to store more output data
1888 * @last: End of output data buffer
1890 * Generate a generic MODE SENSE r/w error recovery page.
1896 static unsigned int ata_msense_rw_recovery(u8 **ptr_io, const u8 *last)
1899 ata_msense_push(ptr_io, last, def_rw_recovery_mpage,
1900 sizeof(def_rw_recovery_mpage));
1901 return sizeof(def_rw_recovery_mpage);
1905 * We can turn this into a real blacklist if it's needed, for now just
1906 * blacklist any Maxtor BANC1G10 revision firmware
1908 static int ata_dev_supports_fua(u16 *id)
1910 unsigned char model[41], fw[9];
1914 if (!ata_id_has_fua(id))
1917 ata_id_c_string(id, model, ATA_ID_PROD_OFS, sizeof(model));
1918 ata_id_c_string(id, fw, ATA_ID_FW_REV_OFS, sizeof(fw));
1920 if (strcmp(model, "Maxtor"))
1922 if (strcmp(fw, "BANC1G10"))
1925 return 0; /* blacklisted */
1929 * ata_scsiop_mode_sense - Simulate MODE SENSE 6, 10 commands
1930 * @args: device IDENTIFY data / SCSI command of interest.
1931 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1932 * @buflen: Response buffer length.
1934 * Simulate MODE SENSE commands. Assume this is invoked for direct
1935 * access devices (e.g. disks) only. There should be no block
1936 * descriptor for other device types.
1939 * spin_lock_irqsave(host lock)
1942 unsigned int ata_scsiop_mode_sense(struct ata_scsi_args *args, u8 *rbuf,
1943 unsigned int buflen)
1945 struct ata_device *dev = args->dev;
1946 u8 *scsicmd = args->cmd->cmnd, *p, *last;
1947 const u8 sat_blk_desc[] = {
1948 0, 0, 0, 0, /* number of blocks: sat unspecified */
1950 0, 0x2, 0x0 /* block length: 512 bytes */
1953 unsigned int ebd, page_control, six_byte, output_len, alloc_len, minlen;
1958 six_byte = (scsicmd[0] == MODE_SENSE);
1959 ebd = !(scsicmd[1] & 0x8); /* dbd bit inverted == edb */
1961 * LLBA bit in msense(10) ignored (compliant)
1964 page_control = scsicmd[2] >> 6;
1965 switch (page_control) {
1966 case 0: /* current */
1967 break; /* supported */
1969 goto saving_not_supp;
1970 case 1: /* changeable */
1971 case 2: /* defaults */
1977 output_len = 4 + (ebd ? 8 : 0);
1978 alloc_len = scsicmd[4];
1980 output_len = 8 + (ebd ? 8 : 0);
1981 alloc_len = (scsicmd[7] << 8) + scsicmd[8];
1983 minlen = (alloc_len < buflen) ? alloc_len : buflen;
1985 p = rbuf + output_len;
1986 last = rbuf + minlen - 1;
1988 pg = scsicmd[2] & 0x3f;
1991 * No mode subpages supported (yet) but asking for _all_
1992 * subpages may be valid
1994 if (spg && (spg != ALL_SUB_MPAGES))
1998 case RW_RECOVERY_MPAGE:
1999 output_len += ata_msense_rw_recovery(&p, last);
2003 output_len += ata_msense_caching(args->id, &p, last);
2006 case CONTROL_MPAGE: {
2007 output_len += ata_msense_ctl_mode(&p, last);
2012 output_len += ata_msense_rw_recovery(&p, last);
2013 output_len += ata_msense_caching(args->id, &p, last);
2014 output_len += ata_msense_ctl_mode(&p, last);
2017 default: /* invalid page code */
2025 if (ata_dev_supports_fua(args->id) && (dev->flags & ATA_DFLAG_LBA48) &&
2026 (!(dev->flags & ATA_DFLAG_PIO) || dev->multi_count))
2031 rbuf[0] = output_len;
2036 rbuf[3] = sizeof(sat_blk_desc);
2038 memcpy(rbuf + 4, sat_blk_desc,
2039 sizeof(sat_blk_desc));
2043 rbuf[0] = output_len >> 8;
2045 rbuf[1] = output_len;
2050 rbuf[7] = sizeof(sat_blk_desc);
2052 memcpy(rbuf + 8, sat_blk_desc,
2053 sizeof(sat_blk_desc));
2059 ata_scsi_set_sense(args->cmd, ILLEGAL_REQUEST, 0x24, 0x0);
2060 /* "Invalid field in cbd" */
2064 ata_scsi_set_sense(args->cmd, ILLEGAL_REQUEST, 0x39, 0x0);
2065 /* "Saving parameters not supported" */
2070 * ata_scsiop_read_cap - Simulate READ CAPACITY[ 16] commands
2071 * @args: device IDENTIFY data / SCSI command of interest.
2072 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2073 * @buflen: Response buffer length.
2075 * Simulate READ CAPACITY commands.
2080 unsigned int ata_scsiop_read_cap(struct ata_scsi_args *args, u8 *rbuf,
2081 unsigned int buflen)
2083 u64 last_lba = args->dev->n_sectors - 1; /* LBA of the last block */
2087 if (args->cmd->cmnd[0] == READ_CAPACITY) {
2088 if (last_lba >= 0xffffffffULL)
2089 last_lba = 0xffffffff;
2091 /* sector count, 32-bit */
2092 ATA_SCSI_RBUF_SET(0, last_lba >> (8 * 3));
2093 ATA_SCSI_RBUF_SET(1, last_lba >> (8 * 2));
2094 ATA_SCSI_RBUF_SET(2, last_lba >> (8 * 1));
2095 ATA_SCSI_RBUF_SET(3, last_lba);
2098 ATA_SCSI_RBUF_SET(6, ATA_SECT_SIZE >> 8);
2099 ATA_SCSI_RBUF_SET(7, ATA_SECT_SIZE);
2101 /* sector count, 64-bit */
2102 ATA_SCSI_RBUF_SET(0, last_lba >> (8 * 7));
2103 ATA_SCSI_RBUF_SET(1, last_lba >> (8 * 6));
2104 ATA_SCSI_RBUF_SET(2, last_lba >> (8 * 5));
2105 ATA_SCSI_RBUF_SET(3, last_lba >> (8 * 4));
2106 ATA_SCSI_RBUF_SET(4, last_lba >> (8 * 3));
2107 ATA_SCSI_RBUF_SET(5, last_lba >> (8 * 2));
2108 ATA_SCSI_RBUF_SET(6, last_lba >> (8 * 1));
2109 ATA_SCSI_RBUF_SET(7, last_lba);
2112 ATA_SCSI_RBUF_SET(10, ATA_SECT_SIZE >> 8);
2113 ATA_SCSI_RBUF_SET(11, ATA_SECT_SIZE);
2120 * ata_scsiop_report_luns - Simulate REPORT LUNS command
2121 * @args: device IDENTIFY data / SCSI command of interest.
2122 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2123 * @buflen: Response buffer length.
2125 * Simulate REPORT LUNS command.
2128 * spin_lock_irqsave(host lock)
2131 unsigned int ata_scsiop_report_luns(struct ata_scsi_args *args, u8 *rbuf,
2132 unsigned int buflen)
2135 rbuf[3] = 8; /* just one lun, LUN 0, size 8 bytes */
2141 * ata_scsi_set_sense - Set SCSI sense data and status
2142 * @cmd: SCSI request to be handled
2143 * @sk: SCSI-defined sense key
2144 * @asc: SCSI-defined additional sense code
2145 * @ascq: SCSI-defined additional sense code qualifier
2147 * Helper function that builds a valid fixed format, current
2148 * response code and the given sense key (sk), additional sense
2149 * code (asc) and additional sense code qualifier (ascq) with
2150 * a SCSI command status of %SAM_STAT_CHECK_CONDITION and
2151 * DRIVER_SENSE set in the upper bits of scsi_cmnd::result .
2157 void ata_scsi_set_sense(struct scsi_cmnd *cmd, u8 sk, u8 asc, u8 ascq)
2159 cmd->result = (DRIVER_SENSE << 24) | SAM_STAT_CHECK_CONDITION;
2161 cmd->sense_buffer[0] = 0x70; /* fixed format, current */
2162 cmd->sense_buffer[2] = sk;
2163 cmd->sense_buffer[7] = 18 - 8; /* additional sense length */
2164 cmd->sense_buffer[12] = asc;
2165 cmd->sense_buffer[13] = ascq;
2169 * ata_scsi_badcmd - End a SCSI request with an error
2170 * @cmd: SCSI request to be handled
2171 * @done: SCSI command completion function
2172 * @asc: SCSI-defined additional sense code
2173 * @ascq: SCSI-defined additional sense code qualifier
2175 * Helper function that completes a SCSI command with
2176 * %SAM_STAT_CHECK_CONDITION, with a sense key %ILLEGAL_REQUEST
2177 * and the specified additional sense codes.
2180 * spin_lock_irqsave(host lock)
2183 void ata_scsi_badcmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *), u8 asc, u8 ascq)
2186 ata_scsi_set_sense(cmd, ILLEGAL_REQUEST, asc, ascq);
2191 static void atapi_sense_complete(struct ata_queued_cmd *qc)
2193 if (qc->err_mask && ((qc->err_mask & AC_ERR_DEV) == 0)) {
2194 /* FIXME: not quite right; we don't want the
2195 * translation of taskfile registers into
2196 * a sense descriptors, since that's only
2197 * correct for ATA, not ATAPI
2199 ata_gen_passthru_sense(qc);
2202 qc->scsidone(qc->scsicmd);
2206 /* is it pointless to prefer PIO for "safety reasons"? */
2207 static inline int ata_pio_use_silly(struct ata_port *ap)
2209 return (ap->flags & ATA_FLAG_PIO_DMA);
2212 static void atapi_request_sense(struct ata_queued_cmd *qc)
2214 struct ata_port *ap = qc->ap;
2215 struct scsi_cmnd *cmd = qc->scsicmd;
2217 DPRINTK("ATAPI request sense\n");
2219 /* FIXME: is this needed? */
2220 memset(cmd->sense_buffer, 0, sizeof(cmd->sense_buffer));
2222 ap->ops->tf_read(ap, &qc->tf);
2224 /* fill these in, for the case where they are -not- overwritten */
2225 cmd->sense_buffer[0] = 0x70;
2226 cmd->sense_buffer[2] = qc->tf.feature >> 4;
2230 ata_sg_init_one(qc, cmd->sense_buffer, sizeof(cmd->sense_buffer));
2231 qc->dma_dir = DMA_FROM_DEVICE;
2233 memset(&qc->cdb, 0, qc->dev->cdb_len);
2234 qc->cdb[0] = REQUEST_SENSE;
2235 qc->cdb[4] = SCSI_SENSE_BUFFERSIZE;
2237 qc->tf.flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
2238 qc->tf.command = ATA_CMD_PACKET;
2240 if (ata_pio_use_silly(ap)) {
2241 qc->tf.protocol = ATA_PROT_ATAPI_DMA;
2242 qc->tf.feature |= ATAPI_PKT_DMA;
2244 qc->tf.protocol = ATA_PROT_ATAPI;
2245 qc->tf.lbam = (8 * 1024) & 0xff;
2246 qc->tf.lbah = (8 * 1024) >> 8;
2248 qc->nbytes = SCSI_SENSE_BUFFERSIZE;
2250 qc->complete_fn = atapi_sense_complete;
2257 static void atapi_qc_complete(struct ata_queued_cmd *qc)
2259 struct scsi_cmnd *cmd = qc->scsicmd;
2260 unsigned int err_mask = qc->err_mask;
2262 VPRINTK("ENTER, err_mask 0x%X\n", err_mask);
2264 /* handle completion from new EH */
2265 if (unlikely(qc->ap->ops->error_handler &&
2266 (err_mask || qc->flags & ATA_QCFLAG_SENSE_VALID))) {
2268 if (!(qc->flags & ATA_QCFLAG_SENSE_VALID)) {
2269 /* FIXME: not quite right; we don't want the
2270 * translation of taskfile registers into a
2271 * sense descriptors, since that's only
2272 * correct for ATA, not ATAPI
2274 ata_gen_passthru_sense(qc);
2277 /* SCSI EH automatically locks door if sdev->locked is
2278 * set. Sometimes door lock request continues to
2279 * fail, for example, when no media is present. This
2280 * creates a loop - SCSI EH issues door lock which
2281 * fails and gets invoked again to acquire sense data
2282 * for the failed command.
2284 * If door lock fails, always clear sdev->locked to
2285 * avoid this infinite loop.
2287 if (qc->cdb[0] == ALLOW_MEDIUM_REMOVAL)
2288 qc->dev->sdev->locked = 0;
2290 qc->scsicmd->result = SAM_STAT_CHECK_CONDITION;
2296 /* successful completion or old EH failure path */
2297 if (unlikely(err_mask & AC_ERR_DEV)) {
2298 cmd->result = SAM_STAT_CHECK_CONDITION;
2299 atapi_request_sense(qc);
2301 } else if (unlikely(err_mask)) {
2302 /* FIXME: not quite right; we don't want the
2303 * translation of taskfile registers into
2304 * a sense descriptors, since that's only
2305 * correct for ATA, not ATAPI
2307 ata_gen_passthru_sense(qc);
2309 u8 *scsicmd = cmd->cmnd;
2311 if ((scsicmd[0] == INQUIRY) && ((scsicmd[1] & 0x03) == 0)) {
2313 unsigned int buflen;
2315 buflen = ata_scsi_rbuf_get(cmd, &buf);
2317 /* ATAPI devices typically report zero for their SCSI version,
2318 * and sometimes deviate from the spec WRT response data
2319 * format. If SCSI version is reported as zero like normal,
2320 * then we make the following fixups: 1) Fake MMC-5 version,
2321 * to indicate to the Linux scsi midlayer this is a modern
2322 * device. 2) Ensure response data format / ATAPI information
2323 * are always correct.
2330 ata_scsi_rbuf_put(cmd, buf);
2333 cmd->result = SAM_STAT_GOOD;
2340 * atapi_xlat - Initialize PACKET taskfile
2341 * @qc: command structure to be initialized
2342 * @cdb: SCSI CDB associated with this PACKET command
2345 * spin_lock_irqsave(host lock)
2348 * Zero on success, non-zero on failure.
2350 static unsigned int atapi_xlat(struct ata_queued_cmd *qc, const u8 *cdb)
2352 struct scsi_cmnd *scmd = qc->scsicmd;
2353 struct ata_device *dev = qc->dev;
2354 int using_pio = (dev->flags & ATA_DFLAG_PIO);
2355 int nodata = (scmd->sc_data_direction == DMA_NONE);
2358 /* Check whether ATAPI DMA is safe */
2359 if (ata_check_atapi_dma(qc))
2362 memcpy(&qc->cdb, cdb, dev->cdb_len);
2364 qc->complete_fn = atapi_qc_complete;
2366 qc->tf.flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
2367 if (scmd->sc_data_direction == DMA_TO_DEVICE) {
2368 qc->tf.flags |= ATA_TFLAG_WRITE;
2369 DPRINTK("direction: write\n");
2372 qc->tf.command = ATA_CMD_PACKET;
2374 /* no data, or PIO data xfer */
2375 if (using_pio || nodata) {
2377 qc->tf.protocol = ATA_PROT_ATAPI_NODATA;
2379 qc->tf.protocol = ATA_PROT_ATAPI;
2380 qc->tf.lbam = (8 * 1024) & 0xff;
2381 qc->tf.lbah = (8 * 1024) >> 8;
2386 qc->tf.protocol = ATA_PROT_ATAPI_DMA;
2387 qc->tf.feature |= ATAPI_PKT_DMA;
2389 if (atapi_dmadir && (scmd->sc_data_direction != DMA_TO_DEVICE))
2390 /* some SATA bridges need us to indicate data xfer direction */
2391 qc->tf.feature |= ATAPI_DMADIR;
2394 qc->nbytes = scmd->request_bufflen;
2399 static struct ata_device * ata_find_dev(struct ata_port *ap, int id)
2401 if (likely(id < ATA_MAX_DEVICES))
2402 return &ap->device[id];
2406 static struct ata_device * __ata_scsi_find_dev(struct ata_port *ap,
2407 const struct scsi_device *scsidev)
2409 /* skip commands not addressed to targets we simulate */
2410 if (unlikely(scsidev->channel || scsidev->lun))
2413 return ata_find_dev(ap, scsidev->id);
2417 * ata_scsi_dev_enabled - determine if device is enabled
2420 * Determine if commands should be sent to the specified device.
2423 * spin_lock_irqsave(host lock)
2426 * 0 if commands are not allowed / 1 if commands are allowed
2429 static int ata_scsi_dev_enabled(struct ata_device *dev)
2431 if (unlikely(!ata_dev_enabled(dev)))
2434 if (!atapi_enabled || (dev->ap->flags & ATA_FLAG_NO_ATAPI)) {
2435 if (unlikely(dev->class == ATA_DEV_ATAPI)) {
2436 ata_dev_printk(dev, KERN_WARNING,
2437 "WARNING: ATAPI is %s, device ignored.\n",
2438 atapi_enabled ? "not supported with this driver" : "disabled");
2447 * ata_scsi_find_dev - lookup ata_device from scsi_cmnd
2448 * @ap: ATA port to which the device is attached
2449 * @scsidev: SCSI device from which we derive the ATA device
2451 * Given various information provided in struct scsi_cmnd,
2452 * map that onto an ATA bus, and using that mapping
2453 * determine which ata_device is associated with the
2454 * SCSI command to be sent.
2457 * spin_lock_irqsave(host lock)
2460 * Associated ATA device, or %NULL if not found.
2462 static struct ata_device *
2463 ata_scsi_find_dev(struct ata_port *ap, const struct scsi_device *scsidev)
2465 struct ata_device *dev = __ata_scsi_find_dev(ap, scsidev);
2467 if (unlikely(!dev || !ata_scsi_dev_enabled(dev)))
2474 * ata_scsi_map_proto - Map pass-thru protocol value to taskfile value.
2475 * @byte1: Byte 1 from pass-thru CDB.
2478 * ATA_PROT_UNKNOWN if mapping failed/unimplemented, protocol otherwise.
2481 ata_scsi_map_proto(u8 byte1)
2483 switch((byte1 & 0x1e) >> 1) {
2484 case 3: /* Non-data */
2485 return ATA_PROT_NODATA;
2488 return ATA_PROT_DMA;
2490 case 4: /* PIO Data-in */
2491 case 5: /* PIO Data-out */
2492 return ATA_PROT_PIO;
2494 case 10: /* Device Reset */
2495 case 0: /* Hard Reset */
2497 case 2: /* Bus Idle */
2498 case 7: /* Packet */
2499 case 8: /* DMA Queued */
2500 case 9: /* Device Diagnostic */
2501 case 11: /* UDMA Data-in */
2502 case 12: /* UDMA Data-Out */
2503 case 13: /* FPDMA */
2504 default: /* Reserved */
2508 return ATA_PROT_UNKNOWN;
2512 * ata_scsi_pass_thru - convert ATA pass-thru CDB to taskfile
2513 * @qc: command structure to be initialized
2514 * @cdb: SCSI command to convert
2516 * Handles either 12 or 16-byte versions of the CDB.
2519 * Zero on success, non-zero on failure.
2521 static unsigned int ata_scsi_pass_thru(struct ata_queued_cmd *qc, const u8 *cdb)
2523 struct ata_taskfile *tf = &(qc->tf);
2524 struct scsi_cmnd *scmd = qc->scsicmd;
2525 struct ata_device *dev = qc->dev;
2527 if ((tf->protocol = ata_scsi_map_proto(cdb[1])) == ATA_PROT_UNKNOWN)
2530 /* We may not issue DMA commands if no DMA mode is set */
2531 if (tf->protocol == ATA_PROT_DMA && dev->dma_mode == 0)
2535 /* PIO multi not supported yet */
2539 * 12 and 16 byte CDBs use different offsets to
2540 * provide the various register values.
2542 if (cdb[0] == ATA_16) {
2544 * 16-byte CDB - may contain extended commands.
2546 * If that is the case, copy the upper byte register values.
2548 if (cdb[1] & 0x01) {
2549 tf->hob_feature = cdb[3];
2550 tf->hob_nsect = cdb[5];
2551 tf->hob_lbal = cdb[7];
2552 tf->hob_lbam = cdb[9];
2553 tf->hob_lbah = cdb[11];
2554 tf->flags |= ATA_TFLAG_LBA48;
2556 tf->flags &= ~ATA_TFLAG_LBA48;
2559 * Always copy low byte, device and command registers.
2561 tf->feature = cdb[4];
2566 tf->device = cdb[13];
2567 tf->command = cdb[14];
2570 * 12-byte CDB - incapable of extended commands.
2572 tf->flags &= ~ATA_TFLAG_LBA48;
2574 tf->feature = cdb[3];
2579 tf->device = cdb[8];
2580 tf->command = cdb[9];
2583 * If slave is possible, enforce correct master/slave bit
2585 if (qc->ap->flags & ATA_FLAG_SLAVE_POSS)
2586 tf->device = qc->dev->devno ?
2587 tf->device | ATA_DEV1 : tf->device & ~ATA_DEV1;
2590 * Filter SET_FEATURES - XFER MODE command -- otherwise,
2591 * SET_FEATURES - XFER MODE must be preceded/succeeded
2592 * by an update to hardware-specific registers for each
2593 * controller (i.e. the reason for ->set_piomode(),
2594 * ->set_dmamode(), and ->post_set_mode() hooks).
2596 if ((tf->command == ATA_CMD_SET_FEATURES)
2597 && (tf->feature == SETFEATURES_XFER))
2601 * Set flags so that all registers will be written,
2602 * and pass on write indication (used for PIO/DMA
2605 tf->flags |= (ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE);
2607 if (scmd->sc_data_direction == DMA_TO_DEVICE)
2608 tf->flags |= ATA_TFLAG_WRITE;
2611 * Set transfer length.
2613 * TODO: find out if we need to do more here to
2614 * cover scatter/gather case.
2616 qc->nsect = scmd->request_bufflen / ATA_SECT_SIZE;
2618 /* request result TF */
2619 qc->flags |= ATA_QCFLAG_RESULT_TF;
2624 ata_scsi_set_sense(scmd, ILLEGAL_REQUEST, 0x24, 0x00);
2625 /* "Invalid field in cdb" */
2630 * ata_get_xlat_func - check if SCSI to ATA translation is possible
2632 * @cmd: SCSI command opcode to consider
2634 * Look up the SCSI command given, and determine whether the
2635 * SCSI command is to be translated or simulated.
2638 * Pointer to translation function if possible, %NULL if not.
2641 static inline ata_xlat_func_t ata_get_xlat_func(struct ata_device *dev, u8 cmd)
2651 return ata_scsi_rw_xlat;
2653 case SYNCHRONIZE_CACHE:
2654 if (ata_try_flush_cache(dev))
2655 return ata_scsi_flush_xlat;
2660 return ata_scsi_verify_xlat;
2664 return ata_scsi_pass_thru;
2667 return ata_scsi_start_stop_xlat;
2674 * ata_scsi_dump_cdb - dump SCSI command contents to dmesg
2675 * @ap: ATA port to which the command was being sent
2676 * @cmd: SCSI command to dump
2678 * Prints the contents of a SCSI command via printk().
2681 static inline void ata_scsi_dump_cdb(struct ata_port *ap,
2682 struct scsi_cmnd *cmd)
2685 struct scsi_device *scsidev = cmd->device;
2686 u8 *scsicmd = cmd->cmnd;
2688 DPRINTK("CDB (%u:%d,%d,%d) %02x %02x %02x %02x %02x %02x %02x %02x %02x\n",
2690 scsidev->channel, scsidev->id, scsidev->lun,
2691 scsicmd[0], scsicmd[1], scsicmd[2], scsicmd[3],
2692 scsicmd[4], scsicmd[5], scsicmd[6], scsicmd[7],
2697 static inline int __ata_scsi_queuecmd(struct scsi_cmnd *scmd,
2698 void (*done)(struct scsi_cmnd *),
2699 struct ata_device *dev)
2703 if (dev->class == ATA_DEV_ATA) {
2704 ata_xlat_func_t xlat_func = ata_get_xlat_func(dev,
2708 rc = ata_scsi_translate(dev, scmd, done, xlat_func);
2710 ata_scsi_simulate(dev, scmd, done);
2712 rc = ata_scsi_translate(dev, scmd, done, atapi_xlat);
2718 * ata_scsi_queuecmd - Issue SCSI cdb to libata-managed device
2719 * @cmd: SCSI command to be sent
2720 * @done: Completion function, called when command is complete
2722 * In some cases, this function translates SCSI commands into
2723 * ATA taskfiles, and queues the taskfiles to be sent to
2724 * hardware. In other cases, this function simulates a
2725 * SCSI device by evaluating and responding to certain
2726 * SCSI commands. This creates the overall effect of
2727 * ATA and ATAPI devices appearing as SCSI devices.
2730 * Releases scsi-layer-held lock, and obtains host lock.
2733 * Return value from __ata_scsi_queuecmd() if @cmd can be queued,
2736 int ata_scsi_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *))
2738 struct ata_port *ap;
2739 struct ata_device *dev;
2740 struct scsi_device *scsidev = cmd->device;
2741 struct Scsi_Host *shost = scsidev->host;
2744 ap = ata_shost_to_port(shost);
2746 spin_unlock(shost->host_lock);
2747 spin_lock(ap->lock);
2749 ata_scsi_dump_cdb(ap, cmd);
2751 dev = ata_scsi_find_dev(ap, scsidev);
2753 rc = __ata_scsi_queuecmd(cmd, done, dev);
2755 cmd->result = (DID_BAD_TARGET << 16);
2759 spin_unlock(ap->lock);
2760 spin_lock(shost->host_lock);
2765 * ata_scsi_simulate - simulate SCSI command on ATA device
2766 * @dev: the target device
2767 * @cmd: SCSI command being sent to device.
2768 * @done: SCSI command completion function.
2770 * Interprets and directly executes a select list of SCSI commands
2771 * that can be handled internally.
2774 * spin_lock_irqsave(host lock)
2777 void ata_scsi_simulate(struct ata_device *dev, struct scsi_cmnd *cmd,
2778 void (*done)(struct scsi_cmnd *))
2780 struct ata_scsi_args args;
2781 const u8 *scsicmd = cmd->cmnd;
2788 switch(scsicmd[0]) {
2789 /* no-op's, complete with success */
2790 case SYNCHRONIZE_CACHE:
2794 case TEST_UNIT_READY:
2795 case FORMAT_UNIT: /* FIXME: correct? */
2796 case SEND_DIAGNOSTIC: /* FIXME: correct? */
2797 ata_scsi_rbuf_fill(&args, ata_scsiop_noop);
2801 if (scsicmd[1] & 2) /* is CmdDt set? */
2802 ata_scsi_invalid_field(cmd, done);
2803 else if ((scsicmd[1] & 1) == 0) /* is EVPD clear? */
2804 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_std);
2805 else if (scsicmd[2] == 0x00)
2806 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_00);
2807 else if (scsicmd[2] == 0x80)
2808 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_80);
2809 else if (scsicmd[2] == 0x83)
2810 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_83);
2812 ata_scsi_invalid_field(cmd, done);
2817 ata_scsi_rbuf_fill(&args, ata_scsiop_mode_sense);
2820 case MODE_SELECT: /* unconditionally return */
2821 case MODE_SELECT_10: /* bad-field-in-cdb */
2822 ata_scsi_invalid_field(cmd, done);
2826 ata_scsi_rbuf_fill(&args, ata_scsiop_read_cap);
2829 case SERVICE_ACTION_IN:
2830 if ((scsicmd[1] & 0x1f) == SAI_READ_CAPACITY_16)
2831 ata_scsi_rbuf_fill(&args, ata_scsiop_read_cap);
2833 ata_scsi_invalid_field(cmd, done);
2837 ata_scsi_rbuf_fill(&args, ata_scsiop_report_luns);
2840 /* mandatory commands we haven't implemented yet */
2843 /* all other commands */
2845 ata_scsi_set_sense(cmd, ILLEGAL_REQUEST, 0x20, 0x0);
2846 /* "Invalid command operation code" */
2852 void ata_scsi_scan_host(struct ata_port *ap)
2856 if (ap->flags & ATA_FLAG_DISABLED)
2859 for (i = 0; i < ATA_MAX_DEVICES; i++) {
2860 struct ata_device *dev = &ap->device[i];
2861 struct scsi_device *sdev;
2863 if (!ata_dev_enabled(dev) || dev->sdev)
2866 sdev = __scsi_add_device(ap->scsi_host, 0, i, 0, NULL);
2867 if (!IS_ERR(sdev)) {
2869 scsi_device_put(sdev);
2875 * ata_scsi_offline_dev - offline attached SCSI device
2876 * @dev: ATA device to offline attached SCSI device for
2878 * This function is called from ata_eh_hotplug() and responsible
2879 * for taking the SCSI device attached to @dev offline. This
2880 * function is called with host lock which protects dev->sdev
2884 * spin_lock_irqsave(host lock)
2887 * 1 if attached SCSI device exists, 0 otherwise.
2889 int ata_scsi_offline_dev(struct ata_device *dev)
2892 scsi_device_set_state(dev->sdev, SDEV_OFFLINE);
2899 * ata_scsi_remove_dev - remove attached SCSI device
2900 * @dev: ATA device to remove attached SCSI device for
2902 * This function is called from ata_eh_scsi_hotplug() and
2903 * responsible for removing the SCSI device attached to @dev.
2906 * Kernel thread context (may sleep).
2908 static void ata_scsi_remove_dev(struct ata_device *dev)
2910 struct ata_port *ap = dev->ap;
2911 struct scsi_device *sdev;
2912 unsigned long flags;
2914 /* Alas, we need to grab scan_mutex to ensure SCSI device
2915 * state doesn't change underneath us and thus
2916 * scsi_device_get() always succeeds. The mutex locking can
2917 * be removed if there is __scsi_device_get() interface which
2918 * increments reference counts regardless of device state.
2920 mutex_lock(&ap->scsi_host->scan_mutex);
2921 spin_lock_irqsave(ap->lock, flags);
2923 /* clearing dev->sdev is protected by host lock */
2928 /* If user initiated unplug races with us, sdev can go
2929 * away underneath us after the host lock and
2930 * scan_mutex are released. Hold onto it.
2932 if (scsi_device_get(sdev) == 0) {
2933 /* The following ensures the attached sdev is
2934 * offline on return from ata_scsi_offline_dev()
2935 * regardless it wins or loses the race
2936 * against this function.
2938 scsi_device_set_state(sdev, SDEV_OFFLINE);
2945 spin_unlock_irqrestore(ap->lock, flags);
2946 mutex_unlock(&ap->scsi_host->scan_mutex);
2949 ata_dev_printk(dev, KERN_INFO, "detaching (SCSI %s)\n",
2950 sdev->sdev_gendev.bus_id);
2952 scsi_remove_device(sdev);
2953 scsi_device_put(sdev);
2958 * ata_scsi_hotplug - SCSI part of hotplug
2959 * @work: Pointer to ATA port to perform SCSI hotplug on
2961 * Perform SCSI part of hotplug. It's executed from a separate
2962 * workqueue after EH completes. This is necessary because SCSI
2963 * hot plugging requires working EH and hot unplugging is
2964 * synchronized with hot plugging with a mutex.
2967 * Kernel thread context (may sleep).
2969 void ata_scsi_hotplug(struct work_struct *work)
2971 struct ata_port *ap =
2972 container_of(work, struct ata_port, hotplug_task.work);
2975 if (ap->pflags & ATA_PFLAG_UNLOADING) {
2976 DPRINTK("ENTER/EXIT - unloading\n");
2982 /* unplug detached devices */
2983 for (i = 0; i < ATA_MAX_DEVICES; i++) {
2984 struct ata_device *dev = &ap->device[i];
2985 unsigned long flags;
2987 if (!(dev->flags & ATA_DFLAG_DETACHED))
2990 spin_lock_irqsave(ap->lock, flags);
2991 dev->flags &= ~ATA_DFLAG_DETACHED;
2992 spin_unlock_irqrestore(ap->lock, flags);
2994 ata_scsi_remove_dev(dev);
2997 /* scan for new ones */
2998 ata_scsi_scan_host(ap);
3000 /* If we scanned while EH was in progress, scan would have
3001 * failed silently. Requeue if there are enabled but
3002 * unattached devices.
3004 for (i = 0; i < ATA_MAX_DEVICES; i++) {
3005 struct ata_device *dev = &ap->device[i];
3006 if (ata_dev_enabled(dev) && !dev->sdev) {
3007 queue_delayed_work(ata_aux_wq, &ap->hotplug_task, HZ);
3016 * ata_scsi_user_scan - indication for user-initiated bus scan
3017 * @shost: SCSI host to scan
3018 * @channel: Channel to scan
3022 * This function is called when user explicitly requests bus
3023 * scan. Set probe pending flag and invoke EH.
3026 * SCSI layer (we don't care)
3031 static int ata_scsi_user_scan(struct Scsi_Host *shost, unsigned int channel,
3032 unsigned int id, unsigned int lun)
3034 struct ata_port *ap = ata_shost_to_port(shost);
3035 unsigned long flags;
3038 if (!ap->ops->error_handler)
3041 if ((channel != SCAN_WILD_CARD && channel != 0) ||
3042 (lun != SCAN_WILD_CARD && lun != 0))
3045 spin_lock_irqsave(ap->lock, flags);
3047 if (id == SCAN_WILD_CARD) {
3048 ap->eh_info.probe_mask |= (1 << ATA_MAX_DEVICES) - 1;
3049 ap->eh_info.action |= ATA_EH_SOFTRESET;
3051 struct ata_device *dev = ata_find_dev(ap, id);
3054 ap->eh_info.probe_mask |= 1 << dev->devno;
3055 ap->eh_info.action |= ATA_EH_SOFTRESET;
3056 ap->eh_info.flags |= ATA_EHI_RESUME_LINK;
3062 ata_port_schedule_eh(ap);
3063 spin_unlock_irqrestore(ap->lock, flags);
3064 ata_port_wait_eh(ap);
3066 spin_unlock_irqrestore(ap->lock, flags);
3072 * ata_scsi_dev_rescan - initiate scsi_rescan_device()
3073 * @work: Pointer to ATA port to perform scsi_rescan_device()
3075 * After ATA pass thru (SAT) commands are executed successfully,
3076 * libata need to propagate the changes to SCSI layer. This
3077 * function must be executed from ata_aux_wq such that sdev
3078 * attach/detach don't race with rescan.
3081 * Kernel thread context (may sleep).
3083 void ata_scsi_dev_rescan(struct work_struct *work)
3085 struct ata_port *ap =
3086 container_of(work, struct ata_port, scsi_rescan_task);
3087 unsigned long flags;
3090 spin_lock_irqsave(ap->lock, flags);
3092 for (i = 0; i < ATA_MAX_DEVICES; i++) {
3093 struct ata_device *dev = &ap->device[i];
3094 struct scsi_device *sdev = dev->sdev;
3096 if (!ata_dev_enabled(dev) || !sdev)
3098 if (scsi_device_get(sdev))
3101 spin_unlock_irqrestore(ap->lock, flags);
3102 scsi_rescan_device(&(sdev->sdev_gendev));
3103 scsi_device_put(sdev);
3104 spin_lock_irqsave(ap->lock, flags);
3107 spin_unlock_irqrestore(ap->lock, flags);
3111 * ata_sas_port_alloc - Allocate port for a SAS attached SATA device
3112 * @host: ATA host container for all SAS ports
3113 * @port_info: Information from low-level host driver
3114 * @shost: SCSI host that the scsi device is attached to
3117 * PCI/etc. bus probe sem.
3120 * ata_port pointer on success / NULL on failure.
3123 struct ata_port *ata_sas_port_alloc(struct ata_host *host,
3124 struct ata_port_info *port_info,
3125 struct Scsi_Host *shost)
3127 struct ata_port *ap = kzalloc(sizeof(*ap), GFP_KERNEL);
3128 struct ata_probe_ent *ent;
3133 ent = ata_probe_ent_alloc(host->dev, port_info);
3139 ata_port_init(ap, host, ent, 0);
3140 ap->lock = shost->host_lock;
3144 EXPORT_SYMBOL_GPL(ata_sas_port_alloc);
3147 * ata_sas_port_start - Set port up for dma.
3148 * @ap: Port to initialize
3150 * Called just after data structures for each port are
3151 * initialized. Allocates DMA pad.
3153 * May be used as the port_start() entry in ata_port_operations.
3156 * Inherited from caller.
3158 int ata_sas_port_start(struct ata_port *ap)
3160 return ata_pad_alloc(ap, ap->dev);
3162 EXPORT_SYMBOL_GPL(ata_sas_port_start);
3165 * ata_port_stop - Undo ata_sas_port_start()
3166 * @ap: Port to shut down
3168 * Frees the DMA pad.
3170 * May be used as the port_stop() entry in ata_port_operations.
3173 * Inherited from caller.
3176 void ata_sas_port_stop(struct ata_port *ap)
3178 ata_pad_free(ap, ap->dev);
3180 EXPORT_SYMBOL_GPL(ata_sas_port_stop);
3183 * ata_sas_port_init - Initialize a SATA device
3184 * @ap: SATA port to initialize
3187 * PCI/etc. bus probe sem.
3190 * Zero on success, non-zero on error.
3193 int ata_sas_port_init(struct ata_port *ap)
3195 int rc = ap->ops->port_start(ap);
3198 rc = ata_bus_probe(ap);
3202 EXPORT_SYMBOL_GPL(ata_sas_port_init);
3205 * ata_sas_port_destroy - Destroy a SATA port allocated by ata_sas_port_alloc
3206 * @ap: SATA port to destroy
3210 void ata_sas_port_destroy(struct ata_port *ap)
3212 ap->ops->port_stop(ap);
3215 EXPORT_SYMBOL_GPL(ata_sas_port_destroy);
3218 * ata_sas_slave_configure - Default slave_config routine for libata devices
3219 * @sdev: SCSI device to configure
3220 * @ap: ATA port to which SCSI device is attached
3226 int ata_sas_slave_configure(struct scsi_device *sdev, struct ata_port *ap)
3228 ata_scsi_sdev_config(sdev);
3229 ata_scsi_dev_config(sdev, ap->device);
3232 EXPORT_SYMBOL_GPL(ata_sas_slave_configure);
3235 * ata_sas_queuecmd - Issue SCSI cdb to libata-managed device
3236 * @cmd: SCSI command to be sent
3237 * @done: Completion function, called when command is complete
3238 * @ap: ATA port to which the command is being sent
3241 * Return value from __ata_scsi_queuecmd() if @cmd can be queued,
3245 int ata_sas_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *),
3246 struct ata_port *ap)
3250 ata_scsi_dump_cdb(ap, cmd);
3252 if (likely(ata_scsi_dev_enabled(ap->device)))
3253 rc = __ata_scsi_queuecmd(cmd, done, ap->device);
3255 cmd->result = (DID_BAD_TARGET << 16);
3260 EXPORT_SYMBOL_GPL(ata_sas_queuecmd);