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 *scsicmd);
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_ata_desc_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.
684 * spin_lock_irqsave(host lock)
686 void ata_gen_ata_desc_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.
717 * Set length of additional sense data.
718 * Since we only populate descriptor 0, the total
719 * length is the same (fixed) length as descriptor 0.
721 desc[1] = sb[7] = 14;
724 * Copy registers into sense buffer.
727 desc[3] = tf->feature; /* == error reg */
732 desc[12] = tf->device;
733 desc[13] = tf->command; /* == status reg */
736 * Fill in Extend bit, and the high order bytes
739 if (tf->flags & ATA_TFLAG_LBA48) {
741 desc[4] = tf->hob_nsect;
742 desc[6] = tf->hob_lbal;
743 desc[8] = tf->hob_lbam;
744 desc[10] = tf->hob_lbah;
749 * ata_gen_fixed_sense - generate a SCSI fixed sense block
750 * @qc: Command that we are erroring out
752 * Leverage ata_to_sense_error() to give us the codes. Fit our
753 * LBA in here if there's room.
756 * inherited from caller
758 void ata_gen_fixed_sense(struct ata_queued_cmd *qc)
760 struct scsi_cmnd *cmd = qc->scsicmd;
761 struct ata_taskfile *tf = &qc->result_tf;
762 unsigned char *sb = cmd->sense_buffer;
763 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;
770 * Use ata_to_sense_error() to map status register bits
771 * onto sense key, asc & ascq.
774 tf->command & (ATA_BUSY | ATA_DF | ATA_ERR | ATA_DRQ)) {
775 ata_to_sense_error(qc->ap->id, tf->command, tf->feature,
776 &sb[2], &sb[12], &sb[13], verbose);
783 if (tf->flags & ATA_TFLAG_LBA48) {
784 /* TODO: find solution for LBA48 descriptors */
787 else if (tf->flags & ATA_TFLAG_LBA) {
788 /* A small (28b) LBA will fit in the 32b info field */
789 sb[0] |= 0x80; /* set valid bit */
790 sb[3] = tf->device & 0x0f;
801 static void ata_scsi_sdev_config(struct scsi_device *sdev)
803 sdev->use_10_for_rw = 1;
804 sdev->use_10_for_ms = 1;
807 static void ata_scsi_dev_config(struct scsi_device *sdev,
808 struct ata_device *dev)
810 /* configure max sectors */
811 blk_queue_max_sectors(sdev->request_queue, dev->max_sectors);
813 /* SATA DMA transfers must be multiples of 4 byte, so
814 * we need to pad ATAPI transfers using an extra sg.
815 * Decrement max hw segments accordingly.
817 if (dev->class == ATA_DEV_ATAPI) {
818 request_queue_t *q = sdev->request_queue;
819 blk_queue_max_hw_segments(q, q->max_hw_segments - 1);
822 if (dev->flags & ATA_DFLAG_NCQ) {
825 depth = min(sdev->host->can_queue, ata_id_queue_depth(dev->id));
826 depth = min(ATA_MAX_QUEUE - 1, depth);
827 scsi_adjust_queue_depth(sdev, MSG_SIMPLE_TAG, depth);
832 * ata_scsi_slave_config - Set SCSI device attributes
833 * @sdev: SCSI device to examine
835 * This is called before we actually start reading
836 * and writing to the device, to configure certain
837 * SCSI mid-layer behaviors.
840 * Defined by SCSI layer. We don't really care.
843 int ata_scsi_slave_config(struct scsi_device *sdev)
845 struct ata_port *ap = ata_shost_to_port(sdev->host);
846 struct ata_device *dev = __ata_scsi_find_dev(ap, sdev);
848 ata_scsi_sdev_config(sdev);
850 blk_queue_max_phys_segments(sdev->request_queue, LIBATA_MAX_PRD);
853 ata_scsi_dev_config(sdev, dev);
855 return 0; /* scsi layer doesn't check return value, sigh */
859 * ata_scsi_slave_destroy - SCSI device is about to be destroyed
860 * @sdev: SCSI device to be destroyed
862 * @sdev is about to be destroyed for hot/warm unplugging. If
863 * this unplugging was initiated by libata as indicated by NULL
864 * dev->sdev, this function doesn't have to do anything.
865 * Otherwise, SCSI layer initiated warm-unplug is in progress.
866 * Clear dev->sdev, schedule the device for ATA detach and invoke
870 * Defined by SCSI layer. We don't really care.
872 void ata_scsi_slave_destroy(struct scsi_device *sdev)
874 struct ata_port *ap = ata_shost_to_port(sdev->host);
876 struct ata_device *dev;
878 if (!ap->ops->error_handler)
881 spin_lock_irqsave(ap->lock, flags);
882 dev = __ata_scsi_find_dev(ap, sdev);
883 if (dev && dev->sdev) {
884 /* SCSI device already in CANCEL state, no need to offline it */
886 dev->flags |= ATA_DFLAG_DETACH;
887 ata_port_schedule_eh(ap);
889 spin_unlock_irqrestore(ap->lock, flags);
893 * ata_scsi_change_queue_depth - SCSI callback for queue depth config
894 * @sdev: SCSI device to configure queue depth for
895 * @queue_depth: new queue depth
897 * This is libata standard hostt->change_queue_depth callback.
898 * SCSI will call into this callback when user tries to set queue
902 * SCSI layer (we don't care)
905 * Newly configured queue depth.
907 int ata_scsi_change_queue_depth(struct scsi_device *sdev, int queue_depth)
909 struct ata_port *ap = ata_shost_to_port(sdev->host);
910 struct ata_device *dev;
915 return sdev->queue_depth;
917 dev = ata_scsi_find_dev(ap, sdev);
918 if (!dev || !ata_dev_enabled(dev))
919 return sdev->queue_depth;
921 max_depth = min(sdev->host->can_queue, ata_id_queue_depth(dev->id));
922 max_depth = min(ATA_MAX_QUEUE - 1, max_depth);
923 if (queue_depth > max_depth)
924 queue_depth = max_depth;
926 scsi_adjust_queue_depth(sdev, MSG_SIMPLE_TAG, queue_depth);
928 spin_lock_irqsave(ap->lock, flags);
930 dev->flags &= ~ATA_DFLAG_NCQ_OFF;
932 dev->flags |= ATA_DFLAG_NCQ_OFF;
933 spin_unlock_irqrestore(ap->lock, flags);
939 * ata_scsi_start_stop_xlat - Translate SCSI START STOP UNIT command
940 * @qc: Storage for translated ATA taskfile
941 * @scsicmd: SCSI command to translate
943 * Sets up an ATA taskfile to issue STANDBY (to stop) or READ VERIFY
944 * (to start). Perhaps these commands should be preceded by
945 * CHECK POWER MODE to see what power mode the device is already in.
946 * [See SAT revision 5 at www.t10.org]
949 * spin_lock_irqsave(host lock)
952 * Zero on success, non-zero on error.
955 static unsigned int ata_scsi_start_stop_xlat(struct ata_queued_cmd *qc,
958 struct ata_taskfile *tf = &qc->tf;
960 tf->flags |= ATA_TFLAG_DEVICE | ATA_TFLAG_ISADDR;
961 tf->protocol = ATA_PROT_NODATA;
962 if (scsicmd[1] & 0x1) {
963 ; /* ignore IMMED bit, violates sat-r05 */
965 if (scsicmd[4] & 0x2)
966 goto invalid_fld; /* LOEJ bit set not supported */
967 if (((scsicmd[4] >> 4) & 0xf) != 0)
968 goto invalid_fld; /* power conditions not supported */
969 if (scsicmd[4] & 0x1) {
970 tf->nsect = 1; /* 1 sector, lba=0 */
972 if (qc->dev->flags & ATA_DFLAG_LBA) {
973 tf->flags |= ATA_TFLAG_LBA;
978 tf->device |= ATA_LBA;
981 tf->lbal = 0x1; /* sect */
982 tf->lbam = 0x0; /* cyl low */
983 tf->lbah = 0x0; /* cyl high */
986 tf->command = ATA_CMD_VERIFY; /* READ VERIFY */
988 tf->nsect = 0; /* time period value (0 implies now) */
989 tf->command = ATA_CMD_STANDBY;
990 /* Consider: ATA STANDBY IMMEDIATE command */
993 * Standby and Idle condition timers could be implemented but that
994 * would require libata to implement the Power condition mode page
995 * and allow the user to change it. Changing mode pages requires
996 * MODE SELECT to be implemented.
1002 ata_scsi_set_sense(qc->scsicmd, ILLEGAL_REQUEST, 0x24, 0x0);
1003 /* "Invalid field in cbd" */
1009 * ata_scsi_flush_xlat - Translate SCSI SYNCHRONIZE CACHE command
1010 * @qc: Storage for translated ATA taskfile
1011 * @scsicmd: SCSI command to translate (ignored)
1013 * Sets up an ATA taskfile to issue FLUSH CACHE or
1017 * spin_lock_irqsave(host lock)
1020 * Zero on success, non-zero on error.
1023 static unsigned int ata_scsi_flush_xlat(struct ata_queued_cmd *qc, const u8 *scsicmd)
1025 struct ata_taskfile *tf = &qc->tf;
1027 tf->flags |= ATA_TFLAG_DEVICE;
1028 tf->protocol = ATA_PROT_NODATA;
1030 if (qc->dev->flags & ATA_DFLAG_FLUSH_EXT)
1031 tf->command = ATA_CMD_FLUSH_EXT;
1033 tf->command = ATA_CMD_FLUSH;
1039 * scsi_6_lba_len - Get LBA and transfer length
1040 * @scsicmd: SCSI command to translate
1042 * Calculate LBA and transfer length for 6-byte commands.
1046 * @plen: the transfer length
1049 static void scsi_6_lba_len(const u8 *scsicmd, u64 *plba, u32 *plen)
1054 VPRINTK("six-byte command\n");
1056 lba |= ((u64)scsicmd[2]) << 8;
1057 lba |= ((u64)scsicmd[3]);
1059 len |= ((u32)scsicmd[4]);
1066 * scsi_10_lba_len - Get LBA and transfer length
1067 * @scsicmd: SCSI command to translate
1069 * Calculate LBA and transfer length for 10-byte commands.
1073 * @plen: the transfer length
1076 static void scsi_10_lba_len(const u8 *scsicmd, u64 *plba, u32 *plen)
1081 VPRINTK("ten-byte command\n");
1083 lba |= ((u64)scsicmd[2]) << 24;
1084 lba |= ((u64)scsicmd[3]) << 16;
1085 lba |= ((u64)scsicmd[4]) << 8;
1086 lba |= ((u64)scsicmd[5]);
1088 len |= ((u32)scsicmd[7]) << 8;
1089 len |= ((u32)scsicmd[8]);
1096 * scsi_16_lba_len - Get LBA and transfer length
1097 * @scsicmd: SCSI command to translate
1099 * Calculate LBA and transfer length for 16-byte commands.
1103 * @plen: the transfer length
1106 static void scsi_16_lba_len(const u8 *scsicmd, u64 *plba, u32 *plen)
1111 VPRINTK("sixteen-byte command\n");
1113 lba |= ((u64)scsicmd[2]) << 56;
1114 lba |= ((u64)scsicmd[3]) << 48;
1115 lba |= ((u64)scsicmd[4]) << 40;
1116 lba |= ((u64)scsicmd[5]) << 32;
1117 lba |= ((u64)scsicmd[6]) << 24;
1118 lba |= ((u64)scsicmd[7]) << 16;
1119 lba |= ((u64)scsicmd[8]) << 8;
1120 lba |= ((u64)scsicmd[9]);
1122 len |= ((u32)scsicmd[10]) << 24;
1123 len |= ((u32)scsicmd[11]) << 16;
1124 len |= ((u32)scsicmd[12]) << 8;
1125 len |= ((u32)scsicmd[13]);
1132 * ata_scsi_verify_xlat - Translate SCSI VERIFY command into an ATA one
1133 * @qc: Storage for translated ATA taskfile
1134 * @scsicmd: SCSI command to translate
1136 * Converts SCSI VERIFY command to an ATA READ VERIFY command.
1139 * spin_lock_irqsave(host lock)
1142 * Zero on success, non-zero on error.
1145 static unsigned int ata_scsi_verify_xlat(struct ata_queued_cmd *qc, const u8 *scsicmd)
1147 struct ata_taskfile *tf = &qc->tf;
1148 struct ata_device *dev = qc->dev;
1149 u64 dev_sectors = qc->dev->n_sectors;
1153 tf->flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
1154 tf->protocol = ATA_PROT_NODATA;
1156 if (scsicmd[0] == VERIFY)
1157 scsi_10_lba_len(scsicmd, &block, &n_block);
1158 else if (scsicmd[0] == VERIFY_16)
1159 scsi_16_lba_len(scsicmd, &block, &n_block);
1165 if (block >= dev_sectors)
1167 if ((block + n_block) > dev_sectors)
1170 if (dev->flags & ATA_DFLAG_LBA) {
1171 tf->flags |= ATA_TFLAG_LBA;
1173 if (lba_28_ok(block, n_block)) {
1175 tf->command = ATA_CMD_VERIFY;
1176 tf->device |= (block >> 24) & 0xf;
1177 } else if (lba_48_ok(block, n_block)) {
1178 if (!(dev->flags & ATA_DFLAG_LBA48))
1182 tf->flags |= ATA_TFLAG_LBA48;
1183 tf->command = ATA_CMD_VERIFY_EXT;
1185 tf->hob_nsect = (n_block >> 8) & 0xff;
1187 tf->hob_lbah = (block >> 40) & 0xff;
1188 tf->hob_lbam = (block >> 32) & 0xff;
1189 tf->hob_lbal = (block >> 24) & 0xff;
1191 /* request too large even for LBA48 */
1194 tf->nsect = n_block & 0xff;
1196 tf->lbah = (block >> 16) & 0xff;
1197 tf->lbam = (block >> 8) & 0xff;
1198 tf->lbal = block & 0xff;
1200 tf->device |= ATA_LBA;
1203 u32 sect, head, cyl, track;
1205 if (!lba_28_ok(block, n_block))
1208 /* Convert LBA to CHS */
1209 track = (u32)block / dev->sectors;
1210 cyl = track / dev->heads;
1211 head = track % dev->heads;
1212 sect = (u32)block % dev->sectors + 1;
1214 DPRINTK("block %u track %u cyl %u head %u sect %u\n",
1215 (u32)block, track, cyl, head, sect);
1217 /* Check whether the converted CHS can fit.
1221 if ((cyl >> 16) || (head >> 4) || (sect >> 8) || (!sect))
1224 tf->command = ATA_CMD_VERIFY;
1225 tf->nsect = n_block & 0xff; /* Sector count 0 means 256 sectors */
1228 tf->lbah = cyl >> 8;
1235 ata_scsi_set_sense(qc->scsicmd, ILLEGAL_REQUEST, 0x24, 0x0);
1236 /* "Invalid field in cbd" */
1240 ata_scsi_set_sense(qc->scsicmd, ILLEGAL_REQUEST, 0x21, 0x0);
1241 /* "Logical Block Address out of range" */
1245 qc->scsicmd->result = SAM_STAT_GOOD;
1250 * ata_scsi_rw_xlat - Translate SCSI r/w command into an ATA one
1251 * @qc: Storage for translated ATA taskfile
1252 * @scsicmd: SCSI command to translate
1254 * Converts any of six SCSI read/write commands into the
1255 * ATA counterpart, including starting sector (LBA),
1256 * sector count, and taking into account the device's LBA48
1259 * Commands %READ_6, %READ_10, %READ_16, %WRITE_6, %WRITE_10, and
1260 * %WRITE_16 are currently supported.
1263 * spin_lock_irqsave(host lock)
1266 * Zero on success, non-zero on error.
1269 static unsigned int ata_scsi_rw_xlat(struct ata_queued_cmd *qc, const u8 *scsicmd)
1271 struct ata_taskfile *tf = &qc->tf;
1272 struct ata_device *dev = qc->dev;
1276 qc->flags |= ATA_QCFLAG_IO;
1277 tf->flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
1279 if (scsicmd[0] == WRITE_10 || scsicmd[0] == WRITE_6 ||
1280 scsicmd[0] == WRITE_16)
1281 tf->flags |= ATA_TFLAG_WRITE;
1283 /* Calculate the SCSI LBA, transfer length and FUA. */
1284 switch (scsicmd[0]) {
1287 scsi_10_lba_len(scsicmd, &block, &n_block);
1288 if (unlikely(scsicmd[1] & (1 << 3)))
1289 tf->flags |= ATA_TFLAG_FUA;
1293 scsi_6_lba_len(scsicmd, &block, &n_block);
1295 /* for 6-byte r/w commands, transfer length 0
1296 * means 256 blocks of data, not 0 block.
1303 scsi_16_lba_len(scsicmd, &block, &n_block);
1304 if (unlikely(scsicmd[1] & (1 << 3)))
1305 tf->flags |= ATA_TFLAG_FUA;
1308 DPRINTK("no-byte command\n");
1312 /* Check and compose ATA command */
1314 /* For 10-byte and 16-byte SCSI R/W commands, transfer
1315 * length 0 means transfer 0 block of data.
1316 * However, for ATA R/W commands, sector count 0 means
1317 * 256 or 65536 sectors, not 0 sectors as in SCSI.
1319 * WARNING: one or two older ATA drives treat 0 as 0...
1323 if ((dev->flags & (ATA_DFLAG_PIO | ATA_DFLAG_NCQ_OFF |
1324 ATA_DFLAG_NCQ)) == ATA_DFLAG_NCQ) {
1326 if (!lba_48_ok(block, n_block))
1329 tf->protocol = ATA_PROT_NCQ;
1330 tf->flags |= ATA_TFLAG_LBA | ATA_TFLAG_LBA48;
1332 if (tf->flags & ATA_TFLAG_WRITE)
1333 tf->command = ATA_CMD_FPDMA_WRITE;
1335 tf->command = ATA_CMD_FPDMA_READ;
1337 qc->nsect = n_block;
1339 tf->nsect = qc->tag << 3;
1340 tf->hob_feature = (n_block >> 8) & 0xff;
1341 tf->feature = n_block & 0xff;
1343 tf->hob_lbah = (block >> 40) & 0xff;
1344 tf->hob_lbam = (block >> 32) & 0xff;
1345 tf->hob_lbal = (block >> 24) & 0xff;
1346 tf->lbah = (block >> 16) & 0xff;
1347 tf->lbam = (block >> 8) & 0xff;
1348 tf->lbal = block & 0xff;
1350 tf->device = 1 << 6;
1351 if (tf->flags & ATA_TFLAG_FUA)
1352 tf->device |= 1 << 7;
1353 } else if (dev->flags & ATA_DFLAG_LBA) {
1354 tf->flags |= ATA_TFLAG_LBA;
1356 if (lba_28_ok(block, n_block)) {
1358 tf->device |= (block >> 24) & 0xf;
1359 } else if (lba_48_ok(block, n_block)) {
1360 if (!(dev->flags & ATA_DFLAG_LBA48))
1364 tf->flags |= ATA_TFLAG_LBA48;
1366 tf->hob_nsect = (n_block >> 8) & 0xff;
1368 tf->hob_lbah = (block >> 40) & 0xff;
1369 tf->hob_lbam = (block >> 32) & 0xff;
1370 tf->hob_lbal = (block >> 24) & 0xff;
1372 /* request too large even for LBA48 */
1375 if (unlikely(ata_rwcmd_protocol(qc) < 0))
1378 qc->nsect = n_block;
1379 tf->nsect = n_block & 0xff;
1381 tf->lbah = (block >> 16) & 0xff;
1382 tf->lbam = (block >> 8) & 0xff;
1383 tf->lbal = block & 0xff;
1385 tf->device |= ATA_LBA;
1388 u32 sect, head, cyl, track;
1390 /* The request -may- be too large for CHS addressing. */
1391 if (!lba_28_ok(block, n_block))
1394 if (unlikely(ata_rwcmd_protocol(qc) < 0))
1397 /* Convert LBA to CHS */
1398 track = (u32)block / dev->sectors;
1399 cyl = track / dev->heads;
1400 head = track % dev->heads;
1401 sect = (u32)block % dev->sectors + 1;
1403 DPRINTK("block %u track %u cyl %u head %u sect %u\n",
1404 (u32)block, track, cyl, head, sect);
1406 /* Check whether the converted CHS can fit.
1410 if ((cyl >> 16) || (head >> 4) || (sect >> 8) || (!sect))
1413 qc->nsect = n_block;
1414 tf->nsect = n_block & 0xff; /* Sector count 0 means 256 sectors */
1417 tf->lbah = cyl >> 8;
1424 ata_scsi_set_sense(qc->scsicmd, ILLEGAL_REQUEST, 0x24, 0x0);
1425 /* "Invalid field in cbd" */
1429 ata_scsi_set_sense(qc->scsicmd, ILLEGAL_REQUEST, 0x21, 0x0);
1430 /* "Logical Block Address out of range" */
1434 qc->scsicmd->result = SAM_STAT_GOOD;
1438 static void ata_scsi_qc_complete(struct ata_queued_cmd *qc)
1440 struct ata_port *ap = qc->ap;
1441 struct scsi_cmnd *cmd = qc->scsicmd;
1442 u8 *cdb = cmd->cmnd;
1443 int need_sense = (qc->err_mask != 0);
1445 /* We snoop the SET_FEATURES - Write Cache ON/OFF command, and
1446 * schedule EH_REVALIDATE operation to update the IDENTIFY DEVICE
1449 if (ap->ops->error_handler &&
1450 !need_sense && (qc->tf.command == ATA_CMD_SET_FEATURES) &&
1451 ((qc->tf.feature == SETFEATURES_WC_ON) ||
1452 (qc->tf.feature == SETFEATURES_WC_OFF))) {
1453 ap->eh_info.action |= ATA_EH_REVALIDATE;
1454 ata_port_schedule_eh(ap);
1457 /* For ATA pass thru (SAT) commands, generate a sense block if
1458 * user mandated it or if there's an error. Note that if we
1459 * generate because the user forced us to, a check condition
1460 * is generated and the ATA register values are returned
1461 * whether the command completed successfully or not. If there
1462 * was no error, SK, ASC and ASCQ will all be zero.
1464 if (((cdb[0] == ATA_16) || (cdb[0] == ATA_12)) &&
1465 ((cdb[2] & 0x20) || need_sense)) {
1466 ata_gen_ata_desc_sense(qc);
1469 cmd->result = SAM_STAT_GOOD;
1471 /* TODO: decide which descriptor format to use
1472 * for 48b LBA devices and call that here
1473 * instead of the fixed desc, which is only
1474 * good for smaller LBA (and maybe CHS?)
1477 ata_gen_fixed_sense(qc);
1481 if (need_sense && !ap->ops->error_handler)
1482 ata_dump_status(ap->id, &qc->result_tf);
1490 * ata_scmd_need_defer - Check whether we need to defer scmd
1491 * @dev: ATA device to which the command is addressed
1492 * @is_io: Is the command IO (and thus possibly NCQ)?
1494 * NCQ and non-NCQ commands cannot run together. As upper layer
1495 * only knows the queue depth, we are responsible for maintaining
1496 * exclusion. This function checks whether a new command can be
1500 * spin_lock_irqsave(host lock)
1503 * 1 if deferring is needed, 0 otherwise.
1505 static int ata_scmd_need_defer(struct ata_device *dev, int is_io)
1507 struct ata_port *ap = dev->ap;
1509 if (!(dev->flags & ATA_DFLAG_NCQ))
1513 if (!ata_tag_valid(ap->active_tag))
1516 if (!ata_tag_valid(ap->active_tag) && !ap->sactive)
1523 * ata_scsi_translate - Translate then issue SCSI command to ATA device
1524 * @dev: ATA device to which the command is addressed
1525 * @cmd: SCSI command to execute
1526 * @done: SCSI command completion function
1527 * @xlat_func: Actor which translates @cmd to an ATA taskfile
1529 * Our ->queuecommand() function has decided that the SCSI
1530 * command issued can be directly translated into an ATA
1531 * command, rather than handled internally.
1533 * This function sets up an ata_queued_cmd structure for the
1534 * SCSI command, and sends that ata_queued_cmd to the hardware.
1536 * The xlat_func argument (actor) returns 0 if ready to execute
1537 * ATA command, else 1 to finish translation. If 1 is returned
1538 * then cmd->result (and possibly cmd->sense_buffer) are assumed
1539 * to be set reflecting an error condition or clean (early)
1543 * spin_lock_irqsave(host lock)
1546 * 0 on success, SCSI_ML_QUEUE_DEVICE_BUSY if the command
1547 * needs to be deferred.
1549 static int ata_scsi_translate(struct ata_device *dev, struct scsi_cmnd *cmd,
1550 void (*done)(struct scsi_cmnd *),
1551 ata_xlat_func_t xlat_func)
1553 struct ata_queued_cmd *qc;
1554 u8 *scsicmd = cmd->cmnd;
1555 int is_io = xlat_func == ata_scsi_rw_xlat;
1559 if (unlikely(ata_scmd_need_defer(dev, is_io)))
1562 qc = ata_scsi_qc_new(dev, cmd, done);
1566 /* data is present; dma-map it */
1567 if (cmd->sc_data_direction == DMA_FROM_DEVICE ||
1568 cmd->sc_data_direction == DMA_TO_DEVICE) {
1569 if (unlikely(cmd->request_bufflen < 1)) {
1570 ata_dev_printk(dev, KERN_WARNING,
1571 "WARNING: zero len r/w req\n");
1576 ata_sg_init(qc, cmd->request_buffer, cmd->use_sg);
1578 ata_sg_init_one(qc, cmd->request_buffer,
1579 cmd->request_bufflen);
1581 qc->dma_dir = cmd->sc_data_direction;
1584 qc->complete_fn = ata_scsi_qc_complete;
1586 if (xlat_func(qc, scsicmd))
1589 /* select device, send command to hardware */
1598 DPRINTK("EXIT - early finish (good or error)\n");
1603 cmd->result = (DID_ERROR << 16);
1606 DPRINTK("EXIT - internal\n");
1610 DPRINTK("EXIT - defer\n");
1611 return SCSI_MLQUEUE_DEVICE_BUSY;
1615 * ata_scsi_rbuf_get - Map response buffer.
1616 * @cmd: SCSI command containing buffer to be mapped.
1617 * @buf_out: Pointer to mapped area.
1619 * Maps buffer contained within SCSI command @cmd.
1622 * spin_lock_irqsave(host lock)
1625 * Length of response buffer.
1628 static unsigned int ata_scsi_rbuf_get(struct scsi_cmnd *cmd, u8 **buf_out)
1631 unsigned int buflen;
1634 struct scatterlist *sg;
1636 sg = (struct scatterlist *) cmd->request_buffer;
1637 buf = kmap_atomic(sg->page, KM_USER0) + sg->offset;
1638 buflen = sg->length;
1640 buf = cmd->request_buffer;
1641 buflen = cmd->request_bufflen;
1649 * ata_scsi_rbuf_put - Unmap response buffer.
1650 * @cmd: SCSI command containing buffer to be unmapped.
1651 * @buf: buffer to unmap
1653 * Unmaps response buffer contained within @cmd.
1656 * spin_lock_irqsave(host lock)
1659 static inline void ata_scsi_rbuf_put(struct scsi_cmnd *cmd, u8 *buf)
1662 struct scatterlist *sg;
1664 sg = (struct scatterlist *) cmd->request_buffer;
1665 kunmap_atomic(buf - sg->offset, KM_USER0);
1670 * ata_scsi_rbuf_fill - wrapper for SCSI command simulators
1671 * @args: device IDENTIFY data / SCSI command of interest.
1672 * @actor: Callback hook for desired SCSI command simulator
1674 * Takes care of the hard work of simulating a SCSI command...
1675 * Mapping the response buffer, calling the command's handler,
1676 * and handling the handler's return value. This return value
1677 * indicates whether the handler wishes the SCSI command to be
1678 * completed successfully (0), or not (in which case cmd->result
1679 * and sense buffer are assumed to be set).
1682 * spin_lock_irqsave(host lock)
1685 void ata_scsi_rbuf_fill(struct ata_scsi_args *args,
1686 unsigned int (*actor) (struct ata_scsi_args *args,
1687 u8 *rbuf, unsigned int buflen))
1690 unsigned int buflen, rc;
1691 struct scsi_cmnd *cmd = args->cmd;
1693 buflen = ata_scsi_rbuf_get(cmd, &rbuf);
1694 memset(rbuf, 0, buflen);
1695 rc = actor(args, rbuf, buflen);
1696 ata_scsi_rbuf_put(cmd, rbuf);
1699 cmd->result = SAM_STAT_GOOD;
1704 * ata_scsiop_inq_std - Simulate INQUIRY command
1705 * @args: device IDENTIFY data / SCSI command of interest.
1706 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1707 * @buflen: Response buffer length.
1709 * Returns standard device identification data associated
1710 * with non-VPD INQUIRY command output.
1713 * spin_lock_irqsave(host lock)
1716 unsigned int ata_scsiop_inq_std(struct ata_scsi_args *args, u8 *rbuf,
1717 unsigned int buflen)
1722 0x5, /* claim SPC-3 version compatibility */
1727 /* set scsi removeable (RMB) bit per ata bit */
1728 if (ata_id_removeable(args->id))
1733 memcpy(rbuf, hdr, sizeof(hdr));
1736 memcpy(&rbuf[8], "ATA ", 8);
1737 ata_id_string(args->id, &rbuf[16], ATA_ID_PROD_OFS, 16);
1738 ata_id_string(args->id, &rbuf[32], ATA_ID_FW_REV_OFS, 4);
1739 if (rbuf[32] == 0 || rbuf[32] == ' ')
1740 memcpy(&rbuf[32], "n/a ", 4);
1744 const u8 versions[] = {
1745 0x60, /* SAM-3 (no version claimed) */
1748 0x20, /* SBC-2 (no version claimed) */
1751 0x60 /* SPC-3 (no version claimed) */
1754 memcpy(rbuf + 59, versions, sizeof(versions));
1761 * ata_scsiop_inq_00 - Simulate INQUIRY VPD page 0, list of pages
1762 * @args: device IDENTIFY data / SCSI command of interest.
1763 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1764 * @buflen: Response buffer length.
1766 * Returns list of inquiry VPD pages available.
1769 * spin_lock_irqsave(host lock)
1772 unsigned int ata_scsiop_inq_00(struct ata_scsi_args *args, u8 *rbuf,
1773 unsigned int buflen)
1775 const u8 pages[] = {
1776 0x00, /* page 0x00, this page */
1777 0x80, /* page 0x80, unit serial no page */
1778 0x83 /* page 0x83, device ident page */
1780 rbuf[3] = sizeof(pages); /* number of supported VPD pages */
1783 memcpy(rbuf + 4, pages, sizeof(pages));
1789 * ata_scsiop_inq_80 - Simulate INQUIRY VPD page 80, device serial number
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 * Returns ATA device serial number.
1797 * spin_lock_irqsave(host lock)
1800 unsigned int ata_scsiop_inq_80(struct ata_scsi_args *args, u8 *rbuf,
1801 unsigned int buflen)
1805 0x80, /* this page code */
1807 ATA_SERNO_LEN, /* page len */
1809 memcpy(rbuf, hdr, sizeof(hdr));
1811 if (buflen > (ATA_SERNO_LEN + 4 - 1))
1812 ata_id_string(args->id, (unsigned char *) &rbuf[4],
1813 ATA_ID_SERNO_OFS, ATA_SERNO_LEN);
1819 * ata_scsiop_inq_83 - Simulate INQUIRY VPD page 83, device identity
1820 * @args: device IDENTIFY data / SCSI command of interest.
1821 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1822 * @buflen: Response buffer length.
1824 * Yields two logical unit device identification designators:
1825 * - vendor specific ASCII containing the ATA serial number
1826 * - SAT defined "t10 vendor id based" containing ASCII vendor
1827 * name ("ATA "), model and serial numbers.
1830 * spin_lock_irqsave(host lock)
1833 unsigned int ata_scsiop_inq_83(struct ata_scsi_args *args, u8 *rbuf,
1834 unsigned int buflen)
1837 const int sat_model_serial_desc_len = 68;
1838 const int ata_model_byte_len = 40;
1840 rbuf[1] = 0x83; /* this page code */
1843 if (buflen > (ATA_SERNO_LEN + num + 3)) {
1844 /* piv=0, assoc=lu, code_set=ACSII, designator=vendor */
1846 rbuf[num + 3] = ATA_SERNO_LEN;
1848 ata_id_string(args->id, (unsigned char *) rbuf + num,
1849 ATA_ID_SERNO_OFS, ATA_SERNO_LEN);
1850 num += ATA_SERNO_LEN;
1852 if (buflen > (sat_model_serial_desc_len + num + 3)) {
1853 /* SAT defined lu model and serial numbers descriptor */
1854 /* piv=0, assoc=lu, code_set=ACSII, designator=t10 vendor id */
1857 rbuf[num + 3] = sat_model_serial_desc_len;
1859 memcpy(rbuf + num, "ATA ", 8);
1861 ata_id_string(args->id, (unsigned char *) rbuf + num,
1862 ATA_ID_PROD_OFS, ata_model_byte_len);
1863 num += ata_model_byte_len;
1864 ata_id_string(args->id, (unsigned char *) rbuf + num,
1865 ATA_ID_SERNO_OFS, ATA_SERNO_LEN);
1866 num += ATA_SERNO_LEN;
1868 rbuf[3] = num - 4; /* page len (assume less than 256 bytes) */
1873 * ata_scsiop_noop - Command handler that simply returns success.
1874 * @args: device IDENTIFY data / SCSI command of interest.
1875 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1876 * @buflen: Response buffer length.
1878 * No operation. Simply returns success to caller, to indicate
1879 * that the caller should successfully complete this SCSI command.
1882 * spin_lock_irqsave(host lock)
1885 unsigned int ata_scsiop_noop(struct ata_scsi_args *args, u8 *rbuf,
1886 unsigned int buflen)
1893 * ata_msense_push - Push data onto MODE SENSE data output buffer
1894 * @ptr_io: (input/output) Location to store more output data
1895 * @last: End of output data buffer
1896 * @buf: Pointer to BLOB being added to output buffer
1897 * @buflen: Length of BLOB
1899 * Store MODE SENSE data on an output buffer.
1905 static void ata_msense_push(u8 **ptr_io, const u8 *last,
1906 const u8 *buf, unsigned int buflen)
1910 if ((ptr + buflen - 1) > last)
1913 memcpy(ptr, buf, buflen);
1921 * ata_msense_caching - Simulate MODE SENSE caching info page
1922 * @id: device IDENTIFY data
1923 * @ptr_io: (input/output) Location to store more output data
1924 * @last: End of output data buffer
1926 * Generate a caching info page, which conditionally indicates
1927 * write caching to the SCSI layer, depending on device
1934 static unsigned int ata_msense_caching(u16 *id, u8 **ptr_io,
1937 u8 page[CACHE_MPAGE_LEN];
1939 memcpy(page, def_cache_mpage, sizeof(page));
1940 if (ata_id_wcache_enabled(id))
1941 page[2] |= (1 << 2); /* write cache enable */
1942 if (!ata_id_rahead_enabled(id))
1943 page[12] |= (1 << 5); /* disable read ahead */
1945 ata_msense_push(ptr_io, last, page, sizeof(page));
1946 return sizeof(page);
1950 * ata_msense_ctl_mode - Simulate MODE SENSE control mode page
1951 * @dev: Device associated with this MODE SENSE command
1952 * @ptr_io: (input/output) Location to store more output data
1953 * @last: End of output data buffer
1955 * Generate a generic MODE SENSE control mode page.
1961 static unsigned int ata_msense_ctl_mode(u8 **ptr_io, const u8 *last)
1963 ata_msense_push(ptr_io, last, def_control_mpage,
1964 sizeof(def_control_mpage));
1965 return sizeof(def_control_mpage);
1969 * ata_msense_rw_recovery - Simulate MODE SENSE r/w error recovery page
1970 * @dev: Device associated with this MODE SENSE command
1971 * @ptr_io: (input/output) Location to store more output data
1972 * @last: End of output data buffer
1974 * Generate a generic MODE SENSE r/w error recovery page.
1980 static unsigned int ata_msense_rw_recovery(u8 **ptr_io, const u8 *last)
1983 ata_msense_push(ptr_io, last, def_rw_recovery_mpage,
1984 sizeof(def_rw_recovery_mpage));
1985 return sizeof(def_rw_recovery_mpage);
1989 * We can turn this into a real blacklist if it's needed, for now just
1990 * blacklist any Maxtor BANC1G10 revision firmware
1992 static int ata_dev_supports_fua(u16 *id)
1994 unsigned char model[41], fw[9];
1998 if (!ata_id_has_fua(id))
2001 ata_id_c_string(id, model, ATA_ID_PROD_OFS, sizeof(model));
2002 ata_id_c_string(id, fw, ATA_ID_FW_REV_OFS, sizeof(fw));
2004 if (strcmp(model, "Maxtor"))
2006 if (strcmp(fw, "BANC1G10"))
2009 return 0; /* blacklisted */
2013 * ata_scsiop_mode_sense - Simulate MODE SENSE 6, 10 commands
2014 * @args: device IDENTIFY data / SCSI command of interest.
2015 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2016 * @buflen: Response buffer length.
2018 * Simulate MODE SENSE commands. Assume this is invoked for direct
2019 * access devices (e.g. disks) only. There should be no block
2020 * descriptor for other device types.
2023 * spin_lock_irqsave(host lock)
2026 unsigned int ata_scsiop_mode_sense(struct ata_scsi_args *args, u8 *rbuf,
2027 unsigned int buflen)
2029 struct ata_device *dev = args->dev;
2030 u8 *scsicmd = args->cmd->cmnd, *p, *last;
2031 const u8 sat_blk_desc[] = {
2032 0, 0, 0, 0, /* number of blocks: sat unspecified */
2034 0, 0x2, 0x0 /* block length: 512 bytes */
2037 unsigned int ebd, page_control, six_byte, output_len, alloc_len, minlen;
2042 six_byte = (scsicmd[0] == MODE_SENSE);
2043 ebd = !(scsicmd[1] & 0x8); /* dbd bit inverted == edb */
2045 * LLBA bit in msense(10) ignored (compliant)
2048 page_control = scsicmd[2] >> 6;
2049 switch (page_control) {
2050 case 0: /* current */
2051 break; /* supported */
2053 goto saving_not_supp;
2054 case 1: /* changeable */
2055 case 2: /* defaults */
2061 output_len = 4 + (ebd ? 8 : 0);
2062 alloc_len = scsicmd[4];
2064 output_len = 8 + (ebd ? 8 : 0);
2065 alloc_len = (scsicmd[7] << 8) + scsicmd[8];
2067 minlen = (alloc_len < buflen) ? alloc_len : buflen;
2069 p = rbuf + output_len;
2070 last = rbuf + minlen - 1;
2072 pg = scsicmd[2] & 0x3f;
2075 * No mode subpages supported (yet) but asking for _all_
2076 * subpages may be valid
2078 if (spg && (spg != ALL_SUB_MPAGES))
2082 case RW_RECOVERY_MPAGE:
2083 output_len += ata_msense_rw_recovery(&p, last);
2087 output_len += ata_msense_caching(args->id, &p, last);
2090 case CONTROL_MPAGE: {
2091 output_len += ata_msense_ctl_mode(&p, last);
2096 output_len += ata_msense_rw_recovery(&p, last);
2097 output_len += ata_msense_caching(args->id, &p, last);
2098 output_len += ata_msense_ctl_mode(&p, last);
2101 default: /* invalid page code */
2109 if (ata_dev_supports_fua(args->id) && (dev->flags & ATA_DFLAG_LBA48) &&
2110 (!(dev->flags & ATA_DFLAG_PIO) || dev->multi_count))
2115 rbuf[0] = output_len;
2120 rbuf[3] = sizeof(sat_blk_desc);
2122 memcpy(rbuf + 4, sat_blk_desc,
2123 sizeof(sat_blk_desc));
2127 rbuf[0] = output_len >> 8;
2129 rbuf[1] = output_len;
2134 rbuf[7] = sizeof(sat_blk_desc);
2136 memcpy(rbuf + 8, sat_blk_desc,
2137 sizeof(sat_blk_desc));
2143 ata_scsi_set_sense(args->cmd, ILLEGAL_REQUEST, 0x24, 0x0);
2144 /* "Invalid field in cbd" */
2148 ata_scsi_set_sense(args->cmd, ILLEGAL_REQUEST, 0x39, 0x0);
2149 /* "Saving parameters not supported" */
2154 * ata_scsiop_read_cap - Simulate READ CAPACITY[ 16] commands
2155 * @args: device IDENTIFY data / SCSI command of interest.
2156 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2157 * @buflen: Response buffer length.
2159 * Simulate READ CAPACITY commands.
2162 * spin_lock_irqsave(host lock)
2165 unsigned int ata_scsiop_read_cap(struct ata_scsi_args *args, u8 *rbuf,
2166 unsigned int buflen)
2173 if (ata_id_has_lba(args->id)) {
2174 if (ata_id_has_lba48(args->id))
2175 n_sectors = ata_id_u64(args->id, 100);
2177 n_sectors = ata_id_u32(args->id, 60);
2179 /* CHS default translation */
2180 n_sectors = args->id[1] * args->id[3] * args->id[6];
2182 if (ata_id_current_chs_valid(args->id))
2183 /* CHS current translation */
2184 n_sectors = ata_id_u32(args->id, 57);
2187 n_sectors--; /* ATA TotalUserSectors - 1 */
2189 if (args->cmd->cmnd[0] == READ_CAPACITY) {
2190 if( n_sectors >= 0xffffffffULL )
2191 tmp = 0xffffffff ; /* Return max count on overflow */
2195 /* sector count, 32-bit */
2196 rbuf[0] = tmp >> (8 * 3);
2197 rbuf[1] = tmp >> (8 * 2);
2198 rbuf[2] = tmp >> (8 * 1);
2202 tmp = ATA_SECT_SIZE;
2207 /* sector count, 64-bit */
2208 tmp = n_sectors >> (8 * 4);
2209 rbuf[2] = tmp >> (8 * 3);
2210 rbuf[3] = tmp >> (8 * 2);
2211 rbuf[4] = tmp >> (8 * 1);
2214 rbuf[6] = tmp >> (8 * 3);
2215 rbuf[7] = tmp >> (8 * 2);
2216 rbuf[8] = tmp >> (8 * 1);
2220 tmp = ATA_SECT_SIZE;
2221 rbuf[12] = tmp >> 8;
2229 * ata_scsiop_report_luns - Simulate REPORT LUNS command
2230 * @args: device IDENTIFY data / SCSI command of interest.
2231 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2232 * @buflen: Response buffer length.
2234 * Simulate REPORT LUNS command.
2237 * spin_lock_irqsave(host lock)
2240 unsigned int ata_scsiop_report_luns(struct ata_scsi_args *args, u8 *rbuf,
2241 unsigned int buflen)
2244 rbuf[3] = 8; /* just one lun, LUN 0, size 8 bytes */
2250 * ata_scsi_set_sense - Set SCSI sense data and status
2251 * @cmd: SCSI request to be handled
2252 * @sk: SCSI-defined sense key
2253 * @asc: SCSI-defined additional sense code
2254 * @ascq: SCSI-defined additional sense code qualifier
2256 * Helper function that builds a valid fixed format, current
2257 * response code and the given sense key (sk), additional sense
2258 * code (asc) and additional sense code qualifier (ascq) with
2259 * a SCSI command status of %SAM_STAT_CHECK_CONDITION and
2260 * DRIVER_SENSE set in the upper bits of scsi_cmnd::result .
2266 void ata_scsi_set_sense(struct scsi_cmnd *cmd, u8 sk, u8 asc, u8 ascq)
2268 cmd->result = (DRIVER_SENSE << 24) | SAM_STAT_CHECK_CONDITION;
2270 cmd->sense_buffer[0] = 0x70; /* fixed format, current */
2271 cmd->sense_buffer[2] = sk;
2272 cmd->sense_buffer[7] = 18 - 8; /* additional sense length */
2273 cmd->sense_buffer[12] = asc;
2274 cmd->sense_buffer[13] = ascq;
2278 * ata_scsi_badcmd - End a SCSI request with an error
2279 * @cmd: SCSI request to be handled
2280 * @done: SCSI command completion function
2281 * @asc: SCSI-defined additional sense code
2282 * @ascq: SCSI-defined additional sense code qualifier
2284 * Helper function that completes a SCSI command with
2285 * %SAM_STAT_CHECK_CONDITION, with a sense key %ILLEGAL_REQUEST
2286 * and the specified additional sense codes.
2289 * spin_lock_irqsave(host lock)
2292 void ata_scsi_badcmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *), u8 asc, u8 ascq)
2295 ata_scsi_set_sense(cmd, ILLEGAL_REQUEST, asc, ascq);
2300 static void atapi_sense_complete(struct ata_queued_cmd *qc)
2302 if (qc->err_mask && ((qc->err_mask & AC_ERR_DEV) == 0)) {
2303 /* FIXME: not quite right; we don't want the
2304 * translation of taskfile registers into
2305 * a sense descriptors, since that's only
2306 * correct for ATA, not ATAPI
2308 ata_gen_ata_desc_sense(qc);
2311 qc->scsidone(qc->scsicmd);
2315 /* is it pointless to prefer PIO for "safety reasons"? */
2316 static inline int ata_pio_use_silly(struct ata_port *ap)
2318 return (ap->flags & ATA_FLAG_PIO_DMA);
2321 static void atapi_request_sense(struct ata_queued_cmd *qc)
2323 struct ata_port *ap = qc->ap;
2324 struct scsi_cmnd *cmd = qc->scsicmd;
2326 DPRINTK("ATAPI request sense\n");
2328 /* FIXME: is this needed? */
2329 memset(cmd->sense_buffer, 0, sizeof(cmd->sense_buffer));
2331 ap->ops->tf_read(ap, &qc->tf);
2333 /* fill these in, for the case where they are -not- overwritten */
2334 cmd->sense_buffer[0] = 0x70;
2335 cmd->sense_buffer[2] = qc->tf.feature >> 4;
2339 ata_sg_init_one(qc, cmd->sense_buffer, sizeof(cmd->sense_buffer));
2340 qc->dma_dir = DMA_FROM_DEVICE;
2342 memset(&qc->cdb, 0, qc->dev->cdb_len);
2343 qc->cdb[0] = REQUEST_SENSE;
2344 qc->cdb[4] = SCSI_SENSE_BUFFERSIZE;
2346 qc->tf.flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
2347 qc->tf.command = ATA_CMD_PACKET;
2349 if (ata_pio_use_silly(ap)) {
2350 qc->tf.protocol = ATA_PROT_ATAPI_DMA;
2351 qc->tf.feature |= ATAPI_PKT_DMA;
2353 qc->tf.protocol = ATA_PROT_ATAPI;
2354 qc->tf.lbam = (8 * 1024) & 0xff;
2355 qc->tf.lbah = (8 * 1024) >> 8;
2357 qc->nbytes = SCSI_SENSE_BUFFERSIZE;
2359 qc->complete_fn = atapi_sense_complete;
2366 static void atapi_qc_complete(struct ata_queued_cmd *qc)
2368 struct scsi_cmnd *cmd = qc->scsicmd;
2369 unsigned int err_mask = qc->err_mask;
2371 VPRINTK("ENTER, err_mask 0x%X\n", err_mask);
2373 /* handle completion from new EH */
2374 if (unlikely(qc->ap->ops->error_handler &&
2375 (err_mask || qc->flags & ATA_QCFLAG_SENSE_VALID))) {
2377 if (!(qc->flags & ATA_QCFLAG_SENSE_VALID)) {
2378 /* FIXME: not quite right; we don't want the
2379 * translation of taskfile registers into a
2380 * sense descriptors, since that's only
2381 * correct for ATA, not ATAPI
2383 ata_gen_ata_desc_sense(qc);
2386 /* SCSI EH automatically locks door if sdev->locked is
2387 * set. Sometimes door lock request continues to
2388 * fail, for example, when no media is present. This
2389 * creates a loop - SCSI EH issues door lock which
2390 * fails and gets invoked again to acquire sense data
2391 * for the failed command.
2393 * If door lock fails, always clear sdev->locked to
2394 * avoid this infinite loop.
2396 if (qc->cdb[0] == ALLOW_MEDIUM_REMOVAL)
2397 qc->dev->sdev->locked = 0;
2399 qc->scsicmd->result = SAM_STAT_CHECK_CONDITION;
2405 /* successful completion or old EH failure path */
2406 if (unlikely(err_mask & AC_ERR_DEV)) {
2407 cmd->result = SAM_STAT_CHECK_CONDITION;
2408 atapi_request_sense(qc);
2410 } else if (unlikely(err_mask)) {
2411 /* FIXME: not quite right; we don't want the
2412 * translation of taskfile registers into
2413 * a sense descriptors, since that's only
2414 * correct for ATA, not ATAPI
2416 ata_gen_ata_desc_sense(qc);
2418 u8 *scsicmd = cmd->cmnd;
2420 if ((scsicmd[0] == INQUIRY) && ((scsicmd[1] & 0x03) == 0)) {
2422 unsigned int buflen;
2424 buflen = ata_scsi_rbuf_get(cmd, &buf);
2426 /* ATAPI devices typically report zero for their SCSI version,
2427 * and sometimes deviate from the spec WRT response data
2428 * format. If SCSI version is reported as zero like normal,
2429 * then we make the following fixups: 1) Fake MMC-5 version,
2430 * to indicate to the Linux scsi midlayer this is a modern
2431 * device. 2) Ensure response data format / ATAPI information
2432 * are always correct.
2439 ata_scsi_rbuf_put(cmd, buf);
2442 cmd->result = SAM_STAT_GOOD;
2449 * atapi_xlat - Initialize PACKET taskfile
2450 * @qc: command structure to be initialized
2451 * @scsicmd: SCSI CDB associated with this PACKET command
2454 * spin_lock_irqsave(host lock)
2457 * Zero on success, non-zero on failure.
2460 static unsigned int atapi_xlat(struct ata_queued_cmd *qc, const u8 *scsicmd)
2462 struct scsi_cmnd *cmd = qc->scsicmd;
2463 struct ata_device *dev = qc->dev;
2464 int using_pio = (dev->flags & ATA_DFLAG_PIO);
2465 int nodata = (cmd->sc_data_direction == DMA_NONE);
2468 /* Check whether ATAPI DMA is safe */
2469 if (ata_check_atapi_dma(qc))
2472 memcpy(&qc->cdb, scsicmd, dev->cdb_len);
2474 qc->complete_fn = atapi_qc_complete;
2476 qc->tf.flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
2477 if (cmd->sc_data_direction == DMA_TO_DEVICE) {
2478 qc->tf.flags |= ATA_TFLAG_WRITE;
2479 DPRINTK("direction: write\n");
2482 qc->tf.command = ATA_CMD_PACKET;
2484 /* no data, or PIO data xfer */
2485 if (using_pio || nodata) {
2487 qc->tf.protocol = ATA_PROT_ATAPI_NODATA;
2489 qc->tf.protocol = ATA_PROT_ATAPI;
2490 qc->tf.lbam = (8 * 1024) & 0xff;
2491 qc->tf.lbah = (8 * 1024) >> 8;
2496 qc->tf.protocol = ATA_PROT_ATAPI_DMA;
2497 qc->tf.feature |= ATAPI_PKT_DMA;
2499 if (atapi_dmadir && (cmd->sc_data_direction != DMA_TO_DEVICE))
2500 /* some SATA bridges need us to indicate data xfer direction */
2501 qc->tf.feature |= ATAPI_DMADIR;
2504 qc->nbytes = cmd->request_bufflen;
2509 static struct ata_device * ata_find_dev(struct ata_port *ap, int id)
2511 if (likely(id < ATA_MAX_DEVICES))
2512 return &ap->device[id];
2516 static struct ata_device * __ata_scsi_find_dev(struct ata_port *ap,
2517 const struct scsi_device *scsidev)
2519 /* skip commands not addressed to targets we simulate */
2520 if (unlikely(scsidev->channel || scsidev->lun))
2523 return ata_find_dev(ap, scsidev->id);
2527 * ata_scsi_dev_enabled - determine if device is enabled
2530 * Determine if commands should be sent to the specified device.
2533 * spin_lock_irqsave(host lock)
2536 * 0 if commands are not allowed / 1 if commands are allowed
2539 static int ata_scsi_dev_enabled(struct ata_device *dev)
2541 if (unlikely(!ata_dev_enabled(dev)))
2544 if (!atapi_enabled || (dev->ap->flags & ATA_FLAG_NO_ATAPI)) {
2545 if (unlikely(dev->class == ATA_DEV_ATAPI)) {
2546 ata_dev_printk(dev, KERN_WARNING,
2547 "WARNING: ATAPI is %s, device ignored.\n",
2548 atapi_enabled ? "not supported with this driver" : "disabled");
2557 * ata_scsi_find_dev - lookup ata_device from scsi_cmnd
2558 * @ap: ATA port to which the device is attached
2559 * @scsidev: SCSI device from which we derive the ATA device
2561 * Given various information provided in struct scsi_cmnd,
2562 * map that onto an ATA bus, and using that mapping
2563 * determine which ata_device is associated with the
2564 * SCSI command to be sent.
2567 * spin_lock_irqsave(host lock)
2570 * Associated ATA device, or %NULL if not found.
2572 static struct ata_device *
2573 ata_scsi_find_dev(struct ata_port *ap, const struct scsi_device *scsidev)
2575 struct ata_device *dev = __ata_scsi_find_dev(ap, scsidev);
2577 if (unlikely(!dev || !ata_scsi_dev_enabled(dev)))
2584 * ata_scsi_map_proto - Map pass-thru protocol value to taskfile value.
2585 * @byte1: Byte 1 from pass-thru CDB.
2588 * ATA_PROT_UNKNOWN if mapping failed/unimplemented, protocol otherwise.
2591 ata_scsi_map_proto(u8 byte1)
2593 switch((byte1 & 0x1e) >> 1) {
2594 case 3: /* Non-data */
2595 return ATA_PROT_NODATA;
2598 return ATA_PROT_DMA;
2600 case 4: /* PIO Data-in */
2601 case 5: /* PIO Data-out */
2602 return ATA_PROT_PIO;
2604 case 10: /* Device Reset */
2605 case 0: /* Hard Reset */
2607 case 2: /* Bus Idle */
2608 case 7: /* Packet */
2609 case 8: /* DMA Queued */
2610 case 9: /* Device Diagnostic */
2611 case 11: /* UDMA Data-in */
2612 case 12: /* UDMA Data-Out */
2613 case 13: /* FPDMA */
2614 default: /* Reserved */
2618 return ATA_PROT_UNKNOWN;
2622 * ata_scsi_pass_thru - convert ATA pass-thru CDB to taskfile
2623 * @qc: command structure to be initialized
2624 * @scsicmd: SCSI command to convert
2626 * Handles either 12 or 16-byte versions of the CDB.
2629 * Zero on success, non-zero on failure.
2632 ata_scsi_pass_thru(struct ata_queued_cmd *qc, const u8 *scsicmd)
2634 struct ata_taskfile *tf = &(qc->tf);
2635 struct scsi_cmnd *cmd = qc->scsicmd;
2636 struct ata_device *dev = qc->dev;
2638 if ((tf->protocol = ata_scsi_map_proto(scsicmd[1])) == ATA_PROT_UNKNOWN)
2641 /* We may not issue DMA commands if no DMA mode is set */
2642 if (tf->protocol == ATA_PROT_DMA && dev->dma_mode == 0)
2645 if (scsicmd[1] & 0xe0)
2646 /* PIO multi not supported yet */
2650 * 12 and 16 byte CDBs use different offsets to
2651 * provide the various register values.
2653 if (scsicmd[0] == ATA_16) {
2655 * 16-byte CDB - may contain extended commands.
2657 * If that is the case, copy the upper byte register values.
2659 if (scsicmd[1] & 0x01) {
2660 tf->hob_feature = scsicmd[3];
2661 tf->hob_nsect = scsicmd[5];
2662 tf->hob_lbal = scsicmd[7];
2663 tf->hob_lbam = scsicmd[9];
2664 tf->hob_lbah = scsicmd[11];
2665 tf->flags |= ATA_TFLAG_LBA48;
2667 tf->flags &= ~ATA_TFLAG_LBA48;
2670 * Always copy low byte, device and command registers.
2672 tf->feature = scsicmd[4];
2673 tf->nsect = scsicmd[6];
2674 tf->lbal = scsicmd[8];
2675 tf->lbam = scsicmd[10];
2676 tf->lbah = scsicmd[12];
2677 tf->device = scsicmd[13];
2678 tf->command = scsicmd[14];
2681 * 12-byte CDB - incapable of extended commands.
2683 tf->flags &= ~ATA_TFLAG_LBA48;
2685 tf->feature = scsicmd[3];
2686 tf->nsect = scsicmd[4];
2687 tf->lbal = scsicmd[5];
2688 tf->lbam = scsicmd[6];
2689 tf->lbah = scsicmd[7];
2690 tf->device = scsicmd[8];
2691 tf->command = scsicmd[9];
2694 * If slave is possible, enforce correct master/slave bit
2696 if (qc->ap->flags & ATA_FLAG_SLAVE_POSS)
2697 tf->device = qc->dev->devno ?
2698 tf->device | ATA_DEV1 : tf->device & ~ATA_DEV1;
2701 * Filter SET_FEATURES - XFER MODE command -- otherwise,
2702 * SET_FEATURES - XFER MODE must be preceded/succeeded
2703 * by an update to hardware-specific registers for each
2704 * controller (i.e. the reason for ->set_piomode(),
2705 * ->set_dmamode(), and ->post_set_mode() hooks).
2707 if ((tf->command == ATA_CMD_SET_FEATURES)
2708 && (tf->feature == SETFEATURES_XFER))
2712 * Set flags so that all registers will be written,
2713 * and pass on write indication (used for PIO/DMA
2716 tf->flags |= (ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE);
2718 if (cmd->sc_data_direction == DMA_TO_DEVICE)
2719 tf->flags |= ATA_TFLAG_WRITE;
2722 * Set transfer length.
2724 * TODO: find out if we need to do more here to
2725 * cover scatter/gather case.
2727 qc->nsect = cmd->request_bufflen / ATA_SECT_SIZE;
2729 /* request result TF */
2730 qc->flags |= ATA_QCFLAG_RESULT_TF;
2735 ata_scsi_set_sense(qc->scsicmd, ILLEGAL_REQUEST, 0x24, 0x00);
2736 /* "Invalid field in cdb" */
2741 * ata_get_xlat_func - check if SCSI to ATA translation is possible
2743 * @cmd: SCSI command opcode to consider
2745 * Look up the SCSI command given, and determine whether the
2746 * SCSI command is to be translated or simulated.
2749 * Pointer to translation function if possible, %NULL if not.
2752 static inline ata_xlat_func_t ata_get_xlat_func(struct ata_device *dev, u8 cmd)
2762 return ata_scsi_rw_xlat;
2764 case SYNCHRONIZE_CACHE:
2765 if (ata_try_flush_cache(dev))
2766 return ata_scsi_flush_xlat;
2771 return ata_scsi_verify_xlat;
2775 return ata_scsi_pass_thru;
2778 return ata_scsi_start_stop_xlat;
2785 * ata_scsi_dump_cdb - dump SCSI command contents to dmesg
2786 * @ap: ATA port to which the command was being sent
2787 * @cmd: SCSI command to dump
2789 * Prints the contents of a SCSI command via printk().
2792 static inline void ata_scsi_dump_cdb(struct ata_port *ap,
2793 struct scsi_cmnd *cmd)
2796 struct scsi_device *scsidev = cmd->device;
2797 u8 *scsicmd = cmd->cmnd;
2799 DPRINTK("CDB (%u:%d,%d,%d) %02x %02x %02x %02x %02x %02x %02x %02x %02x\n",
2801 scsidev->channel, scsidev->id, scsidev->lun,
2802 scsicmd[0], scsicmd[1], scsicmd[2], scsicmd[3],
2803 scsicmd[4], scsicmd[5], scsicmd[6], scsicmd[7],
2808 static inline int __ata_scsi_queuecmd(struct scsi_cmnd *cmd,
2809 void (*done)(struct scsi_cmnd *),
2810 struct ata_device *dev)
2814 if (dev->class == ATA_DEV_ATA) {
2815 ata_xlat_func_t xlat_func = ata_get_xlat_func(dev,
2819 rc = ata_scsi_translate(dev, cmd, done, xlat_func);
2821 ata_scsi_simulate(dev, cmd, done);
2823 rc = ata_scsi_translate(dev, cmd, done, atapi_xlat);
2829 * ata_scsi_queuecmd - Issue SCSI cdb to libata-managed device
2830 * @cmd: SCSI command to be sent
2831 * @done: Completion function, called when command is complete
2833 * In some cases, this function translates SCSI commands into
2834 * ATA taskfiles, and queues the taskfiles to be sent to
2835 * hardware. In other cases, this function simulates a
2836 * SCSI device by evaluating and responding to certain
2837 * SCSI commands. This creates the overall effect of
2838 * ATA and ATAPI devices appearing as SCSI devices.
2841 * Releases scsi-layer-held lock, and obtains host lock.
2844 * Return value from __ata_scsi_queuecmd() if @cmd can be queued,
2847 int ata_scsi_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *))
2849 struct ata_port *ap;
2850 struct ata_device *dev;
2851 struct scsi_device *scsidev = cmd->device;
2852 struct Scsi_Host *shost = scsidev->host;
2855 ap = ata_shost_to_port(shost);
2857 spin_unlock(shost->host_lock);
2858 spin_lock(ap->lock);
2860 ata_scsi_dump_cdb(ap, cmd);
2862 dev = ata_scsi_find_dev(ap, scsidev);
2864 rc = __ata_scsi_queuecmd(cmd, done, dev);
2866 cmd->result = (DID_BAD_TARGET << 16);
2870 spin_unlock(ap->lock);
2871 spin_lock(shost->host_lock);
2876 * ata_scsi_simulate - simulate SCSI command on ATA device
2877 * @dev: the target device
2878 * @cmd: SCSI command being sent to device.
2879 * @done: SCSI command completion function.
2881 * Interprets and directly executes a select list of SCSI commands
2882 * that can be handled internally.
2885 * spin_lock_irqsave(host lock)
2888 void ata_scsi_simulate(struct ata_device *dev, struct scsi_cmnd *cmd,
2889 void (*done)(struct scsi_cmnd *))
2891 struct ata_scsi_args args;
2892 const u8 *scsicmd = cmd->cmnd;
2899 switch(scsicmd[0]) {
2900 /* no-op's, complete with success */
2901 case SYNCHRONIZE_CACHE:
2905 case TEST_UNIT_READY:
2906 case FORMAT_UNIT: /* FIXME: correct? */
2907 case SEND_DIAGNOSTIC: /* FIXME: correct? */
2908 ata_scsi_rbuf_fill(&args, ata_scsiop_noop);
2912 if (scsicmd[1] & 2) /* is CmdDt set? */
2913 ata_scsi_invalid_field(cmd, done);
2914 else if ((scsicmd[1] & 1) == 0) /* is EVPD clear? */
2915 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_std);
2916 else if (scsicmd[2] == 0x00)
2917 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_00);
2918 else if (scsicmd[2] == 0x80)
2919 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_80);
2920 else if (scsicmd[2] == 0x83)
2921 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_83);
2923 ata_scsi_invalid_field(cmd, done);
2928 ata_scsi_rbuf_fill(&args, ata_scsiop_mode_sense);
2931 case MODE_SELECT: /* unconditionally return */
2932 case MODE_SELECT_10: /* bad-field-in-cdb */
2933 ata_scsi_invalid_field(cmd, done);
2937 ata_scsi_rbuf_fill(&args, ata_scsiop_read_cap);
2940 case SERVICE_ACTION_IN:
2941 if ((scsicmd[1] & 0x1f) == SAI_READ_CAPACITY_16)
2942 ata_scsi_rbuf_fill(&args, ata_scsiop_read_cap);
2944 ata_scsi_invalid_field(cmd, done);
2948 ata_scsi_rbuf_fill(&args, ata_scsiop_report_luns);
2951 /* mandatory commands we haven't implemented yet */
2954 /* all other commands */
2956 ata_scsi_set_sense(cmd, ILLEGAL_REQUEST, 0x20, 0x0);
2957 /* "Invalid command operation code" */
2963 void ata_scsi_scan_host(struct ata_port *ap)
2967 if (ap->flags & ATA_FLAG_DISABLED)
2970 for (i = 0; i < ATA_MAX_DEVICES; i++) {
2971 struct ata_device *dev = &ap->device[i];
2972 struct scsi_device *sdev;
2974 if (!ata_dev_enabled(dev) || dev->sdev)
2977 sdev = __scsi_add_device(ap->scsi_host, 0, i, 0, NULL);
2978 if (!IS_ERR(sdev)) {
2980 scsi_device_put(sdev);
2986 * ata_scsi_offline_dev - offline attached SCSI device
2987 * @dev: ATA device to offline attached SCSI device for
2989 * This function is called from ata_eh_hotplug() and responsible
2990 * for taking the SCSI device attached to @dev offline. This
2991 * function is called with host lock which protects dev->sdev
2995 * spin_lock_irqsave(host lock)
2998 * 1 if attached SCSI device exists, 0 otherwise.
3000 int ata_scsi_offline_dev(struct ata_device *dev)
3003 scsi_device_set_state(dev->sdev, SDEV_OFFLINE);
3010 * ata_scsi_remove_dev - remove attached SCSI device
3011 * @dev: ATA device to remove attached SCSI device for
3013 * This function is called from ata_eh_scsi_hotplug() and
3014 * responsible for removing the SCSI device attached to @dev.
3017 * Kernel thread context (may sleep).
3019 static void ata_scsi_remove_dev(struct ata_device *dev)
3021 struct ata_port *ap = dev->ap;
3022 struct scsi_device *sdev;
3023 unsigned long flags;
3025 /* Alas, we need to grab scan_mutex to ensure SCSI device
3026 * state doesn't change underneath us and thus
3027 * scsi_device_get() always succeeds. The mutex locking can
3028 * be removed if there is __scsi_device_get() interface which
3029 * increments reference counts regardless of device state.
3031 mutex_lock(&ap->scsi_host->scan_mutex);
3032 spin_lock_irqsave(ap->lock, flags);
3034 /* clearing dev->sdev is protected by host lock */
3039 /* If user initiated unplug races with us, sdev can go
3040 * away underneath us after the host lock and
3041 * scan_mutex are released. Hold onto it.
3043 if (scsi_device_get(sdev) == 0) {
3044 /* The following ensures the attached sdev is
3045 * offline on return from ata_scsi_offline_dev()
3046 * regardless it wins or loses the race
3047 * against this function.
3049 scsi_device_set_state(sdev, SDEV_OFFLINE);
3056 spin_unlock_irqrestore(ap->lock, flags);
3057 mutex_unlock(&ap->scsi_host->scan_mutex);
3060 ata_dev_printk(dev, KERN_INFO, "detaching (SCSI %s)\n",
3061 sdev->sdev_gendev.bus_id);
3063 scsi_remove_device(sdev);
3064 scsi_device_put(sdev);
3069 * ata_scsi_hotplug - SCSI part of hotplug
3070 * @data: Pointer to ATA port to perform SCSI hotplug on
3072 * Perform SCSI part of hotplug. It's executed from a separate
3073 * workqueue after EH completes. This is necessary because SCSI
3074 * hot plugging requires working EH and hot unplugging is
3075 * synchronized with hot plugging with a mutex.
3078 * Kernel thread context (may sleep).
3080 void ata_scsi_hotplug(void *data)
3082 struct ata_port *ap = data;
3085 if (ap->pflags & ATA_PFLAG_UNLOADING) {
3086 DPRINTK("ENTER/EXIT - unloading\n");
3092 /* unplug detached devices */
3093 for (i = 0; i < ATA_MAX_DEVICES; i++) {
3094 struct ata_device *dev = &ap->device[i];
3095 unsigned long flags;
3097 if (!(dev->flags & ATA_DFLAG_DETACHED))
3100 spin_lock_irqsave(ap->lock, flags);
3101 dev->flags &= ~ATA_DFLAG_DETACHED;
3102 spin_unlock_irqrestore(ap->lock, flags);
3104 ata_scsi_remove_dev(dev);
3107 /* scan for new ones */
3108 ata_scsi_scan_host(ap);
3110 /* If we scanned while EH was in progress, scan would have
3111 * failed silently. Requeue if there are enabled but
3112 * unattached devices.
3114 for (i = 0; i < ATA_MAX_DEVICES; i++) {
3115 struct ata_device *dev = &ap->device[i];
3116 if (ata_dev_enabled(dev) && !dev->sdev) {
3117 queue_delayed_work(ata_aux_wq, &ap->hotplug_task, HZ);
3126 * ata_scsi_user_scan - indication for user-initiated bus scan
3127 * @shost: SCSI host to scan
3128 * @channel: Channel to scan
3132 * This function is called when user explicitly requests bus
3133 * scan. Set probe pending flag and invoke EH.
3136 * SCSI layer (we don't care)
3141 static int ata_scsi_user_scan(struct Scsi_Host *shost, unsigned int channel,
3142 unsigned int id, unsigned int lun)
3144 struct ata_port *ap = ata_shost_to_port(shost);
3145 unsigned long flags;
3148 if (!ap->ops->error_handler)
3151 if ((channel != SCAN_WILD_CARD && channel != 0) ||
3152 (lun != SCAN_WILD_CARD && lun != 0))
3155 spin_lock_irqsave(ap->lock, flags);
3157 if (id == SCAN_WILD_CARD) {
3158 ap->eh_info.probe_mask |= (1 << ATA_MAX_DEVICES) - 1;
3159 ap->eh_info.action |= ATA_EH_SOFTRESET;
3161 struct ata_device *dev = ata_find_dev(ap, id);
3164 ap->eh_info.probe_mask |= 1 << dev->devno;
3165 ap->eh_info.action |= ATA_EH_SOFTRESET;
3166 ap->eh_info.flags |= ATA_EHI_RESUME_LINK;
3172 ata_port_schedule_eh(ap);
3173 spin_unlock_irqrestore(ap->lock, flags);
3174 ata_port_wait_eh(ap);
3176 spin_unlock_irqrestore(ap->lock, flags);
3182 * ata_scsi_dev_rescan - initiate scsi_rescan_device()
3183 * @data: Pointer to ATA port to perform scsi_rescan_device()
3185 * After ATA pass thru (SAT) commands are executed successfully,
3186 * libata need to propagate the changes to SCSI layer. This
3187 * function must be executed from ata_aux_wq such that sdev
3188 * attach/detach don't race with rescan.
3191 * Kernel thread context (may sleep).
3193 void ata_scsi_dev_rescan(void *data)
3195 struct ata_port *ap = data;
3196 struct ata_device *dev;
3199 for (i = 0; i < ATA_MAX_DEVICES; i++) {
3200 dev = &ap->device[i];
3202 if (ata_dev_enabled(dev) && dev->sdev)
3203 scsi_rescan_device(&(dev->sdev->sdev_gendev));
3208 * ata_sas_port_alloc - Allocate port for a SAS attached SATA device
3209 * @host: ATA host container for all SAS ports
3210 * @port_info: Information from low-level host driver
3211 * @shost: SCSI host that the scsi device is attached to
3214 * PCI/etc. bus probe sem.
3217 * ata_port pointer on success / NULL on failure.
3220 struct ata_port *ata_sas_port_alloc(struct ata_host *host,
3221 struct ata_port_info *port_info,
3222 struct Scsi_Host *shost)
3224 struct ata_port *ap = kzalloc(sizeof(*ap), GFP_KERNEL);
3225 struct ata_probe_ent *ent;
3230 ent = ata_probe_ent_alloc(host->dev, port_info);
3236 ata_port_init(ap, host, ent, 0);
3237 ap->lock = shost->host_lock;
3241 EXPORT_SYMBOL_GPL(ata_sas_port_alloc);
3244 * ata_sas_port_start - Set port up for dma.
3245 * @ap: Port to initialize
3247 * Called just after data structures for each port are
3248 * initialized. Allocates DMA pad.
3250 * May be used as the port_start() entry in ata_port_operations.
3253 * Inherited from caller.
3255 int ata_sas_port_start(struct ata_port *ap)
3257 return ata_pad_alloc(ap, ap->dev);
3259 EXPORT_SYMBOL_GPL(ata_sas_port_start);
3262 * ata_port_stop - Undo ata_sas_port_start()
3263 * @ap: Port to shut down
3265 * Frees the DMA pad.
3267 * May be used as the port_stop() entry in ata_port_operations.
3270 * Inherited from caller.
3273 void ata_sas_port_stop(struct ata_port *ap)
3275 ata_pad_free(ap, ap->dev);
3277 EXPORT_SYMBOL_GPL(ata_sas_port_stop);
3280 * ata_sas_port_init - Initialize a SATA device
3281 * @ap: SATA port to initialize
3284 * PCI/etc. bus probe sem.
3287 * Zero on success, non-zero on error.
3290 int ata_sas_port_init(struct ata_port *ap)
3292 int rc = ap->ops->port_start(ap);
3295 rc = ata_bus_probe(ap);
3299 EXPORT_SYMBOL_GPL(ata_sas_port_init);
3302 * ata_sas_port_destroy - Destroy a SATA port allocated by ata_sas_port_alloc
3303 * @ap: SATA port to destroy
3307 void ata_sas_port_destroy(struct ata_port *ap)
3309 ap->ops->port_stop(ap);
3312 EXPORT_SYMBOL_GPL(ata_sas_port_destroy);
3315 * ata_sas_slave_configure - Default slave_config routine for libata devices
3316 * @sdev: SCSI device to configure
3317 * @ap: ATA port to which SCSI device is attached
3323 int ata_sas_slave_configure(struct scsi_device *sdev, struct ata_port *ap)
3325 ata_scsi_sdev_config(sdev);
3326 ata_scsi_dev_config(sdev, ap->device);
3329 EXPORT_SYMBOL_GPL(ata_sas_slave_configure);
3332 * ata_sas_queuecmd - Issue SCSI cdb to libata-managed device
3333 * @cmd: SCSI command to be sent
3334 * @done: Completion function, called when command is complete
3335 * @ap: ATA port to which the command is being sent
3338 * Return value from __ata_scsi_queuecmd() if @cmd can be queued,
3342 int ata_sas_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *),
3343 struct ata_port *ap)
3347 ata_scsi_dump_cdb(ap, cmd);
3349 if (likely(ata_scsi_dev_enabled(ap->device)))
3350 rc = __ata_scsi_queuecmd(cmd, done, ap->device);
3352 cmd->result = (DID_BAD_TARGET << 16);
3357 EXPORT_SYMBOL_GPL(ata_sas_queuecmd);