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_eh.h>
42 #include <scsi/scsi_device.h>
43 #include <scsi/scsi_request.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;
169 struct scsi_sense_hdr sshdr;
170 enum dma_data_direction data_dir;
175 if (copy_from_user(args, arg, sizeof(args)))
178 memset(scsi_cmd, 0, sizeof(scsi_cmd));
181 argsize = SECTOR_SIZE * args[3];
182 argbuf = kmalloc(argsize, GFP_KERNEL);
183 if (argbuf == NULL) {
188 scsi_cmd[1] = (4 << 1); /* PIO Data-in */
189 scsi_cmd[2] = 0x0e; /* no off.line or cc, read from dev,
190 block count in sector count field */
191 data_dir = DMA_FROM_DEVICE;
193 scsi_cmd[1] = (3 << 1); /* Non-data */
194 /* scsi_cmd[2] is already 0 -- no off.line, cc, or data xfer */
198 scsi_cmd[0] = ATA_16;
200 scsi_cmd[4] = args[2];
201 if (args[0] == WIN_SMART) { /* hack -- ide driver does this too... */
202 scsi_cmd[6] = args[3];
203 scsi_cmd[8] = args[1];
207 scsi_cmd[6] = args[1];
209 scsi_cmd[14] = args[0];
211 /* Good values for timeout and retries? Values below
212 from scsi_ioctl_send_command() for default case... */
213 if (scsi_execute_req(scsidev, scsi_cmd, data_dir, argbuf, argsize,
214 &sshdr, (10*HZ), 5)) {
219 /* Need code to retrieve data from check condition? */
222 && copy_to_user(arg + sizeof(args), argbuf, argsize))
232 * ata_task_ioctl - Handler for HDIO_DRIVE_TASK ioctl
233 * @scsidev: Device to which we are issuing command
234 * @arg: User provided data for issuing command
237 * Defined by the SCSI layer. We don't really care.
240 * Zero on success, negative errno on error.
242 int ata_task_ioctl(struct scsi_device *scsidev, void __user *arg)
245 u8 scsi_cmd[MAX_COMMAND_SIZE];
247 struct scsi_sense_hdr sshdr;
252 if (copy_from_user(args, arg, sizeof(args)))
255 memset(scsi_cmd, 0, sizeof(scsi_cmd));
256 scsi_cmd[0] = ATA_16;
257 scsi_cmd[1] = (3 << 1); /* Non-data */
258 /* scsi_cmd[2] is already 0 -- no off.line, cc, or data xfer */
259 scsi_cmd[4] = args[1];
260 scsi_cmd[6] = args[2];
261 scsi_cmd[8] = args[3];
262 scsi_cmd[10] = args[4];
263 scsi_cmd[12] = args[5];
264 scsi_cmd[14] = args[0];
266 /* Good values for timeout and retries? Values below
267 from scsi_ioctl_send_command() for default case... */
268 if (scsi_execute_req(scsidev, scsi_cmd, DMA_NONE, NULL, 0, &sshdr,
272 /* Need code to retrieve data from check condition? */
276 int ata_scsi_ioctl(struct scsi_device *scsidev, int cmd, void __user *arg)
278 int val = -EINVAL, rc = -EINVAL;
281 case ATA_IOC_GET_IO32:
283 if (copy_to_user(arg, &val, 1))
287 case ATA_IOC_SET_IO32:
288 val = (unsigned long) arg;
294 if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
296 return ata_cmd_ioctl(scsidev, arg);
298 case HDIO_DRIVE_TASK:
299 if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
301 return ata_task_ioctl(scsidev, arg);
312 * ata_scsi_qc_new - acquire new ata_queued_cmd reference
313 * @dev: ATA device to which the new command is attached
314 * @cmd: SCSI command that originated this ATA command
315 * @done: SCSI command completion function
317 * Obtain a reference to an unused ata_queued_cmd structure,
318 * which is the basic libata structure representing a single
319 * ATA command sent to the hardware.
321 * If a command was available, fill in the SCSI-specific
322 * portions of the structure with information on the
326 * spin_lock_irqsave(host_set lock)
329 * Command allocated, or %NULL if none available.
331 struct ata_queued_cmd *ata_scsi_qc_new(struct ata_device *dev,
332 struct scsi_cmnd *cmd,
333 void (*done)(struct scsi_cmnd *))
335 struct ata_queued_cmd *qc;
337 qc = ata_qc_new_init(dev);
343 qc->__sg = (struct scatterlist *) cmd->request_buffer;
344 qc->n_elem = cmd->use_sg;
346 qc->__sg = &qc->sgent;
350 cmd->result = (DID_OK << 16) | (QUEUE_FULL << 1);
358 * ata_dump_status - user friendly display of error info
359 * @id: id of the port in question
360 * @tf: ptr to filled out taskfile
362 * Decode and dump the ATA error/status registers for the user so
363 * that they have some idea what really happened at the non
364 * make-believe layer.
367 * inherited from caller
369 void ata_dump_status(unsigned id, struct ata_taskfile *tf)
371 u8 stat = tf->command, err = tf->feature;
373 printk(KERN_WARNING "ata%u: status=0x%02x { ", id, stat);
374 if (stat & ATA_BUSY) {
375 printk("Busy }\n"); /* Data is not valid in this case */
377 if (stat & 0x40) printk("DriveReady ");
378 if (stat & 0x20) printk("DeviceFault ");
379 if (stat & 0x10) printk("SeekComplete ");
380 if (stat & 0x08) printk("DataRequest ");
381 if (stat & 0x04) printk("CorrectedError ");
382 if (stat & 0x02) printk("Index ");
383 if (stat & 0x01) printk("Error ");
387 printk(KERN_WARNING "ata%u: error=0x%02x { ", id, err);
388 if (err & 0x04) printk("DriveStatusError ");
390 if (err & 0x04) printk("BadCRC ");
391 else printk("Sector ");
393 if (err & 0x40) printk("UncorrectableError ");
394 if (err & 0x10) printk("SectorIdNotFound ");
395 if (err & 0x02) printk("TrackZeroNotFound ");
396 if (err & 0x01) printk("AddrMarkNotFound ");
402 int ata_scsi_device_resume(struct scsi_device *sdev)
404 struct ata_port *ap = ata_shost_to_port(sdev->host);
405 struct ata_device *dev = __ata_scsi_find_dev(ap, sdev);
407 return ata_device_resume(dev);
410 int ata_scsi_device_suspend(struct scsi_device *sdev, pm_message_t state)
412 struct ata_port *ap = ata_shost_to_port(sdev->host);
413 struct ata_device *dev = __ata_scsi_find_dev(ap, sdev);
415 return ata_device_suspend(dev, state);
419 * ata_to_sense_error - convert ATA error to SCSI error
420 * @id: ATA device number
421 * @drv_stat: value contained in ATA status register
422 * @drv_err: value contained in ATA error register
423 * @sk: the sense key we'll fill out
424 * @asc: the additional sense code we'll fill out
425 * @ascq: the additional sense code qualifier we'll fill out
426 * @verbose: be verbose
428 * Converts an ATA error into a SCSI error. Fill out pointers to
429 * SK, ASC, and ASCQ bytes for later use in fixed or descriptor
430 * format sense blocks.
433 * spin_lock_irqsave(host_set lock)
435 void ata_to_sense_error(unsigned id, u8 drv_stat, u8 drv_err, u8 *sk, u8 *asc,
436 u8 *ascq, int verbose)
440 /* Based on the 3ware driver translation table */
441 static const unsigned char sense_table[][4] = {
443 {0xd1, ABORTED_COMMAND, 0x00, 0x00}, // Device busy Aborted command
445 {0xd0, ABORTED_COMMAND, 0x00, 0x00}, // Device busy Aborted command
447 {0x61, HARDWARE_ERROR, 0x00, 0x00}, // Device fault Hardware error
448 /* ICRC|ABRT */ /* NB: ICRC & !ABRT is BBD */
449 {0x84, ABORTED_COMMAND, 0x47, 0x00}, // Data CRC error SCSI parity error
450 /* MC|ID|ABRT|TRK0|MARK */
451 {0x37, NOT_READY, 0x04, 0x00}, // Unit offline Not ready
453 {0x09, NOT_READY, 0x04, 0x00}, // Unrecovered disk error Not ready
454 /* Bad address mark */
455 {0x01, MEDIUM_ERROR, 0x13, 0x00}, // Address mark not found Address mark not found for data field
457 {0x02, HARDWARE_ERROR, 0x00, 0x00}, // Track 0 not found Hardware error
459 {0x04, ABORTED_COMMAND, 0x00, 0x00}, // Aborted command Aborted command
460 /* Media change request */
461 {0x08, NOT_READY, 0x04, 0x00}, // Media change request FIXME: faking offline
463 {0x10, ABORTED_COMMAND, 0x14, 0x00}, // ID not found Recorded entity not found
465 {0x08, NOT_READY, 0x04, 0x00}, // Media change FIXME: faking offline
467 {0x40, MEDIUM_ERROR, 0x11, 0x04}, // Uncorrectable ECC error Unrecovered read error
468 /* BBD - block marked bad */
469 {0x80, MEDIUM_ERROR, 0x11, 0x04}, // Block marked bad Medium error, unrecovered read error
470 {0xFF, 0xFF, 0xFF, 0xFF}, // END mark
472 static const unsigned char stat_table[][4] = {
473 /* Must be first because BUSY means no other bits valid */
474 {0x80, ABORTED_COMMAND, 0x47, 0x00}, // Busy, fake parity for now
475 {0x20, HARDWARE_ERROR, 0x00, 0x00}, // Device fault
476 {0x08, ABORTED_COMMAND, 0x47, 0x00}, // Timed out in xfer, fake parity for now
477 {0x04, RECOVERED_ERROR, 0x11, 0x00}, // Recovered ECC error Medium error, recovered
478 {0xFF, 0xFF, 0xFF, 0xFF}, // END mark
482 * Is this an error we can process/parse
484 if (drv_stat & ATA_BUSY) {
485 drv_err = 0; /* Ignore the err bits, they're invalid */
489 /* Look for drv_err */
490 for (i = 0; sense_table[i][0] != 0xFF; i++) {
491 /* Look for best matches first */
492 if ((sense_table[i][0] & drv_err) ==
494 *sk = sense_table[i][1];
495 *asc = sense_table[i][2];
496 *ascq = sense_table[i][3];
500 /* No immediate match */
502 printk(KERN_WARNING "ata%u: no sense translation for "
503 "error 0x%02x\n", id, drv_err);
506 /* Fall back to interpreting status bits */
507 for (i = 0; stat_table[i][0] != 0xFF; i++) {
508 if (stat_table[i][0] & drv_stat) {
509 *sk = stat_table[i][1];
510 *asc = stat_table[i][2];
511 *ascq = stat_table[i][3];
515 /* No error? Undecoded? */
517 printk(KERN_WARNING "ata%u: no sense translation for "
518 "status: 0x%02x\n", id, drv_stat);
520 /* We need a sensible error return here, which is tricky, and one
521 that won't cause people to do things like return a disk wrongly */
522 *sk = ABORTED_COMMAND;
528 printk(KERN_ERR "ata%u: translated ATA stat/err 0x%02x/%02x "
529 "to SCSI SK/ASC/ASCQ 0x%x/%02x/%02x\n",
530 id, drv_stat, drv_err, *sk, *asc, *ascq);
535 * ata_gen_ata_desc_sense - Generate check condition sense block.
536 * @qc: Command that completed.
538 * This function is specific to the ATA descriptor format sense
539 * block specified for the ATA pass through commands. Regardless
540 * of whether the command errored or not, return a sense
541 * block. Copy all controller registers into the sense
542 * block. Clear sense key, ASC & ASCQ if there is no error.
545 * spin_lock_irqsave(host_set lock)
547 void ata_gen_ata_desc_sense(struct ata_queued_cmd *qc)
549 struct scsi_cmnd *cmd = qc->scsicmd;
550 struct ata_taskfile *tf = &qc->result_tf;
551 unsigned char *sb = cmd->sense_buffer;
552 unsigned char *desc = sb + 8;
553 int verbose = qc->ap->ops->error_handler == NULL;
555 memset(sb, 0, SCSI_SENSE_BUFFERSIZE);
557 cmd->result = (DRIVER_SENSE << 24) | SAM_STAT_CHECK_CONDITION;
560 * Use ata_to_sense_error() to map status register bits
561 * onto sense key, asc & ascq.
564 tf->command & (ATA_BUSY | ATA_DF | ATA_ERR | ATA_DRQ)) {
565 ata_to_sense_error(qc->ap->id, tf->command, tf->feature,
566 &sb[1], &sb[2], &sb[3], verbose);
571 * Sense data is current and format is descriptor.
578 * Set length of additional sense data.
579 * Since we only populate descriptor 0, the total
580 * length is the same (fixed) length as descriptor 0.
582 desc[1] = sb[7] = 14;
585 * Copy registers into sense buffer.
588 desc[3] = tf->feature; /* == error reg */
593 desc[12] = tf->device;
594 desc[13] = tf->command; /* == status reg */
597 * Fill in Extend bit, and the high order bytes
600 if (tf->flags & ATA_TFLAG_LBA48) {
602 desc[4] = tf->hob_nsect;
603 desc[6] = tf->hob_lbal;
604 desc[8] = tf->hob_lbam;
605 desc[10] = tf->hob_lbah;
610 * ata_gen_fixed_sense - generate a SCSI fixed sense block
611 * @qc: Command that we are erroring out
613 * Leverage ata_to_sense_error() to give us the codes. Fit our
614 * LBA in here if there's room.
617 * inherited from caller
619 void ata_gen_fixed_sense(struct ata_queued_cmd *qc)
621 struct scsi_cmnd *cmd = qc->scsicmd;
622 struct ata_taskfile *tf = &qc->result_tf;
623 unsigned char *sb = cmd->sense_buffer;
624 int verbose = qc->ap->ops->error_handler == NULL;
626 memset(sb, 0, SCSI_SENSE_BUFFERSIZE);
628 cmd->result = (DRIVER_SENSE << 24) | SAM_STAT_CHECK_CONDITION;
631 * Use ata_to_sense_error() to map status register bits
632 * onto sense key, asc & ascq.
635 tf->command & (ATA_BUSY | ATA_DF | ATA_ERR | ATA_DRQ)) {
636 ata_to_sense_error(qc->ap->id, tf->command, tf->feature,
637 &sb[2], &sb[12], &sb[13], verbose);
644 if (tf->flags & ATA_TFLAG_LBA48) {
645 /* TODO: find solution for LBA48 descriptors */
648 else if (tf->flags & ATA_TFLAG_LBA) {
649 /* A small (28b) LBA will fit in the 32b info field */
650 sb[0] |= 0x80; /* set valid bit */
651 sb[3] = tf->device & 0x0f;
662 static void ata_scsi_sdev_config(struct scsi_device *sdev)
664 sdev->use_10_for_rw = 1;
665 sdev->use_10_for_ms = 1;
668 static void ata_scsi_dev_config(struct scsi_device *sdev,
669 struct ata_device *dev)
671 unsigned int max_sectors;
673 /* TODO: 2048 is an arbitrary number, not the
674 * hardware maximum. This should be increased to
675 * 65534 when Jens Axboe's patch for dynamically
676 * determining max_sectors is merged.
678 max_sectors = ATA_MAX_SECTORS;
679 if (dev->flags & ATA_DFLAG_LBA48)
680 max_sectors = ATA_MAX_SECTORS_LBA48;
681 if (dev->max_sectors)
682 max_sectors = dev->max_sectors;
684 blk_queue_max_sectors(sdev->request_queue, max_sectors);
687 * SATA DMA transfers must be multiples of 4 byte, so
688 * we need to pad ATAPI transfers using an extra sg.
689 * Decrement max hw segments accordingly.
691 if (dev->class == ATA_DEV_ATAPI) {
692 request_queue_t *q = sdev->request_queue;
693 blk_queue_max_hw_segments(q, q->max_hw_segments - 1);
696 if (dev->flags & ATA_DFLAG_NCQ) {
699 depth = min(sdev->host->can_queue, ata_id_queue_depth(dev->id));
700 depth = min(ATA_MAX_QUEUE - 1, depth);
701 scsi_adjust_queue_depth(sdev, MSG_SIMPLE_TAG, depth);
706 * ata_scsi_slave_config - Set SCSI device attributes
707 * @sdev: SCSI device to examine
709 * This is called before we actually start reading
710 * and writing to the device, to configure certain
711 * SCSI mid-layer behaviors.
714 * Defined by SCSI layer. We don't really care.
717 int ata_scsi_slave_config(struct scsi_device *sdev)
719 struct ata_port *ap = ata_shost_to_port(sdev->host);
720 struct ata_device *dev = __ata_scsi_find_dev(ap, sdev);
722 ata_scsi_sdev_config(sdev);
724 blk_queue_max_phys_segments(sdev->request_queue, LIBATA_MAX_PRD);
727 ata_scsi_dev_config(sdev, dev);
729 return 0; /* scsi layer doesn't check return value, sigh */
733 * ata_scsi_slave_destroy - SCSI device is about to be destroyed
734 * @sdev: SCSI device to be destroyed
736 * @sdev is about to be destroyed for hot/warm unplugging. If
737 * this unplugging was initiated by libata as indicated by NULL
738 * dev->sdev, this function doesn't have to do anything.
739 * Otherwise, SCSI layer initiated warm-unplug is in progress.
740 * Clear dev->sdev, schedule the device for ATA detach and invoke
744 * Defined by SCSI layer. We don't really care.
746 void ata_scsi_slave_destroy(struct scsi_device *sdev)
748 struct ata_port *ap = ata_shost_to_port(sdev->host);
750 struct ata_device *dev;
752 if (!ap->ops->error_handler)
755 spin_lock_irqsave(&ap->host_set->lock, flags);
756 dev = __ata_scsi_find_dev(ap, sdev);
757 if (dev && dev->sdev) {
758 /* SCSI device already in CANCEL state, no need to offline it */
760 dev->flags |= ATA_DFLAG_DETACH;
761 ata_port_schedule_eh(ap);
763 spin_unlock_irqrestore(&ap->host_set->lock, flags);
767 * ata_scsi_change_queue_depth - SCSI callback for queue depth config
768 * @sdev: SCSI device to configure queue depth for
769 * @queue_depth: new queue depth
771 * This is libata standard hostt->change_queue_depth callback.
772 * SCSI will call into this callback when user tries to set queue
776 * SCSI layer (we don't care)
779 * Newly configured queue depth.
781 int ata_scsi_change_queue_depth(struct scsi_device *sdev, int queue_depth)
783 struct ata_port *ap = ata_shost_to_port(sdev->host);
784 struct ata_device *dev;
788 return sdev->queue_depth;
790 dev = ata_scsi_find_dev(ap, sdev);
791 if (!dev || !ata_dev_enabled(dev))
792 return sdev->queue_depth;
794 max_depth = min(sdev->host->can_queue, ata_id_queue_depth(dev->id));
795 max_depth = min(ATA_MAX_QUEUE - 1, max_depth);
796 if (queue_depth > max_depth)
797 queue_depth = max_depth;
799 scsi_adjust_queue_depth(sdev, MSG_SIMPLE_TAG, queue_depth);
804 * ata_scsi_start_stop_xlat - Translate SCSI START STOP UNIT command
805 * @qc: Storage for translated ATA taskfile
806 * @scsicmd: SCSI command to translate
808 * Sets up an ATA taskfile to issue STANDBY (to stop) or READ VERIFY
809 * (to start). Perhaps these commands should be preceded by
810 * CHECK POWER MODE to see what power mode the device is already in.
811 * [See SAT revision 5 at www.t10.org]
814 * spin_lock_irqsave(host_set lock)
817 * Zero on success, non-zero on error.
820 static unsigned int ata_scsi_start_stop_xlat(struct ata_queued_cmd *qc,
823 struct ata_taskfile *tf = &qc->tf;
825 tf->flags |= ATA_TFLAG_DEVICE | ATA_TFLAG_ISADDR;
826 tf->protocol = ATA_PROT_NODATA;
827 if (scsicmd[1] & 0x1) {
828 ; /* ignore IMMED bit, violates sat-r05 */
830 if (scsicmd[4] & 0x2)
831 goto invalid_fld; /* LOEJ bit set not supported */
832 if (((scsicmd[4] >> 4) & 0xf) != 0)
833 goto invalid_fld; /* power conditions not supported */
834 if (scsicmd[4] & 0x1) {
835 tf->nsect = 1; /* 1 sector, lba=0 */
837 if (qc->dev->flags & ATA_DFLAG_LBA) {
838 tf->flags |= ATA_TFLAG_LBA;
843 tf->device |= ATA_LBA;
846 tf->lbal = 0x1; /* sect */
847 tf->lbam = 0x0; /* cyl low */
848 tf->lbah = 0x0; /* cyl high */
851 tf->command = ATA_CMD_VERIFY; /* READ VERIFY */
853 tf->nsect = 0; /* time period value (0 implies now) */
854 tf->command = ATA_CMD_STANDBY;
855 /* Consider: ATA STANDBY IMMEDIATE command */
858 * Standby and Idle condition timers could be implemented but that
859 * would require libata to implement the Power condition mode page
860 * and allow the user to change it. Changing mode pages requires
861 * MODE SELECT to be implemented.
867 ata_scsi_set_sense(qc->scsicmd, ILLEGAL_REQUEST, 0x24, 0x0);
868 /* "Invalid field in cbd" */
874 * ata_scsi_flush_xlat - Translate SCSI SYNCHRONIZE CACHE command
875 * @qc: Storage for translated ATA taskfile
876 * @scsicmd: SCSI command to translate (ignored)
878 * Sets up an ATA taskfile to issue FLUSH CACHE or
882 * spin_lock_irqsave(host_set lock)
885 * Zero on success, non-zero on error.
888 static unsigned int ata_scsi_flush_xlat(struct ata_queued_cmd *qc, const u8 *scsicmd)
890 struct ata_taskfile *tf = &qc->tf;
892 tf->flags |= ATA_TFLAG_DEVICE;
893 tf->protocol = ATA_PROT_NODATA;
895 if ((qc->dev->flags & ATA_DFLAG_LBA48) &&
896 (ata_id_has_flush_ext(qc->dev->id)))
897 tf->command = ATA_CMD_FLUSH_EXT;
899 tf->command = ATA_CMD_FLUSH;
905 * scsi_6_lba_len - Get LBA and transfer length
906 * @scsicmd: SCSI command to translate
908 * Calculate LBA and transfer length for 6-byte commands.
912 * @plen: the transfer length
915 static void scsi_6_lba_len(const u8 *scsicmd, u64 *plba, u32 *plen)
920 VPRINTK("six-byte command\n");
922 lba |= ((u64)scsicmd[2]) << 8;
923 lba |= ((u64)scsicmd[3]);
925 len |= ((u32)scsicmd[4]);
932 * scsi_10_lba_len - Get LBA and transfer length
933 * @scsicmd: SCSI command to translate
935 * Calculate LBA and transfer length for 10-byte commands.
939 * @plen: the transfer length
942 static void scsi_10_lba_len(const u8 *scsicmd, u64 *plba, u32 *plen)
947 VPRINTK("ten-byte command\n");
949 lba |= ((u64)scsicmd[2]) << 24;
950 lba |= ((u64)scsicmd[3]) << 16;
951 lba |= ((u64)scsicmd[4]) << 8;
952 lba |= ((u64)scsicmd[5]);
954 len |= ((u32)scsicmd[7]) << 8;
955 len |= ((u32)scsicmd[8]);
962 * scsi_16_lba_len - Get LBA and transfer length
963 * @scsicmd: SCSI command to translate
965 * Calculate LBA and transfer length for 16-byte commands.
969 * @plen: the transfer length
972 static void scsi_16_lba_len(const u8 *scsicmd, u64 *plba, u32 *plen)
977 VPRINTK("sixteen-byte command\n");
979 lba |= ((u64)scsicmd[2]) << 56;
980 lba |= ((u64)scsicmd[3]) << 48;
981 lba |= ((u64)scsicmd[4]) << 40;
982 lba |= ((u64)scsicmd[5]) << 32;
983 lba |= ((u64)scsicmd[6]) << 24;
984 lba |= ((u64)scsicmd[7]) << 16;
985 lba |= ((u64)scsicmd[8]) << 8;
986 lba |= ((u64)scsicmd[9]);
988 len |= ((u32)scsicmd[10]) << 24;
989 len |= ((u32)scsicmd[11]) << 16;
990 len |= ((u32)scsicmd[12]) << 8;
991 len |= ((u32)scsicmd[13]);
998 * ata_scsi_verify_xlat - Translate SCSI VERIFY command into an ATA one
999 * @qc: Storage for translated ATA taskfile
1000 * @scsicmd: SCSI command to translate
1002 * Converts SCSI VERIFY command to an ATA READ VERIFY command.
1005 * spin_lock_irqsave(host_set lock)
1008 * Zero on success, non-zero on error.
1011 static unsigned int ata_scsi_verify_xlat(struct ata_queued_cmd *qc, const u8 *scsicmd)
1013 struct ata_taskfile *tf = &qc->tf;
1014 struct ata_device *dev = qc->dev;
1015 u64 dev_sectors = qc->dev->n_sectors;
1019 tf->flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
1020 tf->protocol = ATA_PROT_NODATA;
1022 if (scsicmd[0] == VERIFY)
1023 scsi_10_lba_len(scsicmd, &block, &n_block);
1024 else if (scsicmd[0] == VERIFY_16)
1025 scsi_16_lba_len(scsicmd, &block, &n_block);
1031 if (block >= dev_sectors)
1033 if ((block + n_block) > dev_sectors)
1036 if (dev->flags & ATA_DFLAG_LBA) {
1037 tf->flags |= ATA_TFLAG_LBA;
1039 if (lba_28_ok(block, n_block)) {
1041 tf->command = ATA_CMD_VERIFY;
1042 tf->device |= (block >> 24) & 0xf;
1043 } else if (lba_48_ok(block, n_block)) {
1044 if (!(dev->flags & ATA_DFLAG_LBA48))
1048 tf->flags |= ATA_TFLAG_LBA48;
1049 tf->command = ATA_CMD_VERIFY_EXT;
1051 tf->hob_nsect = (n_block >> 8) & 0xff;
1053 tf->hob_lbah = (block >> 40) & 0xff;
1054 tf->hob_lbam = (block >> 32) & 0xff;
1055 tf->hob_lbal = (block >> 24) & 0xff;
1057 /* request too large even for LBA48 */
1060 tf->nsect = n_block & 0xff;
1062 tf->lbah = (block >> 16) & 0xff;
1063 tf->lbam = (block >> 8) & 0xff;
1064 tf->lbal = block & 0xff;
1066 tf->device |= ATA_LBA;
1069 u32 sect, head, cyl, track;
1071 if (!lba_28_ok(block, n_block))
1074 /* Convert LBA to CHS */
1075 track = (u32)block / dev->sectors;
1076 cyl = track / dev->heads;
1077 head = track % dev->heads;
1078 sect = (u32)block % dev->sectors + 1;
1080 DPRINTK("block %u track %u cyl %u head %u sect %u\n",
1081 (u32)block, track, cyl, head, sect);
1083 /* Check whether the converted CHS can fit.
1087 if ((cyl >> 16) || (head >> 4) || (sect >> 8) || (!sect))
1090 tf->command = ATA_CMD_VERIFY;
1091 tf->nsect = n_block & 0xff; /* Sector count 0 means 256 sectors */
1094 tf->lbah = cyl >> 8;
1101 ata_scsi_set_sense(qc->scsicmd, ILLEGAL_REQUEST, 0x24, 0x0);
1102 /* "Invalid field in cbd" */
1106 ata_scsi_set_sense(qc->scsicmd, ILLEGAL_REQUEST, 0x21, 0x0);
1107 /* "Logical Block Address out of range" */
1111 qc->scsicmd->result = SAM_STAT_GOOD;
1116 * ata_scsi_rw_xlat - Translate SCSI r/w command into an ATA one
1117 * @qc: Storage for translated ATA taskfile
1118 * @scsicmd: SCSI command to translate
1120 * Converts any of six SCSI read/write commands into the
1121 * ATA counterpart, including starting sector (LBA),
1122 * sector count, and taking into account the device's LBA48
1125 * Commands %READ_6, %READ_10, %READ_16, %WRITE_6, %WRITE_10, and
1126 * %WRITE_16 are currently supported.
1129 * spin_lock_irqsave(host_set lock)
1132 * Zero on success, non-zero on error.
1135 static unsigned int ata_scsi_rw_xlat(struct ata_queued_cmd *qc, const u8 *scsicmd)
1137 struct ata_taskfile *tf = &qc->tf;
1138 struct ata_device *dev = qc->dev;
1142 qc->flags |= ATA_QCFLAG_IO;
1143 tf->flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
1145 if (scsicmd[0] == WRITE_10 || scsicmd[0] == WRITE_6 ||
1146 scsicmd[0] == WRITE_16)
1147 tf->flags |= ATA_TFLAG_WRITE;
1149 /* Calculate the SCSI LBA, transfer length and FUA. */
1150 switch (scsicmd[0]) {
1153 scsi_10_lba_len(scsicmd, &block, &n_block);
1154 if (unlikely(scsicmd[1] & (1 << 3)))
1155 tf->flags |= ATA_TFLAG_FUA;
1159 scsi_6_lba_len(scsicmd, &block, &n_block);
1161 /* for 6-byte r/w commands, transfer length 0
1162 * means 256 blocks of data, not 0 block.
1169 scsi_16_lba_len(scsicmd, &block, &n_block);
1170 if (unlikely(scsicmd[1] & (1 << 3)))
1171 tf->flags |= ATA_TFLAG_FUA;
1174 DPRINTK("no-byte command\n");
1178 /* Check and compose ATA command */
1180 /* For 10-byte and 16-byte SCSI R/W commands, transfer
1181 * length 0 means transfer 0 block of data.
1182 * However, for ATA R/W commands, sector count 0 means
1183 * 256 or 65536 sectors, not 0 sectors as in SCSI.
1185 * WARNING: one or two older ATA drives treat 0 as 0...
1189 if ((dev->flags & (ATA_DFLAG_PIO | ATA_DFLAG_NCQ)) == ATA_DFLAG_NCQ) {
1191 if (!lba_48_ok(block, n_block))
1194 tf->protocol = ATA_PROT_NCQ;
1195 tf->flags |= ATA_TFLAG_LBA | ATA_TFLAG_LBA48;
1197 if (tf->flags & ATA_TFLAG_WRITE)
1198 tf->command = ATA_CMD_FPDMA_WRITE;
1200 tf->command = ATA_CMD_FPDMA_READ;
1202 qc->nsect = n_block;
1204 tf->nsect = qc->tag << 3;
1205 tf->hob_feature = (n_block >> 8) & 0xff;
1206 tf->feature = n_block & 0xff;
1208 tf->hob_lbah = (block >> 40) & 0xff;
1209 tf->hob_lbam = (block >> 32) & 0xff;
1210 tf->hob_lbal = (block >> 24) & 0xff;
1211 tf->lbah = (block >> 16) & 0xff;
1212 tf->lbam = (block >> 8) & 0xff;
1213 tf->lbal = block & 0xff;
1215 tf->device = 1 << 6;
1216 if (tf->flags & ATA_TFLAG_FUA)
1217 tf->device |= 1 << 7;
1218 } else if (dev->flags & ATA_DFLAG_LBA) {
1219 tf->flags |= ATA_TFLAG_LBA;
1221 if (lba_28_ok(block, n_block)) {
1223 tf->device |= (block >> 24) & 0xf;
1224 } else if (lba_48_ok(block, n_block)) {
1225 if (!(dev->flags & ATA_DFLAG_LBA48))
1229 tf->flags |= ATA_TFLAG_LBA48;
1231 tf->hob_nsect = (n_block >> 8) & 0xff;
1233 tf->hob_lbah = (block >> 40) & 0xff;
1234 tf->hob_lbam = (block >> 32) & 0xff;
1235 tf->hob_lbal = (block >> 24) & 0xff;
1237 /* request too large even for LBA48 */
1240 if (unlikely(ata_rwcmd_protocol(qc) < 0))
1243 qc->nsect = n_block;
1244 tf->nsect = n_block & 0xff;
1246 tf->lbah = (block >> 16) & 0xff;
1247 tf->lbam = (block >> 8) & 0xff;
1248 tf->lbal = block & 0xff;
1250 tf->device |= ATA_LBA;
1253 u32 sect, head, cyl, track;
1255 /* The request -may- be too large for CHS addressing. */
1256 if (!lba_28_ok(block, n_block))
1259 if (unlikely(ata_rwcmd_protocol(qc) < 0))
1262 /* Convert LBA to CHS */
1263 track = (u32)block / dev->sectors;
1264 cyl = track / dev->heads;
1265 head = track % dev->heads;
1266 sect = (u32)block % dev->sectors + 1;
1268 DPRINTK("block %u track %u cyl %u head %u sect %u\n",
1269 (u32)block, track, cyl, head, sect);
1271 /* Check whether the converted CHS can fit.
1275 if ((cyl >> 16) || (head >> 4) || (sect >> 8) || (!sect))
1278 qc->nsect = n_block;
1279 tf->nsect = n_block & 0xff; /* Sector count 0 means 256 sectors */
1282 tf->lbah = cyl >> 8;
1289 ata_scsi_set_sense(qc->scsicmd, ILLEGAL_REQUEST, 0x24, 0x0);
1290 /* "Invalid field in cbd" */
1294 ata_scsi_set_sense(qc->scsicmd, ILLEGAL_REQUEST, 0x21, 0x0);
1295 /* "Logical Block Address out of range" */
1299 qc->scsicmd->result = SAM_STAT_GOOD;
1303 static void ata_scsi_qc_complete(struct ata_queued_cmd *qc)
1305 struct scsi_cmnd *cmd = qc->scsicmd;
1306 u8 *cdb = cmd->cmnd;
1307 int need_sense = (qc->err_mask != 0);
1309 /* For ATA pass thru (SAT) commands, generate a sense block if
1310 * user mandated it or if there's an error. Note that if we
1311 * generate because the user forced us to, a check condition
1312 * is generated and the ATA register values are returned
1313 * whether the command completed successfully or not. If there
1314 * was no error, SK, ASC and ASCQ will all be zero.
1316 if (((cdb[0] == ATA_16) || (cdb[0] == ATA_12)) &&
1317 ((cdb[2] & 0x20) || need_sense)) {
1318 ata_gen_ata_desc_sense(qc);
1321 cmd->result = SAM_STAT_GOOD;
1323 /* TODO: decide which descriptor format to use
1324 * for 48b LBA devices and call that here
1325 * instead of the fixed desc, which is only
1326 * good for smaller LBA (and maybe CHS?)
1329 ata_gen_fixed_sense(qc);
1333 if (need_sense && !qc->ap->ops->error_handler)
1334 ata_dump_status(qc->ap->id, &qc->result_tf);
1342 * ata_scmd_need_defer - Check whether we need to defer scmd
1343 * @dev: ATA device to which the command is addressed
1344 * @is_io: Is the command IO (and thus possibly NCQ)?
1346 * NCQ and non-NCQ commands cannot run together. As upper layer
1347 * only knows the queue depth, we are responsible for maintaining
1348 * exclusion. This function checks whether a new command can be
1352 * spin_lock_irqsave(host_set lock)
1355 * 1 if deferring is needed, 0 otherwise.
1357 static int ata_scmd_need_defer(struct ata_device *dev, int is_io)
1359 struct ata_port *ap = dev->ap;
1361 if (!(dev->flags & ATA_DFLAG_NCQ))
1365 if (!ata_tag_valid(ap->active_tag))
1368 if (!ata_tag_valid(ap->active_tag) && !ap->sactive)
1375 * ata_scsi_translate - Translate then issue SCSI command to ATA device
1376 * @dev: ATA device to which the command is addressed
1377 * @cmd: SCSI command to execute
1378 * @done: SCSI command completion function
1379 * @xlat_func: Actor which translates @cmd to an ATA taskfile
1381 * Our ->queuecommand() function has decided that the SCSI
1382 * command issued can be directly translated into an ATA
1383 * command, rather than handled internally.
1385 * This function sets up an ata_queued_cmd structure for the
1386 * SCSI command, and sends that ata_queued_cmd to the hardware.
1388 * The xlat_func argument (actor) returns 0 if ready to execute
1389 * ATA command, else 1 to finish translation. If 1 is returned
1390 * then cmd->result (and possibly cmd->sense_buffer) are assumed
1391 * to be set reflecting an error condition or clean (early)
1395 * spin_lock_irqsave(host_set lock)
1398 * 0 on success, SCSI_ML_QUEUE_DEVICE_BUSY if the command
1399 * needs to be deferred.
1401 static int ata_scsi_translate(struct ata_device *dev, struct scsi_cmnd *cmd,
1402 void (*done)(struct scsi_cmnd *),
1403 ata_xlat_func_t xlat_func)
1405 struct ata_queued_cmd *qc;
1406 u8 *scsicmd = cmd->cmnd;
1407 int is_io = xlat_func == ata_scsi_rw_xlat;
1411 if (unlikely(ata_scmd_need_defer(dev, is_io)))
1414 qc = ata_scsi_qc_new(dev, cmd, done);
1418 /* data is present; dma-map it */
1419 if (cmd->sc_data_direction == DMA_FROM_DEVICE ||
1420 cmd->sc_data_direction == DMA_TO_DEVICE) {
1421 if (unlikely(cmd->request_bufflen < 1)) {
1422 ata_dev_printk(dev, KERN_WARNING,
1423 "WARNING: zero len r/w req\n");
1428 ata_sg_init(qc, cmd->request_buffer, cmd->use_sg);
1430 ata_sg_init_one(qc, cmd->request_buffer,
1431 cmd->request_bufflen);
1433 qc->dma_dir = cmd->sc_data_direction;
1436 qc->complete_fn = ata_scsi_qc_complete;
1438 if (xlat_func(qc, scsicmd))
1441 /* select device, send command to hardware */
1450 DPRINTK("EXIT - early finish (good or error)\n");
1456 cmd->result = (DID_ERROR << 16);
1458 DPRINTK("EXIT - internal\n");
1462 DPRINTK("EXIT - defer\n");
1463 return SCSI_MLQUEUE_DEVICE_BUSY;
1467 * ata_scsi_rbuf_get - Map response buffer.
1468 * @cmd: SCSI command containing buffer to be mapped.
1469 * @buf_out: Pointer to mapped area.
1471 * Maps buffer contained within SCSI command @cmd.
1474 * spin_lock_irqsave(host_set lock)
1477 * Length of response buffer.
1480 static unsigned int ata_scsi_rbuf_get(struct scsi_cmnd *cmd, u8 **buf_out)
1483 unsigned int buflen;
1486 struct scatterlist *sg;
1488 sg = (struct scatterlist *) cmd->request_buffer;
1489 buf = kmap_atomic(sg->page, KM_USER0) + sg->offset;
1490 buflen = sg->length;
1492 buf = cmd->request_buffer;
1493 buflen = cmd->request_bufflen;
1501 * ata_scsi_rbuf_put - Unmap response buffer.
1502 * @cmd: SCSI command containing buffer to be unmapped.
1503 * @buf: buffer to unmap
1505 * Unmaps response buffer contained within @cmd.
1508 * spin_lock_irqsave(host_set lock)
1511 static inline void ata_scsi_rbuf_put(struct scsi_cmnd *cmd, u8 *buf)
1514 struct scatterlist *sg;
1516 sg = (struct scatterlist *) cmd->request_buffer;
1517 kunmap_atomic(buf - sg->offset, KM_USER0);
1522 * ata_scsi_rbuf_fill - wrapper for SCSI command simulators
1523 * @args: device IDENTIFY data / SCSI command of interest.
1524 * @actor: Callback hook for desired SCSI command simulator
1526 * Takes care of the hard work of simulating a SCSI command...
1527 * Mapping the response buffer, calling the command's handler,
1528 * and handling the handler's return value. This return value
1529 * indicates whether the handler wishes the SCSI command to be
1530 * completed successfully (0), or not (in which case cmd->result
1531 * and sense buffer are assumed to be set).
1534 * spin_lock_irqsave(host_set lock)
1537 void ata_scsi_rbuf_fill(struct ata_scsi_args *args,
1538 unsigned int (*actor) (struct ata_scsi_args *args,
1539 u8 *rbuf, unsigned int buflen))
1542 unsigned int buflen, rc;
1543 struct scsi_cmnd *cmd = args->cmd;
1545 buflen = ata_scsi_rbuf_get(cmd, &rbuf);
1546 memset(rbuf, 0, buflen);
1547 rc = actor(args, rbuf, buflen);
1548 ata_scsi_rbuf_put(cmd, rbuf);
1551 cmd->result = SAM_STAT_GOOD;
1556 * ata_scsiop_inq_std - Simulate INQUIRY command
1557 * @args: device IDENTIFY data / SCSI command of interest.
1558 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1559 * @buflen: Response buffer length.
1561 * Returns standard device identification data associated
1562 * with non-VPD INQUIRY command output.
1565 * spin_lock_irqsave(host_set lock)
1568 unsigned int ata_scsiop_inq_std(struct ata_scsi_args *args, u8 *rbuf,
1569 unsigned int buflen)
1574 0x5, /* claim SPC-3 version compatibility */
1579 /* set scsi removeable (RMB) bit per ata bit */
1580 if (ata_id_removeable(args->id))
1585 memcpy(rbuf, hdr, sizeof(hdr));
1588 memcpy(&rbuf[8], "ATA ", 8);
1589 ata_id_string(args->id, &rbuf[16], ATA_ID_PROD_OFS, 16);
1590 ata_id_string(args->id, &rbuf[32], ATA_ID_FW_REV_OFS, 4);
1591 if (rbuf[32] == 0 || rbuf[32] == ' ')
1592 memcpy(&rbuf[32], "n/a ", 4);
1596 const u8 versions[] = {
1597 0x60, /* SAM-3 (no version claimed) */
1600 0x20, /* SBC-2 (no version claimed) */
1603 0x60 /* SPC-3 (no version claimed) */
1606 memcpy(rbuf + 59, versions, sizeof(versions));
1613 * ata_scsiop_inq_00 - Simulate INQUIRY VPD page 0, list of pages
1614 * @args: device IDENTIFY data / SCSI command of interest.
1615 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1616 * @buflen: Response buffer length.
1618 * Returns list of inquiry VPD pages available.
1621 * spin_lock_irqsave(host_set lock)
1624 unsigned int ata_scsiop_inq_00(struct ata_scsi_args *args, u8 *rbuf,
1625 unsigned int buflen)
1627 const u8 pages[] = {
1628 0x00, /* page 0x00, this page */
1629 0x80, /* page 0x80, unit serial no page */
1630 0x83 /* page 0x83, device ident page */
1632 rbuf[3] = sizeof(pages); /* number of supported VPD pages */
1635 memcpy(rbuf + 4, pages, sizeof(pages));
1641 * ata_scsiop_inq_80 - Simulate INQUIRY VPD page 80, device serial number
1642 * @args: device IDENTIFY data / SCSI command of interest.
1643 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1644 * @buflen: Response buffer length.
1646 * Returns ATA device serial number.
1649 * spin_lock_irqsave(host_set lock)
1652 unsigned int ata_scsiop_inq_80(struct ata_scsi_args *args, u8 *rbuf,
1653 unsigned int buflen)
1657 0x80, /* this page code */
1659 ATA_SERNO_LEN, /* page len */
1661 memcpy(rbuf, hdr, sizeof(hdr));
1663 if (buflen > (ATA_SERNO_LEN + 4 - 1))
1664 ata_id_string(args->id, (unsigned char *) &rbuf[4],
1665 ATA_ID_SERNO_OFS, ATA_SERNO_LEN);
1671 * ata_scsiop_inq_83 - Simulate INQUIRY VPD page 83, device identity
1672 * @args: device IDENTIFY data / SCSI command of interest.
1673 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1674 * @buflen: Response buffer length.
1676 * Yields two logical unit device identification designators:
1677 * - vendor specific ASCII containing the ATA serial number
1678 * - SAT defined "t10 vendor id based" containing ASCII vendor
1679 * name ("ATA "), model and serial numbers.
1682 * spin_lock_irqsave(host_set lock)
1685 unsigned int ata_scsiop_inq_83(struct ata_scsi_args *args, u8 *rbuf,
1686 unsigned int buflen)
1689 const int sat_model_serial_desc_len = 68;
1690 const int ata_model_byte_len = 40;
1692 rbuf[1] = 0x83; /* this page code */
1695 if (buflen > (ATA_SERNO_LEN + num + 3)) {
1696 /* piv=0, assoc=lu, code_set=ACSII, designator=vendor */
1698 rbuf[num + 3] = ATA_SERNO_LEN;
1700 ata_id_string(args->id, (unsigned char *) rbuf + num,
1701 ATA_ID_SERNO_OFS, ATA_SERNO_LEN);
1702 num += ATA_SERNO_LEN;
1704 if (buflen > (sat_model_serial_desc_len + num + 3)) {
1705 /* SAT defined lu model and serial numbers descriptor */
1706 /* piv=0, assoc=lu, code_set=ACSII, designator=t10 vendor id */
1709 rbuf[num + 3] = sat_model_serial_desc_len;
1711 memcpy(rbuf + num, "ATA ", 8);
1713 ata_id_string(args->id, (unsigned char *) rbuf + num,
1714 ATA_ID_PROD_OFS, ata_model_byte_len);
1715 num += ata_model_byte_len;
1716 ata_id_string(args->id, (unsigned char *) rbuf + num,
1717 ATA_ID_SERNO_OFS, ATA_SERNO_LEN);
1718 num += ATA_SERNO_LEN;
1720 rbuf[3] = num - 4; /* page len (assume less than 256 bytes) */
1725 * ata_scsiop_noop - Command handler that simply returns success.
1726 * @args: device IDENTIFY data / SCSI command of interest.
1727 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1728 * @buflen: Response buffer length.
1730 * No operation. Simply returns success to caller, to indicate
1731 * that the caller should successfully complete this SCSI command.
1734 * spin_lock_irqsave(host_set lock)
1737 unsigned int ata_scsiop_noop(struct ata_scsi_args *args, u8 *rbuf,
1738 unsigned int buflen)
1745 * ata_msense_push - Push data onto MODE SENSE data output buffer
1746 * @ptr_io: (input/output) Location to store more output data
1747 * @last: End of output data buffer
1748 * @buf: Pointer to BLOB being added to output buffer
1749 * @buflen: Length of BLOB
1751 * Store MODE SENSE data on an output buffer.
1757 static void ata_msense_push(u8 **ptr_io, const u8 *last,
1758 const u8 *buf, unsigned int buflen)
1762 if ((ptr + buflen - 1) > last)
1765 memcpy(ptr, buf, buflen);
1773 * ata_msense_caching - Simulate MODE SENSE caching info page
1774 * @id: device IDENTIFY data
1775 * @ptr_io: (input/output) Location to store more output data
1776 * @last: End of output data buffer
1778 * Generate a caching info page, which conditionally indicates
1779 * write caching to the SCSI layer, depending on device
1786 static unsigned int ata_msense_caching(u16 *id, u8 **ptr_io,
1789 u8 page[CACHE_MPAGE_LEN];
1791 memcpy(page, def_cache_mpage, sizeof(page));
1792 if (ata_id_wcache_enabled(id))
1793 page[2] |= (1 << 2); /* write cache enable */
1794 if (!ata_id_rahead_enabled(id))
1795 page[12] |= (1 << 5); /* disable read ahead */
1797 ata_msense_push(ptr_io, last, page, sizeof(page));
1798 return sizeof(page);
1802 * ata_msense_ctl_mode - Simulate MODE SENSE control mode page
1803 * @dev: Device associated with this MODE SENSE command
1804 * @ptr_io: (input/output) Location to store more output data
1805 * @last: End of output data buffer
1807 * Generate a generic MODE SENSE control mode page.
1813 static unsigned int ata_msense_ctl_mode(u8 **ptr_io, const u8 *last)
1815 ata_msense_push(ptr_io, last, def_control_mpage,
1816 sizeof(def_control_mpage));
1817 return sizeof(def_control_mpage);
1821 * ata_msense_rw_recovery - Simulate MODE SENSE r/w error recovery page
1822 * @dev: Device associated with this MODE SENSE command
1823 * @ptr_io: (input/output) Location to store more output data
1824 * @last: End of output data buffer
1826 * Generate a generic MODE SENSE r/w error recovery page.
1832 static unsigned int ata_msense_rw_recovery(u8 **ptr_io, const u8 *last)
1835 ata_msense_push(ptr_io, last, def_rw_recovery_mpage,
1836 sizeof(def_rw_recovery_mpage));
1837 return sizeof(def_rw_recovery_mpage);
1841 * We can turn this into a real blacklist if it's needed, for now just
1842 * blacklist any Maxtor BANC1G10 revision firmware
1844 static int ata_dev_supports_fua(u16 *id)
1846 unsigned char model[41], fw[9];
1850 if (!ata_id_has_fua(id))
1853 ata_id_c_string(id, model, ATA_ID_PROD_OFS, sizeof(model));
1854 ata_id_c_string(id, fw, ATA_ID_FW_REV_OFS, sizeof(fw));
1856 if (strcmp(model, "Maxtor"))
1858 if (strcmp(fw, "BANC1G10"))
1861 return 0; /* blacklisted */
1865 * ata_scsiop_mode_sense - Simulate MODE SENSE 6, 10 commands
1866 * @args: device IDENTIFY data / SCSI command of interest.
1867 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1868 * @buflen: Response buffer length.
1870 * Simulate MODE SENSE commands. Assume this is invoked for direct
1871 * access devices (e.g. disks) only. There should be no block
1872 * descriptor for other device types.
1875 * spin_lock_irqsave(host_set lock)
1878 unsigned int ata_scsiop_mode_sense(struct ata_scsi_args *args, u8 *rbuf,
1879 unsigned int buflen)
1881 struct ata_device *dev = args->dev;
1882 u8 *scsicmd = args->cmd->cmnd, *p, *last;
1883 const u8 sat_blk_desc[] = {
1884 0, 0, 0, 0, /* number of blocks: sat unspecified */
1886 0, 0x2, 0x0 /* block length: 512 bytes */
1889 unsigned int ebd, page_control, six_byte, output_len, alloc_len, minlen;
1894 six_byte = (scsicmd[0] == MODE_SENSE);
1895 ebd = !(scsicmd[1] & 0x8); /* dbd bit inverted == edb */
1897 * LLBA bit in msense(10) ignored (compliant)
1900 page_control = scsicmd[2] >> 6;
1901 switch (page_control) {
1902 case 0: /* current */
1903 break; /* supported */
1905 goto saving_not_supp;
1906 case 1: /* changeable */
1907 case 2: /* defaults */
1913 output_len = 4 + (ebd ? 8 : 0);
1914 alloc_len = scsicmd[4];
1916 output_len = 8 + (ebd ? 8 : 0);
1917 alloc_len = (scsicmd[7] << 8) + scsicmd[8];
1919 minlen = (alloc_len < buflen) ? alloc_len : buflen;
1921 p = rbuf + output_len;
1922 last = rbuf + minlen - 1;
1924 pg = scsicmd[2] & 0x3f;
1927 * No mode subpages supported (yet) but asking for _all_
1928 * subpages may be valid
1930 if (spg && (spg != ALL_SUB_MPAGES))
1934 case RW_RECOVERY_MPAGE:
1935 output_len += ata_msense_rw_recovery(&p, last);
1939 output_len += ata_msense_caching(args->id, &p, last);
1942 case CONTROL_MPAGE: {
1943 output_len += ata_msense_ctl_mode(&p, last);
1948 output_len += ata_msense_rw_recovery(&p, last);
1949 output_len += ata_msense_caching(args->id, &p, last);
1950 output_len += ata_msense_ctl_mode(&p, last);
1953 default: /* invalid page code */
1961 if (ata_dev_supports_fua(args->id) && (dev->flags & ATA_DFLAG_LBA48) &&
1962 (!(dev->flags & ATA_DFLAG_PIO) || dev->multi_count))
1967 rbuf[0] = output_len;
1972 rbuf[3] = sizeof(sat_blk_desc);
1974 memcpy(rbuf + 4, sat_blk_desc,
1975 sizeof(sat_blk_desc));
1979 rbuf[0] = output_len >> 8;
1981 rbuf[1] = output_len;
1986 rbuf[7] = sizeof(sat_blk_desc);
1988 memcpy(rbuf + 8, sat_blk_desc,
1989 sizeof(sat_blk_desc));
1995 ata_scsi_set_sense(args->cmd, ILLEGAL_REQUEST, 0x24, 0x0);
1996 /* "Invalid field in cbd" */
2000 ata_scsi_set_sense(args->cmd, ILLEGAL_REQUEST, 0x39, 0x0);
2001 /* "Saving parameters not supported" */
2006 * ata_scsiop_read_cap - Simulate READ CAPACITY[ 16] commands
2007 * @args: device IDENTIFY data / SCSI command of interest.
2008 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2009 * @buflen: Response buffer length.
2011 * Simulate READ CAPACITY commands.
2014 * spin_lock_irqsave(host_set lock)
2017 unsigned int ata_scsiop_read_cap(struct ata_scsi_args *args, u8 *rbuf,
2018 unsigned int buflen)
2025 if (ata_id_has_lba(args->id)) {
2026 if (ata_id_has_lba48(args->id))
2027 n_sectors = ata_id_u64(args->id, 100);
2029 n_sectors = ata_id_u32(args->id, 60);
2031 /* CHS default translation */
2032 n_sectors = args->id[1] * args->id[3] * args->id[6];
2034 if (ata_id_current_chs_valid(args->id))
2035 /* CHS current translation */
2036 n_sectors = ata_id_u32(args->id, 57);
2039 n_sectors--; /* ATA TotalUserSectors - 1 */
2041 if (args->cmd->cmnd[0] == READ_CAPACITY) {
2042 if( n_sectors >= 0xffffffffULL )
2043 tmp = 0xffffffff ; /* Return max count on overflow */
2047 /* sector count, 32-bit */
2048 rbuf[0] = tmp >> (8 * 3);
2049 rbuf[1] = tmp >> (8 * 2);
2050 rbuf[2] = tmp >> (8 * 1);
2054 tmp = ATA_SECT_SIZE;
2059 /* sector count, 64-bit */
2060 tmp = n_sectors >> (8 * 4);
2061 rbuf[2] = tmp >> (8 * 3);
2062 rbuf[3] = tmp >> (8 * 2);
2063 rbuf[4] = tmp >> (8 * 1);
2066 rbuf[6] = tmp >> (8 * 3);
2067 rbuf[7] = tmp >> (8 * 2);
2068 rbuf[8] = tmp >> (8 * 1);
2072 tmp = ATA_SECT_SIZE;
2073 rbuf[12] = tmp >> 8;
2081 * ata_scsiop_report_luns - Simulate REPORT LUNS command
2082 * @args: device IDENTIFY data / SCSI command of interest.
2083 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2084 * @buflen: Response buffer length.
2086 * Simulate REPORT LUNS command.
2089 * spin_lock_irqsave(host_set lock)
2092 unsigned int ata_scsiop_report_luns(struct ata_scsi_args *args, u8 *rbuf,
2093 unsigned int buflen)
2096 rbuf[3] = 8; /* just one lun, LUN 0, size 8 bytes */
2102 * ata_scsi_set_sense - Set SCSI sense data and status
2103 * @cmd: SCSI request to be handled
2104 * @sk: SCSI-defined sense key
2105 * @asc: SCSI-defined additional sense code
2106 * @ascq: SCSI-defined additional sense code qualifier
2108 * Helper function that builds a valid fixed format, current
2109 * response code and the given sense key (sk), additional sense
2110 * code (asc) and additional sense code qualifier (ascq) with
2111 * a SCSI command status of %SAM_STAT_CHECK_CONDITION and
2112 * DRIVER_SENSE set in the upper bits of scsi_cmnd::result .
2118 void ata_scsi_set_sense(struct scsi_cmnd *cmd, u8 sk, u8 asc, u8 ascq)
2120 cmd->result = (DRIVER_SENSE << 24) | SAM_STAT_CHECK_CONDITION;
2122 cmd->sense_buffer[0] = 0x70; /* fixed format, current */
2123 cmd->sense_buffer[2] = sk;
2124 cmd->sense_buffer[7] = 18 - 8; /* additional sense length */
2125 cmd->sense_buffer[12] = asc;
2126 cmd->sense_buffer[13] = ascq;
2130 * ata_scsi_badcmd - End a SCSI request with an error
2131 * @cmd: SCSI request to be handled
2132 * @done: SCSI command completion function
2133 * @asc: SCSI-defined additional sense code
2134 * @ascq: SCSI-defined additional sense code qualifier
2136 * Helper function that completes a SCSI command with
2137 * %SAM_STAT_CHECK_CONDITION, with a sense key %ILLEGAL_REQUEST
2138 * and the specified additional sense codes.
2141 * spin_lock_irqsave(host_set lock)
2144 void ata_scsi_badcmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *), u8 asc, u8 ascq)
2147 ata_scsi_set_sense(cmd, ILLEGAL_REQUEST, asc, ascq);
2152 static void atapi_sense_complete(struct ata_queued_cmd *qc)
2154 if (qc->err_mask && ((qc->err_mask & AC_ERR_DEV) == 0)) {
2155 /* FIXME: not quite right; we don't want the
2156 * translation of taskfile registers into
2157 * a sense descriptors, since that's only
2158 * correct for ATA, not ATAPI
2160 ata_gen_ata_desc_sense(qc);
2163 qc->scsidone(qc->scsicmd);
2167 /* is it pointless to prefer PIO for "safety reasons"? */
2168 static inline int ata_pio_use_silly(struct ata_port *ap)
2170 return (ap->flags & ATA_FLAG_PIO_DMA);
2173 static void atapi_request_sense(struct ata_queued_cmd *qc)
2175 struct ata_port *ap = qc->ap;
2176 struct scsi_cmnd *cmd = qc->scsicmd;
2178 DPRINTK("ATAPI request sense\n");
2180 /* FIXME: is this needed? */
2181 memset(cmd->sense_buffer, 0, sizeof(cmd->sense_buffer));
2183 ap->ops->tf_read(ap, &qc->tf);
2185 /* fill these in, for the case where they are -not- overwritten */
2186 cmd->sense_buffer[0] = 0x70;
2187 cmd->sense_buffer[2] = qc->tf.feature >> 4;
2191 ata_sg_init_one(qc, cmd->sense_buffer, sizeof(cmd->sense_buffer));
2192 qc->dma_dir = DMA_FROM_DEVICE;
2194 memset(&qc->cdb, 0, qc->dev->cdb_len);
2195 qc->cdb[0] = REQUEST_SENSE;
2196 qc->cdb[4] = SCSI_SENSE_BUFFERSIZE;
2198 qc->tf.flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
2199 qc->tf.command = ATA_CMD_PACKET;
2201 if (ata_pio_use_silly(ap)) {
2202 qc->tf.protocol = ATA_PROT_ATAPI_DMA;
2203 qc->tf.feature |= ATAPI_PKT_DMA;
2205 qc->tf.protocol = ATA_PROT_ATAPI;
2206 qc->tf.lbam = (8 * 1024) & 0xff;
2207 qc->tf.lbah = (8 * 1024) >> 8;
2209 qc->nbytes = SCSI_SENSE_BUFFERSIZE;
2211 qc->complete_fn = atapi_sense_complete;
2218 static void atapi_qc_complete(struct ata_queued_cmd *qc)
2220 struct scsi_cmnd *cmd = qc->scsicmd;
2221 unsigned int err_mask = qc->err_mask;
2223 VPRINTK("ENTER, err_mask 0x%X\n", err_mask);
2225 /* handle completion from new EH */
2226 if (unlikely(qc->ap->ops->error_handler &&
2227 (err_mask || qc->flags & ATA_QCFLAG_SENSE_VALID))) {
2229 if (!(qc->flags & ATA_QCFLAG_SENSE_VALID)) {
2230 /* FIXME: not quite right; we don't want the
2231 * translation of taskfile registers into a
2232 * sense descriptors, since that's only
2233 * correct for ATA, not ATAPI
2235 ata_gen_ata_desc_sense(qc);
2238 qc->scsicmd->result = SAM_STAT_CHECK_CONDITION;
2244 /* successful completion or old EH failure path */
2245 if (unlikely(err_mask & AC_ERR_DEV)) {
2246 cmd->result = SAM_STAT_CHECK_CONDITION;
2247 atapi_request_sense(qc);
2249 } else if (unlikely(err_mask)) {
2250 /* FIXME: not quite right; we don't want the
2251 * translation of taskfile registers into
2252 * a sense descriptors, since that's only
2253 * correct for ATA, not ATAPI
2255 ata_gen_ata_desc_sense(qc);
2257 u8 *scsicmd = cmd->cmnd;
2259 if ((scsicmd[0] == INQUIRY) && ((scsicmd[1] & 0x03) == 0)) {
2261 unsigned int buflen;
2263 buflen = ata_scsi_rbuf_get(cmd, &buf);
2265 /* ATAPI devices typically report zero for their SCSI version,
2266 * and sometimes deviate from the spec WRT response data
2267 * format. If SCSI version is reported as zero like normal,
2268 * then we make the following fixups: 1) Fake MMC-5 version,
2269 * to indicate to the Linux scsi midlayer this is a modern
2270 * device. 2) Ensure response data format / ATAPI information
2271 * are always correct.
2278 ata_scsi_rbuf_put(cmd, buf);
2281 cmd->result = SAM_STAT_GOOD;
2288 * atapi_xlat - Initialize PACKET taskfile
2289 * @qc: command structure to be initialized
2290 * @scsicmd: SCSI CDB associated with this PACKET command
2293 * spin_lock_irqsave(host_set lock)
2296 * Zero on success, non-zero on failure.
2299 static unsigned int atapi_xlat(struct ata_queued_cmd *qc, const u8 *scsicmd)
2301 struct scsi_cmnd *cmd = qc->scsicmd;
2302 struct ata_device *dev = qc->dev;
2303 int using_pio = (dev->flags & ATA_DFLAG_PIO);
2304 int nodata = (cmd->sc_data_direction == DMA_NONE);
2307 /* Check whether ATAPI DMA is safe */
2308 if (ata_check_atapi_dma(qc))
2311 memcpy(&qc->cdb, scsicmd, dev->cdb_len);
2313 qc->complete_fn = atapi_qc_complete;
2315 qc->tf.flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
2316 if (cmd->sc_data_direction == DMA_TO_DEVICE) {
2317 qc->tf.flags |= ATA_TFLAG_WRITE;
2318 DPRINTK("direction: write\n");
2321 qc->tf.command = ATA_CMD_PACKET;
2323 /* no data, or PIO data xfer */
2324 if (using_pio || nodata) {
2326 qc->tf.protocol = ATA_PROT_ATAPI_NODATA;
2328 qc->tf.protocol = ATA_PROT_ATAPI;
2329 qc->tf.lbam = (8 * 1024) & 0xff;
2330 qc->tf.lbah = (8 * 1024) >> 8;
2335 qc->tf.protocol = ATA_PROT_ATAPI_DMA;
2336 qc->tf.feature |= ATAPI_PKT_DMA;
2338 if (atapi_dmadir && (cmd->sc_data_direction != DMA_TO_DEVICE))
2339 /* some SATA bridges need us to indicate data xfer direction */
2340 qc->tf.feature |= ATAPI_DMADIR;
2343 qc->nbytes = cmd->bufflen;
2348 static struct ata_device * ata_find_dev(struct ata_port *ap, int id)
2350 if (likely(id < ATA_MAX_DEVICES))
2351 return &ap->device[id];
2355 static struct ata_device * __ata_scsi_find_dev(struct ata_port *ap,
2356 const struct scsi_device *scsidev)
2358 /* skip commands not addressed to targets we simulate */
2359 if (unlikely(scsidev->channel || scsidev->lun))
2362 return ata_find_dev(ap, scsidev->id);
2366 * ata_scsi_find_dev - lookup ata_device from scsi_cmnd
2367 * @ap: ATA port to which the device is attached
2368 * @scsidev: SCSI device from which we derive the ATA device
2370 * Given various information provided in struct scsi_cmnd,
2371 * map that onto an ATA bus, and using that mapping
2372 * determine which ata_device is associated with the
2373 * SCSI command to be sent.
2376 * spin_lock_irqsave(host_set lock)
2379 * Associated ATA device, or %NULL if not found.
2381 static struct ata_device *
2382 ata_scsi_find_dev(struct ata_port *ap, const struct scsi_device *scsidev)
2384 struct ata_device *dev = __ata_scsi_find_dev(ap, scsidev);
2386 if (unlikely(!dev || !ata_dev_enabled(dev)))
2389 if (!atapi_enabled || (ap->flags & ATA_FLAG_NO_ATAPI)) {
2390 if (unlikely(dev->class == ATA_DEV_ATAPI)) {
2391 ata_dev_printk(dev, KERN_WARNING,
2392 "WARNING: ATAPI is %s, device ignored.\n",
2393 atapi_enabled ? "not supported with this driver" : "disabled");
2402 * ata_scsi_map_proto - Map pass-thru protocol value to taskfile value.
2403 * @byte1: Byte 1 from pass-thru CDB.
2406 * ATA_PROT_UNKNOWN if mapping failed/unimplemented, protocol otherwise.
2409 ata_scsi_map_proto(u8 byte1)
2411 switch((byte1 & 0x1e) >> 1) {
2412 case 3: /* Non-data */
2413 return ATA_PROT_NODATA;
2416 return ATA_PROT_DMA;
2418 case 4: /* PIO Data-in */
2419 case 5: /* PIO Data-out */
2420 return ATA_PROT_PIO;
2422 case 10: /* Device Reset */
2423 case 0: /* Hard Reset */
2425 case 2: /* Bus Idle */
2426 case 7: /* Packet */
2427 case 8: /* DMA Queued */
2428 case 9: /* Device Diagnostic */
2429 case 11: /* UDMA Data-in */
2430 case 12: /* UDMA Data-Out */
2431 case 13: /* FPDMA */
2432 default: /* Reserved */
2436 return ATA_PROT_UNKNOWN;
2440 * ata_scsi_pass_thru - convert ATA pass-thru CDB to taskfile
2441 * @qc: command structure to be initialized
2442 * @scsicmd: SCSI command to convert
2444 * Handles either 12 or 16-byte versions of the CDB.
2447 * Zero on success, non-zero on failure.
2450 ata_scsi_pass_thru(struct ata_queued_cmd *qc, const u8 *scsicmd)
2452 struct ata_taskfile *tf = &(qc->tf);
2453 struct scsi_cmnd *cmd = qc->scsicmd;
2454 struct ata_device *dev = qc->dev;
2456 if ((tf->protocol = ata_scsi_map_proto(scsicmd[1])) == ATA_PROT_UNKNOWN)
2459 /* We may not issue DMA commands if no DMA mode is set */
2460 if (tf->protocol == ATA_PROT_DMA && dev->dma_mode == 0)
2463 if (scsicmd[1] & 0xe0)
2464 /* PIO multi not supported yet */
2468 * 12 and 16 byte CDBs use different offsets to
2469 * provide the various register values.
2471 if (scsicmd[0] == ATA_16) {
2473 * 16-byte CDB - may contain extended commands.
2475 * If that is the case, copy the upper byte register values.
2477 if (scsicmd[1] & 0x01) {
2478 tf->hob_feature = scsicmd[3];
2479 tf->hob_nsect = scsicmd[5];
2480 tf->hob_lbal = scsicmd[7];
2481 tf->hob_lbam = scsicmd[9];
2482 tf->hob_lbah = scsicmd[11];
2483 tf->flags |= ATA_TFLAG_LBA48;
2485 tf->flags &= ~ATA_TFLAG_LBA48;
2488 * Always copy low byte, device and command registers.
2490 tf->feature = scsicmd[4];
2491 tf->nsect = scsicmd[6];
2492 tf->lbal = scsicmd[8];
2493 tf->lbam = scsicmd[10];
2494 tf->lbah = scsicmd[12];
2495 tf->device = scsicmd[13];
2496 tf->command = scsicmd[14];
2499 * 12-byte CDB - incapable of extended commands.
2501 tf->flags &= ~ATA_TFLAG_LBA48;
2503 tf->feature = scsicmd[3];
2504 tf->nsect = scsicmd[4];
2505 tf->lbal = scsicmd[5];
2506 tf->lbam = scsicmd[6];
2507 tf->lbah = scsicmd[7];
2508 tf->device = scsicmd[8];
2509 tf->command = scsicmd[9];
2512 * If slave is possible, enforce correct master/slave bit
2514 if (qc->ap->flags & ATA_FLAG_SLAVE_POSS)
2515 tf->device = qc->dev->devno ?
2516 tf->device | ATA_DEV1 : tf->device & ~ATA_DEV1;
2519 * Filter SET_FEATURES - XFER MODE command -- otherwise,
2520 * SET_FEATURES - XFER MODE must be preceded/succeeded
2521 * by an update to hardware-specific registers for each
2522 * controller (i.e. the reason for ->set_piomode(),
2523 * ->set_dmamode(), and ->post_set_mode() hooks).
2525 if ((tf->command == ATA_CMD_SET_FEATURES)
2526 && (tf->feature == SETFEATURES_XFER))
2530 * Set flags so that all registers will be written,
2531 * and pass on write indication (used for PIO/DMA
2534 tf->flags |= (ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE);
2536 if (cmd->sc_data_direction == DMA_TO_DEVICE)
2537 tf->flags |= ATA_TFLAG_WRITE;
2540 * Set transfer length.
2542 * TODO: find out if we need to do more here to
2543 * cover scatter/gather case.
2545 qc->nsect = cmd->bufflen / ATA_SECT_SIZE;
2547 /* request result TF */
2548 qc->flags |= ATA_QCFLAG_RESULT_TF;
2553 ata_scsi_set_sense(qc->scsicmd, ILLEGAL_REQUEST, 0x24, 0x00);
2554 /* "Invalid field in cdb" */
2559 * ata_get_xlat_func - check if SCSI to ATA translation is possible
2561 * @cmd: SCSI command opcode to consider
2563 * Look up the SCSI command given, and determine whether the
2564 * SCSI command is to be translated or simulated.
2567 * Pointer to translation function if possible, %NULL if not.
2570 static inline ata_xlat_func_t ata_get_xlat_func(struct ata_device *dev, u8 cmd)
2580 return ata_scsi_rw_xlat;
2582 case SYNCHRONIZE_CACHE:
2583 if (ata_try_flush_cache(dev))
2584 return ata_scsi_flush_xlat;
2589 return ata_scsi_verify_xlat;
2593 return ata_scsi_pass_thru;
2596 return ata_scsi_start_stop_xlat;
2603 * ata_scsi_dump_cdb - dump SCSI command contents to dmesg
2604 * @ap: ATA port to which the command was being sent
2605 * @cmd: SCSI command to dump
2607 * Prints the contents of a SCSI command via printk().
2610 static inline void ata_scsi_dump_cdb(struct ata_port *ap,
2611 struct scsi_cmnd *cmd)
2614 struct scsi_device *scsidev = cmd->device;
2615 u8 *scsicmd = cmd->cmnd;
2617 DPRINTK("CDB (%u:%d,%d,%d) %02x %02x %02x %02x %02x %02x %02x %02x %02x\n",
2619 scsidev->channel, scsidev->id, scsidev->lun,
2620 scsicmd[0], scsicmd[1], scsicmd[2], scsicmd[3],
2621 scsicmd[4], scsicmd[5], scsicmd[6], scsicmd[7],
2626 static inline int __ata_scsi_queuecmd(struct scsi_cmnd *cmd,
2627 void (*done)(struct scsi_cmnd *),
2628 struct ata_device *dev)
2632 if (dev->class == ATA_DEV_ATA) {
2633 ata_xlat_func_t xlat_func = ata_get_xlat_func(dev,
2637 rc = ata_scsi_translate(dev, cmd, done, xlat_func);
2639 ata_scsi_simulate(dev, cmd, done);
2641 rc = ata_scsi_translate(dev, cmd, done, atapi_xlat);
2647 * ata_scsi_queuecmd - Issue SCSI cdb to libata-managed device
2648 * @cmd: SCSI command to be sent
2649 * @done: Completion function, called when command is complete
2651 * In some cases, this function translates SCSI commands into
2652 * ATA taskfiles, and queues the taskfiles to be sent to
2653 * hardware. In other cases, this function simulates a
2654 * SCSI device by evaluating and responding to certain
2655 * SCSI commands. This creates the overall effect of
2656 * ATA and ATAPI devices appearing as SCSI devices.
2659 * Releases scsi-layer-held lock, and obtains host_set lock.
2662 * Return value from __ata_scsi_queuecmd() if @cmd can be queued,
2665 int ata_scsi_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *))
2667 struct ata_port *ap;
2668 struct ata_device *dev;
2669 struct scsi_device *scsidev = cmd->device;
2670 struct Scsi_Host *shost = scsidev->host;
2673 ap = ata_shost_to_port(shost);
2675 spin_unlock(shost->host_lock);
2676 spin_lock(&ap->host_set->lock);
2678 ata_scsi_dump_cdb(ap, cmd);
2680 dev = ata_scsi_find_dev(ap, scsidev);
2682 rc = __ata_scsi_queuecmd(cmd, done, dev);
2684 cmd->result = (DID_BAD_TARGET << 16);
2688 spin_unlock(&ap->host_set->lock);
2689 spin_lock(shost->host_lock);
2694 * ata_scsi_simulate - simulate SCSI command on ATA device
2695 * @dev: the target device
2696 * @cmd: SCSI command being sent to device.
2697 * @done: SCSI command completion function.
2699 * Interprets and directly executes a select list of SCSI commands
2700 * that can be handled internally.
2703 * spin_lock_irqsave(host_set lock)
2706 void ata_scsi_simulate(struct ata_device *dev, struct scsi_cmnd *cmd,
2707 void (*done)(struct scsi_cmnd *))
2709 struct ata_scsi_args args;
2710 const u8 *scsicmd = cmd->cmnd;
2717 switch(scsicmd[0]) {
2718 /* no-op's, complete with success */
2719 case SYNCHRONIZE_CACHE:
2723 case TEST_UNIT_READY:
2724 case FORMAT_UNIT: /* FIXME: correct? */
2725 case SEND_DIAGNOSTIC: /* FIXME: correct? */
2726 ata_scsi_rbuf_fill(&args, ata_scsiop_noop);
2730 if (scsicmd[1] & 2) /* is CmdDt set? */
2731 ata_scsi_invalid_field(cmd, done);
2732 else if ((scsicmd[1] & 1) == 0) /* is EVPD clear? */
2733 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_std);
2734 else if (scsicmd[2] == 0x00)
2735 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_00);
2736 else if (scsicmd[2] == 0x80)
2737 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_80);
2738 else if (scsicmd[2] == 0x83)
2739 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_83);
2741 ata_scsi_invalid_field(cmd, done);
2746 ata_scsi_rbuf_fill(&args, ata_scsiop_mode_sense);
2749 case MODE_SELECT: /* unconditionally return */
2750 case MODE_SELECT_10: /* bad-field-in-cdb */
2751 ata_scsi_invalid_field(cmd, done);
2755 ata_scsi_rbuf_fill(&args, ata_scsiop_read_cap);
2758 case SERVICE_ACTION_IN:
2759 if ((scsicmd[1] & 0x1f) == SAI_READ_CAPACITY_16)
2760 ata_scsi_rbuf_fill(&args, ata_scsiop_read_cap);
2762 ata_scsi_invalid_field(cmd, done);
2766 ata_scsi_rbuf_fill(&args, ata_scsiop_report_luns);
2769 /* mandatory commands we haven't implemented yet */
2772 /* all other commands */
2774 ata_scsi_set_sense(cmd, ILLEGAL_REQUEST, 0x20, 0x0);
2775 /* "Invalid command operation code" */
2781 void ata_scsi_scan_host(struct ata_port *ap)
2785 if (ap->flags & ATA_FLAG_DISABLED)
2788 for (i = 0; i < ATA_MAX_DEVICES; i++) {
2789 struct ata_device *dev = &ap->device[i];
2790 struct scsi_device *sdev;
2792 if (!ata_dev_enabled(dev) || dev->sdev)
2795 sdev = __scsi_add_device(ap->host, 0, i, 0, NULL);
2796 if (!IS_ERR(sdev)) {
2798 scsi_device_put(sdev);
2804 * ata_scsi_offline_dev - offline attached SCSI device
2805 * @dev: ATA device to offline attached SCSI device for
2807 * This function is called from ata_eh_hotplug() and responsible
2808 * for taking the SCSI device attached to @dev offline. This
2809 * function is called with host_set lock which protects dev->sdev
2813 * spin_lock_irqsave(host_set lock)
2816 * 1 if attached SCSI device exists, 0 otherwise.
2818 int ata_scsi_offline_dev(struct ata_device *dev)
2821 scsi_device_set_state(dev->sdev, SDEV_OFFLINE);
2828 * ata_scsi_remove_dev - remove attached SCSI device
2829 * @dev: ATA device to remove attached SCSI device for
2831 * This function is called from ata_eh_scsi_hotplug() and
2832 * responsible for removing the SCSI device attached to @dev.
2835 * Kernel thread context (may sleep).
2837 static void ata_scsi_remove_dev(struct ata_device *dev)
2839 struct ata_port *ap = dev->ap;
2840 struct scsi_device *sdev;
2841 unsigned long flags;
2843 /* Alas, we need to grab scan_mutex to ensure SCSI device
2844 * state doesn't change underneath us and thus
2845 * scsi_device_get() always succeeds. The mutex locking can
2846 * be removed if there is __scsi_device_get() interface which
2847 * increments reference counts regardless of device state.
2849 mutex_lock(&ap->host->scan_mutex);
2850 spin_lock_irqsave(&ap->host_set->lock, flags);
2852 /* clearing dev->sdev is protected by host_set lock */
2857 /* If user initiated unplug races with us, sdev can go
2858 * away underneath us after the host_set lock and
2859 * scan_mutex are released. Hold onto it.
2861 if (scsi_device_get(sdev) == 0) {
2862 /* The following ensures the attached sdev is
2863 * offline on return from ata_scsi_offline_dev()
2864 * regardless it wins or loses the race
2865 * against this function.
2867 scsi_device_set_state(sdev, SDEV_OFFLINE);
2874 spin_unlock_irqrestore(&ap->host_set->lock, flags);
2875 mutex_unlock(&ap->host->scan_mutex);
2878 ata_dev_printk(dev, KERN_INFO, "detaching (SCSI %s)\n",
2879 sdev->sdev_gendev.bus_id);
2881 scsi_remove_device(sdev);
2882 scsi_device_put(sdev);
2887 * ata_scsi_hotplug - SCSI part of hotplug
2888 * @data: Pointer to ATA port to perform SCSI hotplug on
2890 * Perform SCSI part of hotplug. It's executed from a separate
2891 * workqueue after EH completes. This is necessary because SCSI
2892 * hot plugging requires working EH and hot unplugging is
2893 * synchronized with hot plugging with a mutex.
2896 * Kernel thread context (may sleep).
2898 void ata_scsi_hotplug(void *data)
2900 struct ata_port *ap = data;
2903 if (ap->flags & ATA_FLAG_UNLOADING) {
2904 DPRINTK("ENTER/EXIT - unloading\n");
2910 /* unplug detached devices */
2911 for (i = 0; i < ATA_MAX_DEVICES; i++) {
2912 struct ata_device *dev = &ap->device[i];
2913 unsigned long flags;
2915 if (!(dev->flags & ATA_DFLAG_DETACHED))
2918 spin_lock_irqsave(&ap->host_set->lock, flags);
2919 dev->flags &= ~ATA_DFLAG_DETACHED;
2920 spin_unlock_irqrestore(&ap->host_set->lock, flags);
2922 ata_scsi_remove_dev(dev);
2925 /* scan for new ones */
2926 ata_scsi_scan_host(ap);
2928 /* If we scanned while EH was in progress, scan would have
2929 * failed silently. Requeue if there are enabled but
2930 * unattached devices.
2932 for (i = 0; i < ATA_MAX_DEVICES; i++) {
2933 struct ata_device *dev = &ap->device[i];
2934 if (ata_dev_enabled(dev) && !dev->sdev) {
2935 queue_delayed_work(ata_aux_wq, &ap->hotplug_task, HZ);
2944 * ata_scsi_user_scan - indication for user-initiated bus scan
2945 * @shost: SCSI host to scan
2946 * @channel: Channel to scan
2950 * This function is called when user explicitly requests bus
2951 * scan. Set probe pending flag and invoke EH.
2954 * SCSI layer (we don't care)
2959 static int ata_scsi_user_scan(struct Scsi_Host *shost, unsigned int channel,
2960 unsigned int id, unsigned int lun)
2962 struct ata_port *ap = ata_shost_to_port(shost);
2963 unsigned long flags;
2966 if (!ap->ops->error_handler)
2969 if ((channel != SCAN_WILD_CARD && channel != 0) ||
2970 (lun != SCAN_WILD_CARD && lun != 0))
2973 spin_lock_irqsave(&ap->host_set->lock, flags);
2975 if (id == SCAN_WILD_CARD) {
2976 ap->eh_info.probe_mask |= (1 << ATA_MAX_DEVICES) - 1;
2977 ap->eh_info.action |= ATA_EH_SOFTRESET;
2979 struct ata_device *dev = ata_find_dev(ap, id);
2982 ap->eh_info.probe_mask |= 1 << dev->devno;
2983 ap->eh_info.action |= ATA_EH_SOFTRESET;
2989 ata_port_schedule_eh(ap);
2991 spin_unlock_irqrestore(&ap->host_set->lock, flags);