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 <linux/libata.h>
45 #include <linux/hdreg.h>
46 #include <asm/uaccess.h>
50 #define SECTOR_SIZE 512
52 typedef unsigned int (*ata_xlat_func_t)(struct ata_queued_cmd *qc, const u8 *scsicmd);
53 static struct ata_device *
54 ata_scsi_find_dev(struct ata_port *ap, const struct scsi_device *scsidev);
56 #define RW_RECOVERY_MPAGE 0x1
57 #define RW_RECOVERY_MPAGE_LEN 12
58 #define CACHE_MPAGE 0x8
59 #define CACHE_MPAGE_LEN 20
60 #define CONTROL_MPAGE 0xa
61 #define CONTROL_MPAGE_LEN 12
62 #define ALL_MPAGES 0x3f
63 #define ALL_SUB_MPAGES 0xff
66 static const u8 def_rw_recovery_mpage[] = {
68 RW_RECOVERY_MPAGE_LEN - 2,
69 (1 << 7) | /* AWRE, sat-r06 say it shall be 0 */
70 (1 << 6), /* ARRE (auto read reallocation) */
71 0, /* read retry count */
73 0, /* write retry count */
77 static const u8 def_cache_mpage[CACHE_MPAGE_LEN] = {
80 0, /* contains WCE, needs to be 0 for logic */
81 0, 0, 0, 0, 0, 0, 0, 0, 0,
82 0, /* contains DRA, needs to be 0 for logic */
86 static const u8 def_control_mpage[CONTROL_MPAGE_LEN] = {
88 CONTROL_MPAGE_LEN - 2,
89 2, /* DSENSE=0, GLTSD=1 */
90 0, /* [QAM+QERR may be 1, see 05-359r1] */
91 0, 0, 0, 0, 0xff, 0xff,
92 0, 30 /* extended self test time, see 05-359r1 */
96 static void ata_scsi_invalid_field(struct scsi_cmnd *cmd,
97 void (*done)(struct scsi_cmnd *))
99 ata_scsi_set_sense(cmd, ILLEGAL_REQUEST, 0x24, 0x0);
100 /* "Invalid field in cbd" */
105 * ata_std_bios_param - generic bios head/sector/cylinder calculator used by sd.
106 * @sdev: SCSI device for which BIOS geometry is to be determined
107 * @bdev: block device associated with @sdev
108 * @capacity: capacity of SCSI device
109 * @geom: location to which geometry will be output
111 * Generic bios head/sector/cylinder calculator
112 * used by sd. Most BIOSes nowadays expect a XXX/255/16 (CHS)
113 * mapping. Some situations may arise where the disk is not
114 * bootable if this is not used.
117 * Defined by the SCSI layer. We don't really care.
122 int ata_std_bios_param(struct scsi_device *sdev, struct block_device *bdev,
123 sector_t capacity, int geom[])
127 sector_div(capacity, 255*63);
134 * ata_cmd_ioctl - Handler for HDIO_DRIVE_CMD ioctl
135 * @scsidev: Device to which we are issuing command
136 * @arg: User provided data for issuing command
139 * Defined by the SCSI layer. We don't really care.
142 * Zero on success, negative errno on error.
145 int ata_cmd_ioctl(struct scsi_device *scsidev, void __user *arg)
148 u8 scsi_cmd[MAX_COMMAND_SIZE];
149 u8 args[4], *argbuf = NULL;
151 struct scsi_sense_hdr sshdr;
152 enum dma_data_direction data_dir;
157 if (copy_from_user(args, arg, sizeof(args)))
160 memset(scsi_cmd, 0, sizeof(scsi_cmd));
163 argsize = SECTOR_SIZE * args[3];
164 argbuf = kmalloc(argsize, GFP_KERNEL);
165 if (argbuf == NULL) {
170 scsi_cmd[1] = (4 << 1); /* PIO Data-in */
171 scsi_cmd[2] = 0x0e; /* no off.line or cc, read from dev,
172 block count in sector count field */
173 data_dir = DMA_FROM_DEVICE;
175 scsi_cmd[1] = (3 << 1); /* Non-data */
176 /* scsi_cmd[2] is already 0 -- no off.line, cc, or data xfer */
180 scsi_cmd[0] = ATA_16;
182 scsi_cmd[4] = args[2];
183 if (args[0] == WIN_SMART) { /* hack -- ide driver does this too... */
184 scsi_cmd[6] = args[3];
185 scsi_cmd[8] = args[1];
189 scsi_cmd[6] = args[1];
191 scsi_cmd[14] = args[0];
193 /* Good values for timeout and retries? Values below
194 from scsi_ioctl_send_command() for default case... */
195 if (scsi_execute_req(scsidev, scsi_cmd, data_dir, argbuf, argsize,
196 &sshdr, (10*HZ), 5)) {
201 /* Need code to retrieve data from check condition? */
204 && copy_to_user(arg + sizeof(args), argbuf, argsize))
214 * ata_task_ioctl - Handler for HDIO_DRIVE_TASK ioctl
215 * @scsidev: Device to which we are issuing command
216 * @arg: User provided data for issuing command
219 * Defined by the SCSI layer. We don't really care.
222 * Zero on success, negative errno on error.
224 int ata_task_ioctl(struct scsi_device *scsidev, void __user *arg)
227 u8 scsi_cmd[MAX_COMMAND_SIZE];
229 struct scsi_sense_hdr sshdr;
234 if (copy_from_user(args, arg, sizeof(args)))
237 memset(scsi_cmd, 0, sizeof(scsi_cmd));
238 scsi_cmd[0] = ATA_16;
239 scsi_cmd[1] = (3 << 1); /* Non-data */
240 /* scsi_cmd[2] is already 0 -- no off.line, cc, or data xfer */
241 scsi_cmd[4] = args[1];
242 scsi_cmd[6] = args[2];
243 scsi_cmd[8] = args[3];
244 scsi_cmd[10] = args[4];
245 scsi_cmd[12] = args[5];
246 scsi_cmd[14] = args[0];
248 /* Good values for timeout and retries? Values below
249 from scsi_ioctl_send_command() for default case... */
250 if (scsi_execute_req(scsidev, scsi_cmd, DMA_NONE, NULL, 0, &sshdr,
254 /* Need code to retrieve data from check condition? */
258 int ata_scsi_ioctl(struct scsi_device *scsidev, int cmd, void __user *arg)
261 struct ata_device *dev;
262 int val = -EINVAL, rc = -EINVAL;
264 ap = (struct ata_port *) &scsidev->host->hostdata[0];
268 dev = ata_scsi_find_dev(ap, scsidev);
275 case ATA_IOC_GET_IO32:
277 if (copy_to_user(arg, &val, 1))
281 case ATA_IOC_SET_IO32:
282 val = (unsigned long) arg;
288 if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
290 return ata_cmd_ioctl(scsidev, arg);
292 case HDIO_DRIVE_TASK:
293 if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
295 return ata_task_ioctl(scsidev, arg);
307 * ata_scsi_qc_new - acquire new ata_queued_cmd reference
308 * @ap: ATA port to which the new command is attached
309 * @dev: ATA device to which the new command is attached
310 * @cmd: SCSI command that originated this ATA command
311 * @done: SCSI command completion function
313 * Obtain a reference to an unused ata_queued_cmd structure,
314 * which is the basic libata structure representing a single
315 * ATA command sent to the hardware.
317 * If a command was available, fill in the SCSI-specific
318 * portions of the structure with information on the
322 * spin_lock_irqsave(host_set lock)
325 * Command allocated, or %NULL if none available.
327 struct ata_queued_cmd *ata_scsi_qc_new(struct ata_port *ap,
328 struct ata_device *dev,
329 struct scsi_cmnd *cmd,
330 void (*done)(struct scsi_cmnd *))
332 struct ata_queued_cmd *qc;
334 qc = ata_qc_new_init(ap, dev);
340 qc->__sg = (struct scatterlist *) cmd->request_buffer;
341 qc->n_elem = cmd->use_sg;
343 qc->__sg = &qc->sgent;
347 cmd->result = (DID_OK << 16) | (QUEUE_FULL << 1);
355 * ata_dump_status - user friendly display of error info
356 * @id: id of the port in question
357 * @tf: ptr to filled out taskfile
359 * Decode and dump the ATA error/status registers for the user so
360 * that they have some idea what really happened at the non
361 * make-believe layer.
364 * inherited from caller
366 void ata_dump_status(unsigned id, struct ata_taskfile *tf)
368 u8 stat = tf->command, err = tf->feature;
370 printk(KERN_WARNING "ata%u: status=0x%02x { ", id, stat);
371 if (stat & ATA_BUSY) {
372 printk("Busy }\n"); /* Data is not valid in this case */
374 if (stat & 0x40) printk("DriveReady ");
375 if (stat & 0x20) printk("DeviceFault ");
376 if (stat & 0x10) printk("SeekComplete ");
377 if (stat & 0x08) printk("DataRequest ");
378 if (stat & 0x04) printk("CorrectedError ");
379 if (stat & 0x02) printk("Index ");
380 if (stat & 0x01) printk("Error ");
384 printk(KERN_WARNING "ata%u: error=0x%02x { ", id, err);
385 if (err & 0x04) printk("DriveStatusError ");
387 if (err & 0x04) printk("BadCRC ");
388 else printk("Sector ");
390 if (err & 0x40) printk("UncorrectableError ");
391 if (err & 0x10) printk("SectorIdNotFound ");
392 if (err & 0x02) printk("TrackZeroNotFound ");
393 if (err & 0x01) printk("AddrMarkNotFound ");
399 int ata_scsi_device_resume(struct scsi_device *sdev)
401 struct ata_port *ap = (struct ata_port *) &sdev->host->hostdata[0];
402 struct ata_device *dev = &ap->device[sdev->id];
404 return ata_device_resume(ap, dev);
407 int ata_scsi_device_suspend(struct scsi_device *sdev)
409 struct ata_port *ap = (struct ata_port *) &sdev->host->hostdata[0];
410 struct ata_device *dev = &ap->device[sdev->id];
412 return ata_device_suspend(ap, dev);
416 * ata_to_sense_error - convert ATA error to SCSI error
417 * @id: ATA device number
418 * @drv_stat: value contained in ATA status register
419 * @drv_err: value contained in ATA error register
420 * @sk: the sense key we'll fill out
421 * @asc: the additional sense code we'll fill out
422 * @ascq: the additional sense code qualifier we'll fill out
424 * Converts an ATA error into a SCSI error. Fill out pointers to
425 * SK, ASC, and ASCQ bytes for later use in fixed or descriptor
426 * format sense blocks.
429 * spin_lock_irqsave(host_set lock)
431 void ata_to_sense_error(unsigned id, u8 drv_stat, u8 drv_err, u8 *sk, u8 *asc,
436 /* Based on the 3ware driver translation table */
437 static const unsigned char sense_table[][4] = {
439 {0xd1, ABORTED_COMMAND, 0x00, 0x00}, // Device busy Aborted command
441 {0xd0, ABORTED_COMMAND, 0x00, 0x00}, // Device busy Aborted command
443 {0x61, HARDWARE_ERROR, 0x00, 0x00}, // Device fault Hardware error
444 /* ICRC|ABRT */ /* NB: ICRC & !ABRT is BBD */
445 {0x84, ABORTED_COMMAND, 0x47, 0x00}, // Data CRC error SCSI parity error
446 /* MC|ID|ABRT|TRK0|MARK */
447 {0x37, NOT_READY, 0x04, 0x00}, // Unit offline Not ready
449 {0x09, NOT_READY, 0x04, 0x00}, // Unrecovered disk error Not ready
450 /* Bad address mark */
451 {0x01, MEDIUM_ERROR, 0x13, 0x00}, // Address mark not found Address mark not found for data field
453 {0x02, HARDWARE_ERROR, 0x00, 0x00}, // Track 0 not found Hardware error
455 {0x04, ABORTED_COMMAND, 0x00, 0x00}, // Aborted command Aborted command
456 /* Media change request */
457 {0x08, NOT_READY, 0x04, 0x00}, // Media change request FIXME: faking offline
459 {0x10, ABORTED_COMMAND, 0x14, 0x00}, // ID not found Recorded entity not found
461 {0x08, NOT_READY, 0x04, 0x00}, // Media change FIXME: faking offline
463 {0x40, MEDIUM_ERROR, 0x11, 0x04}, // Uncorrectable ECC error Unrecovered read error
464 /* BBD - block marked bad */
465 {0x80, MEDIUM_ERROR, 0x11, 0x04}, // Block marked bad Medium error, unrecovered read error
466 {0xFF, 0xFF, 0xFF, 0xFF}, // END mark
468 static const unsigned char stat_table[][4] = {
469 /* Must be first because BUSY means no other bits valid */
470 {0x80, ABORTED_COMMAND, 0x47, 0x00}, // Busy, fake parity for now
471 {0x20, HARDWARE_ERROR, 0x00, 0x00}, // Device fault
472 {0x08, ABORTED_COMMAND, 0x47, 0x00}, // Timed out in xfer, fake parity for now
473 {0x04, RECOVERED_ERROR, 0x11, 0x00}, // Recovered ECC error Medium error, recovered
474 {0xFF, 0xFF, 0xFF, 0xFF}, // END mark
478 * Is this an error we can process/parse
480 if (drv_stat & ATA_BUSY) {
481 drv_err = 0; /* Ignore the err bits, they're invalid */
485 /* Look for drv_err */
486 for (i = 0; sense_table[i][0] != 0xFF; i++) {
487 /* Look for best matches first */
488 if ((sense_table[i][0] & drv_err) ==
490 *sk = sense_table[i][1];
491 *asc = sense_table[i][2];
492 *ascq = sense_table[i][3];
496 /* No immediate match */
497 printk(KERN_WARNING "ata%u: no sense translation for "
498 "error 0x%02x\n", id, drv_err);
501 /* Fall back to interpreting status bits */
502 for (i = 0; stat_table[i][0] != 0xFF; i++) {
503 if (stat_table[i][0] & drv_stat) {
504 *sk = stat_table[i][1];
505 *asc = stat_table[i][2];
506 *ascq = stat_table[i][3];
510 /* No error? Undecoded? */
511 printk(KERN_WARNING "ata%u: no sense translation for status: 0x%02x\n",
514 /* For our last chance pick, use medium read error because
515 * it's much more common than an ATA drive telling you a write
519 *asc = 0x11; /* "unrecovered read error" */
520 *ascq = 0x04; /* "auto-reallocation failed" */
523 printk(KERN_ERR "ata%u: translated ATA stat/err 0x%02x/%02x to "
524 "SCSI SK/ASC/ASCQ 0x%x/%02x/%02x\n", id, drv_stat, drv_err,
530 * ata_gen_ata_desc_sense - Generate check condition sense block.
531 * @qc: Command that completed.
533 * This function is specific to the ATA descriptor format sense
534 * block specified for the ATA pass through commands. Regardless
535 * of whether the command errored or not, return a sense
536 * block. Copy all controller registers into the sense
537 * block. Clear sense key, ASC & ASCQ if there is no error.
540 * spin_lock_irqsave(host_set lock)
542 void ata_gen_ata_desc_sense(struct ata_queued_cmd *qc)
544 struct scsi_cmnd *cmd = qc->scsicmd;
545 struct ata_taskfile *tf = &qc->tf;
546 unsigned char *sb = cmd->sense_buffer;
547 unsigned char *desc = sb + 8;
549 memset(sb, 0, SCSI_SENSE_BUFFERSIZE);
551 cmd->result = (DRIVER_SENSE << 24) | SAM_STAT_CHECK_CONDITION;
554 * Read the controller registers.
556 WARN_ON(qc->ap->ops->tf_read == NULL);
557 qc->ap->ops->tf_read(qc->ap, tf);
560 * Use ata_to_sense_error() to map status register bits
561 * onto sense key, asc & ascq.
563 if (tf->command & (ATA_BUSY | ATA_DF | ATA_ERR | ATA_DRQ)) {
564 ata_to_sense_error(qc->ap->id, tf->command, tf->feature,
565 &sb[1], &sb[2], &sb[3]);
570 * Sense data is current and format is descriptor.
577 * Set length of additional sense data.
578 * Since we only populate descriptor 0, the total
579 * length is the same (fixed) length as descriptor 0.
581 desc[1] = sb[7] = 14;
584 * Copy registers into sense buffer.
587 desc[3] = tf->feature; /* == error reg */
592 desc[12] = tf->device;
593 desc[13] = tf->command; /* == status reg */
596 * Fill in Extend bit, and the high order bytes
599 if (tf->flags & ATA_TFLAG_LBA48) {
601 desc[4] = tf->hob_nsect;
602 desc[6] = tf->hob_lbal;
603 desc[8] = tf->hob_lbam;
604 desc[10] = tf->hob_lbah;
609 * ata_gen_fixed_sense - generate a SCSI fixed sense block
610 * @qc: Command that we are erroring out
612 * Leverage ata_to_sense_error() to give us the codes. Fit our
613 * LBA in here if there's room.
616 * inherited from caller
618 void ata_gen_fixed_sense(struct ata_queued_cmd *qc)
620 struct scsi_cmnd *cmd = qc->scsicmd;
621 struct ata_taskfile *tf = &qc->tf;
622 unsigned char *sb = cmd->sense_buffer;
624 memset(sb, 0, SCSI_SENSE_BUFFERSIZE);
626 cmd->result = (DRIVER_SENSE << 24) | SAM_STAT_CHECK_CONDITION;
629 * Read the controller registers.
631 WARN_ON(qc->ap->ops->tf_read == NULL);
632 qc->ap->ops->tf_read(qc->ap, tf);
635 * Use ata_to_sense_error() to map status register bits
636 * onto sense key, asc & ascq.
638 if (tf->command & (ATA_BUSY | ATA_DF | ATA_ERR | ATA_DRQ)) {
639 ata_to_sense_error(qc->ap->id, tf->command, tf->feature,
640 &sb[2], &sb[12], &sb[13]);
647 if (tf->flags & ATA_TFLAG_LBA48) {
648 /* TODO: find solution for LBA48 descriptors */
651 else if (tf->flags & ATA_TFLAG_LBA) {
652 /* A small (28b) LBA will fit in the 32b info field */
653 sb[0] |= 0x80; /* set valid bit */
654 sb[3] = tf->device & 0x0f;
666 * ata_scsi_slave_config - Set SCSI device attributes
667 * @sdev: SCSI device to examine
669 * This is called before we actually start reading
670 * and writing to the device, to configure certain
671 * SCSI mid-layer behaviors.
674 * Defined by SCSI layer. We don't really care.
677 int ata_scsi_slave_config(struct scsi_device *sdev)
679 sdev->use_10_for_rw = 1;
680 sdev->use_10_for_ms = 1;
682 blk_queue_max_phys_segments(sdev->request_queue, LIBATA_MAX_PRD);
684 if (sdev->id < ATA_MAX_DEVICES) {
686 struct ata_device *dev;
687 unsigned int max_sectors;
689 ap = (struct ata_port *) &sdev->host->hostdata[0];
690 dev = &ap->device[sdev->id];
692 /* TODO: 2048 is an arbitrary number, not the
693 * hardware maximum. This should be increased to
694 * 65534 when Jens Axboe's patch for dynamically
695 * determining max_sectors is merged.
697 max_sectors = ATA_MAX_SECTORS;
698 if (dev->flags & ATA_DFLAG_LBA48)
700 if (dev->max_sectors)
701 max_sectors = dev->max_sectors;
703 blk_queue_max_sectors(sdev->request_queue, max_sectors);
706 * SATA DMA transfers must be multiples of 4 byte, so
707 * we need to pad ATAPI transfers using an extra sg.
708 * Decrement max hw segments accordingly.
710 if (dev->class == ATA_DEV_ATAPI) {
711 request_queue_t *q = sdev->request_queue;
712 blk_queue_max_hw_segments(q, q->max_hw_segments - 1);
716 return 0; /* scsi layer doesn't check return value, sigh */
720 * ata_scsi_timed_out - SCSI layer time out callback
721 * @cmd: timed out SCSI command
723 * Handles SCSI layer timeout. We race with normal completion of
724 * the qc for @cmd. If the qc is already gone, we lose and let
725 * the scsi command finish (EH_HANDLED). Otherwise, the qc has
726 * timed out and EH should be invoked. Prevent ata_qc_complete()
727 * from finishing it by setting EH_SCHEDULED and return
731 * Called from timer context
734 * EH_HANDLED or EH_NOT_HANDLED
736 enum scsi_eh_timer_return ata_scsi_timed_out(struct scsi_cmnd *cmd)
738 struct Scsi_Host *host = cmd->device->host;
739 struct ata_port *ap = (struct ata_port *) &host->hostdata[0];
741 struct ata_queued_cmd *qc;
742 enum scsi_eh_timer_return ret = EH_HANDLED;
746 spin_lock_irqsave(&ap->host_set->lock, flags);
747 qc = ata_qc_from_tag(ap, ap->active_tag);
749 WARN_ON(qc->scsicmd != cmd);
750 qc->flags |= ATA_QCFLAG_EH_SCHEDULED;
751 qc->err_mask |= AC_ERR_TIMEOUT;
752 ret = EH_NOT_HANDLED;
754 spin_unlock_irqrestore(&ap->host_set->lock, flags);
756 DPRINTK("EXIT, ret=%d\n", ret);
761 * ata_scsi_error - SCSI layer error handler callback
762 * @host: SCSI host on which error occurred
764 * Handles SCSI-layer-thrown error events.
767 * Inherited from SCSI layer (none, can sleep)
773 int ata_scsi_error(struct Scsi_Host *host)
780 ap = (struct ata_port *) &host->hostdata[0];
782 spin_lock_irqsave(&ap->host_set->lock, flags);
783 WARN_ON(ap->flags & ATA_FLAG_IN_EH);
784 ap->flags |= ATA_FLAG_IN_EH;
785 WARN_ON(ata_qc_from_tag(ap, ap->active_tag) == NULL);
786 spin_unlock_irqrestore(&ap->host_set->lock, flags);
788 ata_port_flush_task(ap);
790 ap->ops->eng_timeout(ap);
792 WARN_ON(host->host_failed || !list_empty(&host->eh_cmd_q));
794 scsi_eh_flush_done_q(&ap->eh_done_q);
796 spin_lock_irqsave(&ap->host_set->lock, flags);
797 ap->flags &= ~ATA_FLAG_IN_EH;
798 spin_unlock_irqrestore(&ap->host_set->lock, flags);
804 static void ata_eh_scsidone(struct scsi_cmnd *scmd)
809 static void __ata_eh_qc_complete(struct ata_queued_cmd *qc)
811 struct ata_port *ap = qc->ap;
812 struct scsi_cmnd *scmd = qc->scsicmd;
815 spin_lock_irqsave(&ap->host_set->lock, flags);
816 qc->scsidone = ata_eh_scsidone;
817 __ata_qc_complete(qc);
818 WARN_ON(ata_tag_valid(qc->tag));
819 spin_unlock_irqrestore(&ap->host_set->lock, flags);
821 scsi_eh_finish_cmd(scmd, &ap->eh_done_q);
825 * ata_eh_qc_complete - Complete an active ATA command from EH
826 * @qc: Command to complete
828 * Indicate to the mid and upper layers that an ATA command has
829 * completed. To be used from EH.
831 void ata_eh_qc_complete(struct ata_queued_cmd *qc)
833 struct scsi_cmnd *scmd = qc->scsicmd;
834 scmd->retries = scmd->allowed;
835 __ata_eh_qc_complete(qc);
839 * ata_eh_qc_retry - Tell midlayer to retry an ATA command after EH
840 * @qc: Command to retry
842 * Indicate to the mid and upper layers that an ATA command
843 * should be retried. To be used from EH.
845 * SCSI midlayer limits the number of retries to scmd->allowed.
846 * This function might need to adjust scmd->retries for commands
847 * which get retried due to unrelated NCQ failures.
849 void ata_eh_qc_retry(struct ata_queued_cmd *qc)
851 __ata_eh_qc_complete(qc);
855 * ata_scsi_start_stop_xlat - Translate SCSI START STOP UNIT command
856 * @qc: Storage for translated ATA taskfile
857 * @scsicmd: SCSI command to translate
859 * Sets up an ATA taskfile to issue STANDBY (to stop) or READ VERIFY
860 * (to start). Perhaps these commands should be preceded by
861 * CHECK POWER MODE to see what power mode the device is already in.
862 * [See SAT revision 5 at www.t10.org]
865 * spin_lock_irqsave(host_set lock)
868 * Zero on success, non-zero on error.
871 static unsigned int ata_scsi_start_stop_xlat(struct ata_queued_cmd *qc,
874 struct ata_taskfile *tf = &qc->tf;
876 tf->flags |= ATA_TFLAG_DEVICE | ATA_TFLAG_ISADDR;
877 tf->protocol = ATA_PROT_NODATA;
878 if (scsicmd[1] & 0x1) {
879 ; /* ignore IMMED bit, violates sat-r05 */
881 if (scsicmd[4] & 0x2)
882 goto invalid_fld; /* LOEJ bit set not supported */
883 if (((scsicmd[4] >> 4) & 0xf) != 0)
884 goto invalid_fld; /* power conditions not supported */
885 if (scsicmd[4] & 0x1) {
886 tf->nsect = 1; /* 1 sector, lba=0 */
888 if (qc->dev->flags & ATA_DFLAG_LBA) {
889 qc->tf.flags |= ATA_TFLAG_LBA;
894 tf->device |= ATA_LBA;
897 tf->lbal = 0x1; /* sect */
898 tf->lbam = 0x0; /* cyl low */
899 tf->lbah = 0x0; /* cyl high */
902 tf->command = ATA_CMD_VERIFY; /* READ VERIFY */
904 tf->nsect = 0; /* time period value (0 implies now) */
905 tf->command = ATA_CMD_STANDBY;
906 /* Consider: ATA STANDBY IMMEDIATE command */
909 * Standby and Idle condition timers could be implemented but that
910 * would require libata to implement the Power condition mode page
911 * and allow the user to change it. Changing mode pages requires
912 * MODE SELECT to be implemented.
918 ata_scsi_set_sense(qc->scsicmd, ILLEGAL_REQUEST, 0x24, 0x0);
919 /* "Invalid field in cbd" */
925 * ata_scsi_flush_xlat - Translate SCSI SYNCHRONIZE CACHE command
926 * @qc: Storage for translated ATA taskfile
927 * @scsicmd: SCSI command to translate (ignored)
929 * Sets up an ATA taskfile to issue FLUSH CACHE or
933 * spin_lock_irqsave(host_set lock)
936 * Zero on success, non-zero on error.
939 static unsigned int ata_scsi_flush_xlat(struct ata_queued_cmd *qc, const u8 *scsicmd)
941 struct ata_taskfile *tf = &qc->tf;
943 tf->flags |= ATA_TFLAG_DEVICE;
944 tf->protocol = ATA_PROT_NODATA;
946 if ((qc->dev->flags & ATA_DFLAG_LBA48) &&
947 (ata_id_has_flush_ext(qc->dev->id)))
948 tf->command = ATA_CMD_FLUSH_EXT;
950 tf->command = ATA_CMD_FLUSH;
956 * scsi_6_lba_len - Get LBA and transfer length
957 * @scsicmd: SCSI command to translate
959 * Calculate LBA and transfer length for 6-byte commands.
963 * @plen: the transfer length
966 static void scsi_6_lba_len(const u8 *scsicmd, u64 *plba, u32 *plen)
971 VPRINTK("six-byte command\n");
973 lba |= ((u64)scsicmd[2]) << 8;
974 lba |= ((u64)scsicmd[3]);
976 len |= ((u32)scsicmd[4]);
983 * scsi_10_lba_len - Get LBA and transfer length
984 * @scsicmd: SCSI command to translate
986 * Calculate LBA and transfer length for 10-byte commands.
990 * @plen: the transfer length
993 static void scsi_10_lba_len(const u8 *scsicmd, u64 *plba, u32 *plen)
998 VPRINTK("ten-byte command\n");
1000 lba |= ((u64)scsicmd[2]) << 24;
1001 lba |= ((u64)scsicmd[3]) << 16;
1002 lba |= ((u64)scsicmd[4]) << 8;
1003 lba |= ((u64)scsicmd[5]);
1005 len |= ((u32)scsicmd[7]) << 8;
1006 len |= ((u32)scsicmd[8]);
1013 * scsi_16_lba_len - Get LBA and transfer length
1014 * @scsicmd: SCSI command to translate
1016 * Calculate LBA and transfer length for 16-byte commands.
1020 * @plen: the transfer length
1023 static void scsi_16_lba_len(const u8 *scsicmd, u64 *plba, u32 *plen)
1028 VPRINTK("sixteen-byte command\n");
1030 lba |= ((u64)scsicmd[2]) << 56;
1031 lba |= ((u64)scsicmd[3]) << 48;
1032 lba |= ((u64)scsicmd[4]) << 40;
1033 lba |= ((u64)scsicmd[5]) << 32;
1034 lba |= ((u64)scsicmd[6]) << 24;
1035 lba |= ((u64)scsicmd[7]) << 16;
1036 lba |= ((u64)scsicmd[8]) << 8;
1037 lba |= ((u64)scsicmd[9]);
1039 len |= ((u32)scsicmd[10]) << 24;
1040 len |= ((u32)scsicmd[11]) << 16;
1041 len |= ((u32)scsicmd[12]) << 8;
1042 len |= ((u32)scsicmd[13]);
1049 * ata_scsi_verify_xlat - Translate SCSI VERIFY command into an ATA one
1050 * @qc: Storage for translated ATA taskfile
1051 * @scsicmd: SCSI command to translate
1053 * Converts SCSI VERIFY command to an ATA READ VERIFY command.
1056 * spin_lock_irqsave(host_set lock)
1059 * Zero on success, non-zero on error.
1062 static unsigned int ata_scsi_verify_xlat(struct ata_queued_cmd *qc, const u8 *scsicmd)
1064 struct ata_taskfile *tf = &qc->tf;
1065 struct ata_device *dev = qc->dev;
1066 u64 dev_sectors = qc->dev->n_sectors;
1070 tf->flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
1071 tf->protocol = ATA_PROT_NODATA;
1073 if (scsicmd[0] == VERIFY)
1074 scsi_10_lba_len(scsicmd, &block, &n_block);
1075 else if (scsicmd[0] == VERIFY_16)
1076 scsi_16_lba_len(scsicmd, &block, &n_block);
1082 if (block >= dev_sectors)
1084 if ((block + n_block) > dev_sectors)
1087 if (dev->flags & ATA_DFLAG_LBA) {
1088 tf->flags |= ATA_TFLAG_LBA;
1090 if (lba_28_ok(block, n_block)) {
1092 tf->command = ATA_CMD_VERIFY;
1093 tf->device |= (block >> 24) & 0xf;
1094 } else if (lba_48_ok(block, n_block)) {
1095 if (!(dev->flags & ATA_DFLAG_LBA48))
1099 tf->flags |= ATA_TFLAG_LBA48;
1100 tf->command = ATA_CMD_VERIFY_EXT;
1102 tf->hob_nsect = (n_block >> 8) & 0xff;
1104 tf->hob_lbah = (block >> 40) & 0xff;
1105 tf->hob_lbam = (block >> 32) & 0xff;
1106 tf->hob_lbal = (block >> 24) & 0xff;
1108 /* request too large even for LBA48 */
1111 tf->nsect = n_block & 0xff;
1113 tf->lbah = (block >> 16) & 0xff;
1114 tf->lbam = (block >> 8) & 0xff;
1115 tf->lbal = block & 0xff;
1117 tf->device |= ATA_LBA;
1120 u32 sect, head, cyl, track;
1122 if (!lba_28_ok(block, n_block))
1125 /* Convert LBA to CHS */
1126 track = (u32)block / dev->sectors;
1127 cyl = track / dev->heads;
1128 head = track % dev->heads;
1129 sect = (u32)block % dev->sectors + 1;
1131 DPRINTK("block %u track %u cyl %u head %u sect %u\n",
1132 (u32)block, track, cyl, head, sect);
1134 /* Check whether the converted CHS can fit.
1138 if ((cyl >> 16) || (head >> 4) || (sect >> 8) || (!sect))
1141 tf->command = ATA_CMD_VERIFY;
1142 tf->nsect = n_block & 0xff; /* Sector count 0 means 256 sectors */
1145 tf->lbah = cyl >> 8;
1152 ata_scsi_set_sense(qc->scsicmd, ILLEGAL_REQUEST, 0x24, 0x0);
1153 /* "Invalid field in cbd" */
1157 ata_scsi_set_sense(qc->scsicmd, ILLEGAL_REQUEST, 0x21, 0x0);
1158 /* "Logical Block Address out of range" */
1162 qc->scsicmd->result = SAM_STAT_GOOD;
1167 * ata_scsi_rw_xlat - Translate SCSI r/w command into an ATA one
1168 * @qc: Storage for translated ATA taskfile
1169 * @scsicmd: SCSI command to translate
1171 * Converts any of six SCSI read/write commands into the
1172 * ATA counterpart, including starting sector (LBA),
1173 * sector count, and taking into account the device's LBA48
1176 * Commands %READ_6, %READ_10, %READ_16, %WRITE_6, %WRITE_10, and
1177 * %WRITE_16 are currently supported.
1180 * spin_lock_irqsave(host_set lock)
1183 * Zero on success, non-zero on error.
1186 static unsigned int ata_scsi_rw_xlat(struct ata_queued_cmd *qc, const u8 *scsicmd)
1188 struct ata_taskfile *tf = &qc->tf;
1189 struct ata_device *dev = qc->dev;
1193 tf->flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
1195 if (scsicmd[0] == WRITE_10 || scsicmd[0] == WRITE_6 ||
1196 scsicmd[0] == WRITE_16)
1197 tf->flags |= ATA_TFLAG_WRITE;
1199 /* Calculate the SCSI LBA, transfer length and FUA. */
1200 switch (scsicmd[0]) {
1203 scsi_10_lba_len(scsicmd, &block, &n_block);
1204 if (unlikely(scsicmd[1] & (1 << 3)))
1205 tf->flags |= ATA_TFLAG_FUA;
1209 scsi_6_lba_len(scsicmd, &block, &n_block);
1211 /* for 6-byte r/w commands, transfer length 0
1212 * means 256 blocks of data, not 0 block.
1219 scsi_16_lba_len(scsicmd, &block, &n_block);
1220 if (unlikely(scsicmd[1] & (1 << 3)))
1221 tf->flags |= ATA_TFLAG_FUA;
1224 DPRINTK("no-byte command\n");
1228 /* Check and compose ATA command */
1230 /* For 10-byte and 16-byte SCSI R/W commands, transfer
1231 * length 0 means transfer 0 block of data.
1232 * However, for ATA R/W commands, sector count 0 means
1233 * 256 or 65536 sectors, not 0 sectors as in SCSI.
1235 * WARNING: one or two older ATA drives treat 0 as 0...
1239 if (dev->flags & ATA_DFLAG_LBA) {
1240 tf->flags |= ATA_TFLAG_LBA;
1242 if (lba_28_ok(block, n_block)) {
1244 tf->device |= (block >> 24) & 0xf;
1245 } else if (lba_48_ok(block, n_block)) {
1246 if (!(dev->flags & ATA_DFLAG_LBA48))
1250 tf->flags |= ATA_TFLAG_LBA48;
1252 tf->hob_nsect = (n_block >> 8) & 0xff;
1254 tf->hob_lbah = (block >> 40) & 0xff;
1255 tf->hob_lbam = (block >> 32) & 0xff;
1256 tf->hob_lbal = (block >> 24) & 0xff;
1258 /* request too large even for LBA48 */
1261 if (unlikely(ata_rwcmd_protocol(qc) < 0))
1264 qc->nsect = n_block;
1265 tf->nsect = n_block & 0xff;
1267 tf->lbah = (block >> 16) & 0xff;
1268 tf->lbam = (block >> 8) & 0xff;
1269 tf->lbal = block & 0xff;
1271 tf->device |= ATA_LBA;
1274 u32 sect, head, cyl, track;
1276 /* The request -may- be too large for CHS addressing. */
1277 if (!lba_28_ok(block, n_block))
1280 if (unlikely(ata_rwcmd_protocol(qc) < 0))
1283 /* Convert LBA to CHS */
1284 track = (u32)block / dev->sectors;
1285 cyl = track / dev->heads;
1286 head = track % dev->heads;
1287 sect = (u32)block % dev->sectors + 1;
1289 DPRINTK("block %u track %u cyl %u head %u sect %u\n",
1290 (u32)block, track, cyl, head, sect);
1292 /* Check whether the converted CHS can fit.
1296 if ((cyl >> 16) || (head >> 4) || (sect >> 8) || (!sect))
1299 qc->nsect = n_block;
1300 tf->nsect = n_block & 0xff; /* Sector count 0 means 256 sectors */
1303 tf->lbah = cyl >> 8;
1310 ata_scsi_set_sense(qc->scsicmd, ILLEGAL_REQUEST, 0x24, 0x0);
1311 /* "Invalid field in cbd" */
1315 ata_scsi_set_sense(qc->scsicmd, ILLEGAL_REQUEST, 0x21, 0x0);
1316 /* "Logical Block Address out of range" */
1320 qc->scsicmd->result = SAM_STAT_GOOD;
1324 static void ata_scsi_qc_complete(struct ata_queued_cmd *qc)
1326 struct scsi_cmnd *cmd = qc->scsicmd;
1327 u8 *cdb = cmd->cmnd;
1328 int need_sense = (qc->err_mask != 0);
1330 /* For ATA pass thru (SAT) commands, generate a sense block if
1331 * user mandated it or if there's an error. Note that if we
1332 * generate because the user forced us to, a check condition
1333 * is generated and the ATA register values are returned
1334 * whether the command completed successfully or not. If there
1335 * was no error, SK, ASC and ASCQ will all be zero.
1337 if (((cdb[0] == ATA_16) || (cdb[0] == ATA_12)) &&
1338 ((cdb[2] & 0x20) || need_sense)) {
1339 ata_gen_ata_desc_sense(qc);
1342 cmd->result = SAM_STAT_GOOD;
1344 /* TODO: decide which descriptor format to use
1345 * for 48b LBA devices and call that here
1346 * instead of the fixed desc, which is only
1347 * good for smaller LBA (and maybe CHS?)
1350 ata_gen_fixed_sense(qc);
1355 /* The ata_gen_..._sense routines fill in tf */
1356 ata_dump_status(qc->ap->id, &qc->tf);
1365 * ata_scsi_translate - Translate then issue SCSI command to ATA device
1366 * @ap: ATA port to which the command is addressed
1367 * @dev: ATA device to which the command is addressed
1368 * @cmd: SCSI command to execute
1369 * @done: SCSI command completion function
1370 * @xlat_func: Actor which translates @cmd to an ATA taskfile
1372 * Our ->queuecommand() function has decided that the SCSI
1373 * command issued can be directly translated into an ATA
1374 * command, rather than handled internally.
1376 * This function sets up an ata_queued_cmd structure for the
1377 * SCSI command, and sends that ata_queued_cmd to the hardware.
1379 * The xlat_func argument (actor) returns 0 if ready to execute
1380 * ATA command, else 1 to finish translation. If 1 is returned
1381 * then cmd->result (and possibly cmd->sense_buffer) are assumed
1382 * to be set reflecting an error condition or clean (early)
1386 * spin_lock_irqsave(host_set lock)
1389 static void ata_scsi_translate(struct ata_port *ap, struct ata_device *dev,
1390 struct scsi_cmnd *cmd,
1391 void (*done)(struct scsi_cmnd *),
1392 ata_xlat_func_t xlat_func)
1394 struct ata_queued_cmd *qc;
1395 u8 *scsicmd = cmd->cmnd;
1399 qc = ata_scsi_qc_new(ap, dev, cmd, done);
1403 /* data is present; dma-map it */
1404 if (cmd->sc_data_direction == DMA_FROM_DEVICE ||
1405 cmd->sc_data_direction == DMA_TO_DEVICE) {
1406 if (unlikely(cmd->request_bufflen < 1)) {
1407 printk(KERN_WARNING "ata%u(%u): WARNING: zero len r/w req\n",
1408 ap->id, dev->devno);
1413 ata_sg_init(qc, cmd->request_buffer, cmd->use_sg);
1415 ata_sg_init_one(qc, cmd->request_buffer,
1416 cmd->request_bufflen);
1418 qc->dma_dir = cmd->sc_data_direction;
1421 qc->complete_fn = ata_scsi_qc_complete;
1423 if (xlat_func(qc, scsicmd))
1426 /* select device, send command to hardware */
1427 qc->err_mask = ata_qc_issue(qc);
1429 ata_qc_complete(qc);
1437 DPRINTK("EXIT - early finish (good or error)\n");
1443 cmd->result = (DID_ERROR << 16);
1445 DPRINTK("EXIT - internal\n");
1450 * ata_scsi_rbuf_get - Map response buffer.
1451 * @cmd: SCSI command containing buffer to be mapped.
1452 * @buf_out: Pointer to mapped area.
1454 * Maps buffer contained within SCSI command @cmd.
1457 * spin_lock_irqsave(host_set lock)
1460 * Length of response buffer.
1463 static unsigned int ata_scsi_rbuf_get(struct scsi_cmnd *cmd, u8 **buf_out)
1466 unsigned int buflen;
1469 struct scatterlist *sg;
1471 sg = (struct scatterlist *) cmd->request_buffer;
1472 buf = kmap_atomic(sg->page, KM_USER0) + sg->offset;
1473 buflen = sg->length;
1475 buf = cmd->request_buffer;
1476 buflen = cmd->request_bufflen;
1484 * ata_scsi_rbuf_put - Unmap response buffer.
1485 * @cmd: SCSI command containing buffer to be unmapped.
1486 * @buf: buffer to unmap
1488 * Unmaps response buffer contained within @cmd.
1491 * spin_lock_irqsave(host_set lock)
1494 static inline void ata_scsi_rbuf_put(struct scsi_cmnd *cmd, u8 *buf)
1497 struct scatterlist *sg;
1499 sg = (struct scatterlist *) cmd->request_buffer;
1500 kunmap_atomic(buf - sg->offset, KM_USER0);
1505 * ata_scsi_rbuf_fill - wrapper for SCSI command simulators
1506 * @args: device IDENTIFY data / SCSI command of interest.
1507 * @actor: Callback hook for desired SCSI command simulator
1509 * Takes care of the hard work of simulating a SCSI command...
1510 * Mapping the response buffer, calling the command's handler,
1511 * and handling the handler's return value. This return value
1512 * indicates whether the handler wishes the SCSI command to be
1513 * completed successfully (0), or not (in which case cmd->result
1514 * and sense buffer are assumed to be set).
1517 * spin_lock_irqsave(host_set lock)
1520 void ata_scsi_rbuf_fill(struct ata_scsi_args *args,
1521 unsigned int (*actor) (struct ata_scsi_args *args,
1522 u8 *rbuf, unsigned int buflen))
1525 unsigned int buflen, rc;
1526 struct scsi_cmnd *cmd = args->cmd;
1528 buflen = ata_scsi_rbuf_get(cmd, &rbuf);
1529 memset(rbuf, 0, buflen);
1530 rc = actor(args, rbuf, buflen);
1531 ata_scsi_rbuf_put(cmd, rbuf);
1534 cmd->result = SAM_STAT_GOOD;
1539 * ata_scsiop_inq_std - Simulate INQUIRY command
1540 * @args: device IDENTIFY data / SCSI command of interest.
1541 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1542 * @buflen: Response buffer length.
1544 * Returns standard device identification data associated
1545 * with non-VPD INQUIRY command output.
1548 * spin_lock_irqsave(host_set lock)
1551 unsigned int ata_scsiop_inq_std(struct ata_scsi_args *args, u8 *rbuf,
1552 unsigned int buflen)
1557 0x5, /* claim SPC-3 version compatibility */
1562 /* set scsi removeable (RMB) bit per ata bit */
1563 if (ata_id_removeable(args->id))
1568 memcpy(rbuf, hdr, sizeof(hdr));
1571 memcpy(&rbuf[8], "ATA ", 8);
1572 ata_id_string(args->id, &rbuf[16], ATA_ID_PROD_OFS, 16);
1573 ata_id_string(args->id, &rbuf[32], ATA_ID_FW_REV_OFS, 4);
1574 if (rbuf[32] == 0 || rbuf[32] == ' ')
1575 memcpy(&rbuf[32], "n/a ", 4);
1579 const u8 versions[] = {
1580 0x60, /* SAM-3 (no version claimed) */
1583 0x20, /* SBC-2 (no version claimed) */
1586 0x60 /* SPC-3 (no version claimed) */
1589 memcpy(rbuf + 59, versions, sizeof(versions));
1596 * ata_scsiop_inq_00 - Simulate INQUIRY VPD page 0, list of pages
1597 * @args: device IDENTIFY data / SCSI command of interest.
1598 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1599 * @buflen: Response buffer length.
1601 * Returns list of inquiry VPD pages available.
1604 * spin_lock_irqsave(host_set lock)
1607 unsigned int ata_scsiop_inq_00(struct ata_scsi_args *args, u8 *rbuf,
1608 unsigned int buflen)
1610 const u8 pages[] = {
1611 0x00, /* page 0x00, this page */
1612 0x80, /* page 0x80, unit serial no page */
1613 0x83 /* page 0x83, device ident page */
1615 rbuf[3] = sizeof(pages); /* number of supported VPD pages */
1618 memcpy(rbuf + 4, pages, sizeof(pages));
1624 * ata_scsiop_inq_80 - Simulate INQUIRY VPD page 80, device serial number
1625 * @args: device IDENTIFY data / SCSI command of interest.
1626 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1627 * @buflen: Response buffer length.
1629 * Returns ATA device serial number.
1632 * spin_lock_irqsave(host_set lock)
1635 unsigned int ata_scsiop_inq_80(struct ata_scsi_args *args, u8 *rbuf,
1636 unsigned int buflen)
1640 0x80, /* this page code */
1642 ATA_SERNO_LEN, /* page len */
1644 memcpy(rbuf, hdr, sizeof(hdr));
1646 if (buflen > (ATA_SERNO_LEN + 4 - 1))
1647 ata_id_string(args->id, (unsigned char *) &rbuf[4],
1648 ATA_ID_SERNO_OFS, ATA_SERNO_LEN);
1654 * ata_scsiop_inq_83 - Simulate INQUIRY VPD page 83, device identity
1655 * @args: device IDENTIFY data / SCSI command of interest.
1656 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1657 * @buflen: Response buffer length.
1659 * Yields two logical unit device identification designators:
1660 * - vendor specific ASCII containing the ATA serial number
1661 * - SAT defined "t10 vendor id based" containing ASCII vendor
1662 * name ("ATA "), model and serial numbers.
1665 * spin_lock_irqsave(host_set lock)
1668 unsigned int ata_scsiop_inq_83(struct ata_scsi_args *args, u8 *rbuf,
1669 unsigned int buflen)
1672 const int sat_model_serial_desc_len = 68;
1673 const int ata_model_byte_len = 40;
1675 rbuf[1] = 0x83; /* this page code */
1678 if (buflen > (ATA_SERNO_LEN + num + 3)) {
1679 /* piv=0, assoc=lu, code_set=ACSII, designator=vendor */
1681 rbuf[num + 3] = ATA_SERNO_LEN;
1683 ata_id_string(args->id, (unsigned char *) rbuf + num,
1684 ATA_ID_SERNO_OFS, ATA_SERNO_LEN);
1685 num += ATA_SERNO_LEN;
1687 if (buflen > (sat_model_serial_desc_len + num + 3)) {
1688 /* SAT defined lu model and serial numbers descriptor */
1689 /* piv=0, assoc=lu, code_set=ACSII, designator=t10 vendor id */
1692 rbuf[num + 3] = sat_model_serial_desc_len;
1694 memcpy(rbuf + num, "ATA ", 8);
1696 ata_id_string(args->id, (unsigned char *) rbuf + num,
1697 ATA_ID_PROD_OFS, ata_model_byte_len);
1698 num += ata_model_byte_len;
1699 ata_id_string(args->id, (unsigned char *) rbuf + num,
1700 ATA_ID_SERNO_OFS, ATA_SERNO_LEN);
1701 num += ATA_SERNO_LEN;
1703 rbuf[3] = num - 4; /* page len (assume less than 256 bytes) */
1708 * ata_scsiop_noop - Command handler that simply returns success.
1709 * @args: device IDENTIFY data / SCSI command of interest.
1710 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1711 * @buflen: Response buffer length.
1713 * No operation. Simply returns success to caller, to indicate
1714 * that the caller should successfully complete this SCSI command.
1717 * spin_lock_irqsave(host_set lock)
1720 unsigned int ata_scsiop_noop(struct ata_scsi_args *args, u8 *rbuf,
1721 unsigned int buflen)
1728 * ata_msense_push - Push data onto MODE SENSE data output buffer
1729 * @ptr_io: (input/output) Location to store more output data
1730 * @last: End of output data buffer
1731 * @buf: Pointer to BLOB being added to output buffer
1732 * @buflen: Length of BLOB
1734 * Store MODE SENSE data on an output buffer.
1740 static void ata_msense_push(u8 **ptr_io, const u8 *last,
1741 const u8 *buf, unsigned int buflen)
1745 if ((ptr + buflen - 1) > last)
1748 memcpy(ptr, buf, buflen);
1756 * ata_msense_caching - Simulate MODE SENSE caching info page
1757 * @id: device IDENTIFY data
1758 * @ptr_io: (input/output) Location to store more output data
1759 * @last: End of output data buffer
1761 * Generate a caching info page, which conditionally indicates
1762 * write caching to the SCSI layer, depending on device
1769 static unsigned int ata_msense_caching(u16 *id, u8 **ptr_io,
1772 u8 page[CACHE_MPAGE_LEN];
1774 memcpy(page, def_cache_mpage, sizeof(page));
1775 if (ata_id_wcache_enabled(id))
1776 page[2] |= (1 << 2); /* write cache enable */
1777 if (!ata_id_rahead_enabled(id))
1778 page[12] |= (1 << 5); /* disable read ahead */
1780 ata_msense_push(ptr_io, last, page, sizeof(page));
1781 return sizeof(page);
1785 * ata_msense_ctl_mode - Simulate MODE SENSE control mode page
1786 * @dev: Device associated with this MODE SENSE command
1787 * @ptr_io: (input/output) Location to store more output data
1788 * @last: End of output data buffer
1790 * Generate a generic MODE SENSE control mode page.
1796 static unsigned int ata_msense_ctl_mode(u8 **ptr_io, const u8 *last)
1798 ata_msense_push(ptr_io, last, def_control_mpage,
1799 sizeof(def_control_mpage));
1800 return sizeof(def_control_mpage);
1804 * ata_msense_rw_recovery - Simulate MODE SENSE r/w error recovery page
1805 * @dev: Device associated with this MODE SENSE command
1806 * @ptr_io: (input/output) Location to store more output data
1807 * @last: End of output data buffer
1809 * Generate a generic MODE SENSE r/w error recovery page.
1815 static unsigned int ata_msense_rw_recovery(u8 **ptr_io, const u8 *last)
1818 ata_msense_push(ptr_io, last, def_rw_recovery_mpage,
1819 sizeof(def_rw_recovery_mpage));
1820 return sizeof(def_rw_recovery_mpage);
1824 * We can turn this into a real blacklist if it's needed, for now just
1825 * blacklist any Maxtor BANC1G10 revision firmware
1827 static int ata_dev_supports_fua(u16 *id)
1829 unsigned char model[41], fw[9];
1833 if (!ata_id_has_fua(id))
1836 ata_id_c_string(id, model, ATA_ID_PROD_OFS, sizeof(model));
1837 ata_id_c_string(id, fw, ATA_ID_FW_REV_OFS, sizeof(fw));
1839 if (strcmp(model, "Maxtor"))
1841 if (strcmp(fw, "BANC1G10"))
1844 return 0; /* blacklisted */
1848 * ata_scsiop_mode_sense - Simulate MODE SENSE 6, 10 commands
1849 * @args: device IDENTIFY data / SCSI command of interest.
1850 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1851 * @buflen: Response buffer length.
1853 * Simulate MODE SENSE commands. Assume this is invoked for direct
1854 * access devices (e.g. disks) only. There should be no block
1855 * descriptor for other device types.
1858 * spin_lock_irqsave(host_set lock)
1861 unsigned int ata_scsiop_mode_sense(struct ata_scsi_args *args, u8 *rbuf,
1862 unsigned int buflen)
1864 struct ata_device *dev = args->dev;
1865 u8 *scsicmd = args->cmd->cmnd, *p, *last;
1866 const u8 sat_blk_desc[] = {
1867 0, 0, 0, 0, /* number of blocks: sat unspecified */
1869 0, 0x2, 0x0 /* block length: 512 bytes */
1872 unsigned int ebd, page_control, six_byte, output_len, alloc_len, minlen;
1877 six_byte = (scsicmd[0] == MODE_SENSE);
1878 ebd = !(scsicmd[1] & 0x8); /* dbd bit inverted == edb */
1880 * LLBA bit in msense(10) ignored (compliant)
1883 page_control = scsicmd[2] >> 6;
1884 switch (page_control) {
1885 case 0: /* current */
1886 break; /* supported */
1888 goto saving_not_supp;
1889 case 1: /* changeable */
1890 case 2: /* defaults */
1896 output_len = 4 + (ebd ? 8 : 0);
1897 alloc_len = scsicmd[4];
1899 output_len = 8 + (ebd ? 8 : 0);
1900 alloc_len = (scsicmd[7] << 8) + scsicmd[8];
1902 minlen = (alloc_len < buflen) ? alloc_len : buflen;
1904 p = rbuf + output_len;
1905 last = rbuf + minlen - 1;
1907 pg = scsicmd[2] & 0x3f;
1910 * No mode subpages supported (yet) but asking for _all_
1911 * subpages may be valid
1913 if (spg && (spg != ALL_SUB_MPAGES))
1917 case RW_RECOVERY_MPAGE:
1918 output_len += ata_msense_rw_recovery(&p, last);
1922 output_len += ata_msense_caching(args->id, &p, last);
1925 case CONTROL_MPAGE: {
1926 output_len += ata_msense_ctl_mode(&p, last);
1931 output_len += ata_msense_rw_recovery(&p, last);
1932 output_len += ata_msense_caching(args->id, &p, last);
1933 output_len += ata_msense_ctl_mode(&p, last);
1936 default: /* invalid page code */
1944 if (ata_dev_supports_fua(args->id) && dev->flags & ATA_DFLAG_LBA48 &&
1945 (!(dev->flags & ATA_DFLAG_PIO) || dev->multi_count))
1950 rbuf[0] = output_len;
1955 rbuf[3] = sizeof(sat_blk_desc);
1957 memcpy(rbuf + 4, sat_blk_desc,
1958 sizeof(sat_blk_desc));
1962 rbuf[0] = output_len >> 8;
1964 rbuf[1] = output_len;
1969 rbuf[7] = sizeof(sat_blk_desc);
1971 memcpy(rbuf + 8, sat_blk_desc,
1972 sizeof(sat_blk_desc));
1978 ata_scsi_set_sense(args->cmd, ILLEGAL_REQUEST, 0x24, 0x0);
1979 /* "Invalid field in cbd" */
1983 ata_scsi_set_sense(args->cmd, ILLEGAL_REQUEST, 0x39, 0x0);
1984 /* "Saving parameters not supported" */
1989 * ata_scsiop_read_cap - Simulate READ CAPACITY[ 16] commands
1990 * @args: device IDENTIFY data / SCSI command of interest.
1991 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1992 * @buflen: Response buffer length.
1994 * Simulate READ CAPACITY commands.
1997 * spin_lock_irqsave(host_set lock)
2000 unsigned int ata_scsiop_read_cap(struct ata_scsi_args *args, u8 *rbuf,
2001 unsigned int buflen)
2008 if (ata_id_has_lba(args->id)) {
2009 if (ata_id_has_lba48(args->id))
2010 n_sectors = ata_id_u64(args->id, 100);
2012 n_sectors = ata_id_u32(args->id, 60);
2014 /* CHS default translation */
2015 n_sectors = args->id[1] * args->id[3] * args->id[6];
2017 if (ata_id_current_chs_valid(args->id))
2018 /* CHS current translation */
2019 n_sectors = ata_id_u32(args->id, 57);
2022 n_sectors--; /* ATA TotalUserSectors - 1 */
2024 if (args->cmd->cmnd[0] == READ_CAPACITY) {
2025 if( n_sectors >= 0xffffffffULL )
2026 tmp = 0xffffffff ; /* Return max count on overflow */
2030 /* sector count, 32-bit */
2031 rbuf[0] = tmp >> (8 * 3);
2032 rbuf[1] = tmp >> (8 * 2);
2033 rbuf[2] = tmp >> (8 * 1);
2037 tmp = ATA_SECT_SIZE;
2042 /* sector count, 64-bit */
2043 tmp = n_sectors >> (8 * 4);
2044 rbuf[2] = tmp >> (8 * 3);
2045 rbuf[3] = tmp >> (8 * 2);
2046 rbuf[4] = tmp >> (8 * 1);
2049 rbuf[6] = tmp >> (8 * 3);
2050 rbuf[7] = tmp >> (8 * 2);
2051 rbuf[8] = tmp >> (8 * 1);
2055 tmp = ATA_SECT_SIZE;
2056 rbuf[12] = tmp >> 8;
2064 * ata_scsiop_report_luns - Simulate REPORT LUNS command
2065 * @args: device IDENTIFY data / SCSI command of interest.
2066 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2067 * @buflen: Response buffer length.
2069 * Simulate REPORT LUNS command.
2072 * spin_lock_irqsave(host_set lock)
2075 unsigned int ata_scsiop_report_luns(struct ata_scsi_args *args, u8 *rbuf,
2076 unsigned int buflen)
2079 rbuf[3] = 8; /* just one lun, LUN 0, size 8 bytes */
2085 * ata_scsi_set_sense - Set SCSI sense data and status
2086 * @cmd: SCSI request to be handled
2087 * @sk: SCSI-defined sense key
2088 * @asc: SCSI-defined additional sense code
2089 * @ascq: SCSI-defined additional sense code qualifier
2091 * Helper function that builds a valid fixed format, current
2092 * response code and the given sense key (sk), additional sense
2093 * code (asc) and additional sense code qualifier (ascq) with
2094 * a SCSI command status of %SAM_STAT_CHECK_CONDITION and
2095 * DRIVER_SENSE set in the upper bits of scsi_cmnd::result .
2101 void ata_scsi_set_sense(struct scsi_cmnd *cmd, u8 sk, u8 asc, u8 ascq)
2103 cmd->result = (DRIVER_SENSE << 24) | SAM_STAT_CHECK_CONDITION;
2105 cmd->sense_buffer[0] = 0x70; /* fixed format, current */
2106 cmd->sense_buffer[2] = sk;
2107 cmd->sense_buffer[7] = 18 - 8; /* additional sense length */
2108 cmd->sense_buffer[12] = asc;
2109 cmd->sense_buffer[13] = ascq;
2113 * ata_scsi_badcmd - End a SCSI request with an error
2114 * @cmd: SCSI request to be handled
2115 * @done: SCSI command completion function
2116 * @asc: SCSI-defined additional sense code
2117 * @ascq: SCSI-defined additional sense code qualifier
2119 * Helper function that completes a SCSI command with
2120 * %SAM_STAT_CHECK_CONDITION, with a sense key %ILLEGAL_REQUEST
2121 * and the specified additional sense codes.
2124 * spin_lock_irqsave(host_set lock)
2127 void ata_scsi_badcmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *), u8 asc, u8 ascq)
2130 ata_scsi_set_sense(cmd, ILLEGAL_REQUEST, asc, ascq);
2135 static void atapi_sense_complete(struct ata_queued_cmd *qc)
2137 if (qc->err_mask && ((qc->err_mask & AC_ERR_DEV) == 0))
2138 /* FIXME: not quite right; we don't want the
2139 * translation of taskfile registers into
2140 * a sense descriptors, since that's only
2141 * correct for ATA, not ATAPI
2143 ata_gen_ata_desc_sense(qc);
2145 qc->scsidone(qc->scsicmd);
2149 /* is it pointless to prefer PIO for "safety reasons"? */
2150 static inline int ata_pio_use_silly(struct ata_port *ap)
2152 return (ap->flags & ATA_FLAG_PIO_DMA);
2155 static void atapi_request_sense(struct ata_queued_cmd *qc)
2157 struct ata_port *ap = qc->ap;
2158 struct scsi_cmnd *cmd = qc->scsicmd;
2160 DPRINTK("ATAPI request sense\n");
2162 /* FIXME: is this needed? */
2163 memset(cmd->sense_buffer, 0, sizeof(cmd->sense_buffer));
2165 ap->ops->tf_read(ap, &qc->tf);
2167 /* fill these in, for the case where they are -not- overwritten */
2168 cmd->sense_buffer[0] = 0x70;
2169 cmd->sense_buffer[2] = qc->tf.feature >> 4;
2173 ata_sg_init_one(qc, cmd->sense_buffer, sizeof(cmd->sense_buffer));
2174 qc->dma_dir = DMA_FROM_DEVICE;
2176 memset(&qc->cdb, 0, qc->dev->cdb_len);
2177 qc->cdb[0] = REQUEST_SENSE;
2178 qc->cdb[4] = SCSI_SENSE_BUFFERSIZE;
2180 qc->tf.flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
2181 qc->tf.command = ATA_CMD_PACKET;
2183 if (ata_pio_use_silly(ap)) {
2184 qc->tf.protocol = ATA_PROT_ATAPI_DMA;
2185 qc->tf.feature |= ATAPI_PKT_DMA;
2187 qc->tf.protocol = ATA_PROT_ATAPI;
2188 qc->tf.lbam = (8 * 1024) & 0xff;
2189 qc->tf.lbah = (8 * 1024) >> 8;
2191 qc->nbytes = SCSI_SENSE_BUFFERSIZE;
2193 qc->complete_fn = atapi_sense_complete;
2195 qc->err_mask = ata_qc_issue(qc);
2197 ata_qc_complete(qc);
2202 static void atapi_qc_complete(struct ata_queued_cmd *qc)
2204 struct scsi_cmnd *cmd = qc->scsicmd;
2205 unsigned int err_mask = qc->err_mask;
2207 VPRINTK("ENTER, err_mask 0x%X\n", err_mask);
2209 if (unlikely(err_mask & AC_ERR_DEV)) {
2210 cmd->result = SAM_STAT_CHECK_CONDITION;
2211 atapi_request_sense(qc);
2215 else if (unlikely(err_mask))
2216 /* FIXME: not quite right; we don't want the
2217 * translation of taskfile registers into
2218 * a sense descriptors, since that's only
2219 * correct for ATA, not ATAPI
2221 ata_gen_ata_desc_sense(qc);
2224 u8 *scsicmd = cmd->cmnd;
2226 if ((scsicmd[0] == INQUIRY) && ((scsicmd[1] & 0x03) == 0)) {
2228 unsigned int buflen;
2230 buflen = ata_scsi_rbuf_get(cmd, &buf);
2232 /* ATAPI devices typically report zero for their SCSI version,
2233 * and sometimes deviate from the spec WRT response data
2234 * format. If SCSI version is reported as zero like normal,
2235 * then we make the following fixups: 1) Fake MMC-5 version,
2236 * to indicate to the Linux scsi midlayer this is a modern
2237 * device. 2) Ensure response data format / ATAPI information
2238 * are always correct.
2245 ata_scsi_rbuf_put(cmd, buf);
2248 cmd->result = SAM_STAT_GOOD;
2255 * atapi_xlat - Initialize PACKET taskfile
2256 * @qc: command structure to be initialized
2257 * @scsicmd: SCSI CDB associated with this PACKET command
2260 * spin_lock_irqsave(host_set lock)
2263 * Zero on success, non-zero on failure.
2266 static unsigned int atapi_xlat(struct ata_queued_cmd *qc, const u8 *scsicmd)
2268 struct scsi_cmnd *cmd = qc->scsicmd;
2269 struct ata_device *dev = qc->dev;
2270 int using_pio = (dev->flags & ATA_DFLAG_PIO);
2271 int nodata = (cmd->sc_data_direction == DMA_NONE);
2274 /* Check whether ATAPI DMA is safe */
2275 if (ata_check_atapi_dma(qc))
2278 memcpy(&qc->cdb, scsicmd, dev->cdb_len);
2280 qc->complete_fn = atapi_qc_complete;
2282 qc->tf.flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
2283 if (cmd->sc_data_direction == DMA_TO_DEVICE) {
2284 qc->tf.flags |= ATA_TFLAG_WRITE;
2285 DPRINTK("direction: write\n");
2288 qc->tf.command = ATA_CMD_PACKET;
2290 /* no data, or PIO data xfer */
2291 if (using_pio || nodata) {
2293 qc->tf.protocol = ATA_PROT_ATAPI_NODATA;
2295 qc->tf.protocol = ATA_PROT_ATAPI;
2296 qc->tf.lbam = (8 * 1024) & 0xff;
2297 qc->tf.lbah = (8 * 1024) >> 8;
2302 qc->tf.protocol = ATA_PROT_ATAPI_DMA;
2303 qc->tf.feature |= ATAPI_PKT_DMA;
2305 #ifdef ATAPI_ENABLE_DMADIR
2306 /* some SATA bridges need us to indicate data xfer direction */
2307 if (cmd->sc_data_direction != DMA_TO_DEVICE)
2308 qc->tf.feature |= ATAPI_DMADIR;
2312 qc->nbytes = cmd->bufflen;
2318 * ata_scsi_find_dev - lookup ata_device from scsi_cmnd
2319 * @ap: ATA port to which the device is attached
2320 * @scsidev: SCSI device from which we derive the ATA device
2322 * Given various information provided in struct scsi_cmnd,
2323 * map that onto an ATA bus, and using that mapping
2324 * determine which ata_device is associated with the
2325 * SCSI command to be sent.
2328 * spin_lock_irqsave(host_set lock)
2331 * Associated ATA device, or %NULL if not found.
2334 static struct ata_device *
2335 ata_scsi_find_dev(struct ata_port *ap, const struct scsi_device *scsidev)
2337 struct ata_device *dev;
2339 /* skip commands not addressed to targets we simulate */
2340 if (likely(scsidev->id < ATA_MAX_DEVICES))
2341 dev = &ap->device[scsidev->id];
2345 if (unlikely((scsidev->channel != 0) ||
2346 (scsidev->lun != 0)))
2349 if (unlikely(!ata_dev_present(dev)))
2352 if (!atapi_enabled || (ap->flags & ATA_FLAG_NO_ATAPI)) {
2353 if (unlikely(dev->class == ATA_DEV_ATAPI)) {
2354 printk(KERN_WARNING "ata%u(%u): WARNING: ATAPI is %s, device ignored.\n",
2355 ap->id, dev->devno, atapi_enabled ? "not supported with this driver" : "disabled");
2364 * ata_scsi_map_proto - Map pass-thru protocol value to taskfile value.
2365 * @byte1: Byte 1 from pass-thru CDB.
2368 * ATA_PROT_UNKNOWN if mapping failed/unimplemented, protocol otherwise.
2371 ata_scsi_map_proto(u8 byte1)
2373 switch((byte1 & 0x1e) >> 1) {
2374 case 3: /* Non-data */
2375 return ATA_PROT_NODATA;
2378 return ATA_PROT_DMA;
2380 case 4: /* PIO Data-in */
2381 case 5: /* PIO Data-out */
2383 return ATA_PROT_PIO_MULT;
2385 return ATA_PROT_PIO;
2387 case 10: /* Device Reset */
2388 case 0: /* Hard Reset */
2390 case 2: /* Bus Idle */
2391 case 7: /* Packet */
2392 case 8: /* DMA Queued */
2393 case 9: /* Device Diagnostic */
2394 case 11: /* UDMA Data-in */
2395 case 12: /* UDMA Data-Out */
2396 case 13: /* FPDMA */
2397 default: /* Reserved */
2401 return ATA_PROT_UNKNOWN;
2405 * ata_scsi_pass_thru - convert ATA pass-thru CDB to taskfile
2406 * @qc: command structure to be initialized
2407 * @scsicmd: SCSI command to convert
2409 * Handles either 12 or 16-byte versions of the CDB.
2412 * Zero on success, non-zero on failure.
2415 ata_scsi_pass_thru(struct ata_queued_cmd *qc, const u8 *scsicmd)
2417 struct ata_taskfile *tf = &(qc->tf);
2418 struct scsi_cmnd *cmd = qc->scsicmd;
2420 if ((tf->protocol = ata_scsi_map_proto(scsicmd[1])) == ATA_PROT_UNKNOWN)
2424 * 12 and 16 byte CDBs use different offsets to
2425 * provide the various register values.
2427 if (scsicmd[0] == ATA_16) {
2429 * 16-byte CDB - may contain extended commands.
2431 * If that is the case, copy the upper byte register values.
2433 if (scsicmd[1] & 0x01) {
2434 tf->hob_feature = scsicmd[3];
2435 tf->hob_nsect = scsicmd[5];
2436 tf->hob_lbal = scsicmd[7];
2437 tf->hob_lbam = scsicmd[9];
2438 tf->hob_lbah = scsicmd[11];
2439 tf->flags |= ATA_TFLAG_LBA48;
2441 tf->flags &= ~ATA_TFLAG_LBA48;
2444 * Always copy low byte, device and command registers.
2446 tf->feature = scsicmd[4];
2447 tf->nsect = scsicmd[6];
2448 tf->lbal = scsicmd[8];
2449 tf->lbam = scsicmd[10];
2450 tf->lbah = scsicmd[12];
2451 tf->device = scsicmd[13];
2452 tf->command = scsicmd[14];
2455 * 12-byte CDB - incapable of extended commands.
2457 tf->flags &= ~ATA_TFLAG_LBA48;
2459 tf->feature = scsicmd[3];
2460 tf->nsect = scsicmd[4];
2461 tf->lbal = scsicmd[5];
2462 tf->lbam = scsicmd[6];
2463 tf->lbah = scsicmd[7];
2464 tf->device = scsicmd[8];
2465 tf->command = scsicmd[9];
2468 * If slave is possible, enforce correct master/slave bit
2470 if (qc->ap->flags & ATA_FLAG_SLAVE_POSS)
2471 tf->device = qc->dev->devno ?
2472 tf->device | ATA_DEV1 : tf->device & ~ATA_DEV1;
2475 * Filter SET_FEATURES - XFER MODE command -- otherwise,
2476 * SET_FEATURES - XFER MODE must be preceded/succeeded
2477 * by an update to hardware-specific registers for each
2478 * controller (i.e. the reason for ->set_piomode(),
2479 * ->set_dmamode(), and ->post_set_mode() hooks).
2481 if ((tf->command == ATA_CMD_SET_FEATURES)
2482 && (tf->feature == SETFEATURES_XFER))
2486 * Set flags so that all registers will be written,
2487 * and pass on write indication (used for PIO/DMA
2490 tf->flags |= (ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE);
2492 if (cmd->sc_data_direction == DMA_TO_DEVICE)
2493 tf->flags |= ATA_TFLAG_WRITE;
2496 * Set transfer length.
2498 * TODO: find out if we need to do more here to
2499 * cover scatter/gather case.
2501 qc->nsect = cmd->bufflen / ATA_SECT_SIZE;
2506 ata_scsi_set_sense(qc->scsicmd, ILLEGAL_REQUEST, 0x24, 0x00);
2507 /* "Invalid field in cdb" */
2512 * ata_get_xlat_func - check if SCSI to ATA translation is possible
2514 * @cmd: SCSI command opcode to consider
2516 * Look up the SCSI command given, and determine whether the
2517 * SCSI command is to be translated or simulated.
2520 * Pointer to translation function if possible, %NULL if not.
2523 static inline ata_xlat_func_t ata_get_xlat_func(struct ata_device *dev, u8 cmd)
2533 return ata_scsi_rw_xlat;
2535 case SYNCHRONIZE_CACHE:
2536 if (ata_try_flush_cache(dev))
2537 return ata_scsi_flush_xlat;
2542 return ata_scsi_verify_xlat;
2546 return ata_scsi_pass_thru;
2549 return ata_scsi_start_stop_xlat;
2556 * ata_scsi_dump_cdb - dump SCSI command contents to dmesg
2557 * @ap: ATA port to which the command was being sent
2558 * @cmd: SCSI command to dump
2560 * Prints the contents of a SCSI command via printk().
2563 static inline void ata_scsi_dump_cdb(struct ata_port *ap,
2564 struct scsi_cmnd *cmd)
2567 struct scsi_device *scsidev = cmd->device;
2568 u8 *scsicmd = cmd->cmnd;
2570 DPRINTK("CDB (%u:%d,%d,%d) %02x %02x %02x %02x %02x %02x %02x %02x %02x\n",
2572 scsidev->channel, scsidev->id, scsidev->lun,
2573 scsicmd[0], scsicmd[1], scsicmd[2], scsicmd[3],
2574 scsicmd[4], scsicmd[5], scsicmd[6], scsicmd[7],
2580 * ata_scsi_queuecmd - Issue SCSI cdb to libata-managed device
2581 * @cmd: SCSI command to be sent
2582 * @done: Completion function, called when command is complete
2584 * In some cases, this function translates SCSI commands into
2585 * ATA taskfiles, and queues the taskfiles to be sent to
2586 * hardware. In other cases, this function simulates a
2587 * SCSI device by evaluating and responding to certain
2588 * SCSI commands. This creates the overall effect of
2589 * ATA and ATAPI devices appearing as SCSI devices.
2592 * Releases scsi-layer-held lock, and obtains host_set lock.
2598 int ata_scsi_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *))
2600 struct ata_port *ap;
2601 struct ata_device *dev;
2602 struct scsi_device *scsidev = cmd->device;
2603 struct Scsi_Host *shost = scsidev->host;
2605 ap = (struct ata_port *) &shost->hostdata[0];
2607 spin_unlock(shost->host_lock);
2608 spin_lock(&ap->host_set->lock);
2610 ata_scsi_dump_cdb(ap, cmd);
2612 dev = ata_scsi_find_dev(ap, scsidev);
2613 if (unlikely(!dev)) {
2614 cmd->result = (DID_BAD_TARGET << 16);
2619 if (dev->class == ATA_DEV_ATA) {
2620 ata_xlat_func_t xlat_func = ata_get_xlat_func(dev,
2624 ata_scsi_translate(ap, dev, cmd, done, xlat_func);
2626 ata_scsi_simulate(ap, dev, cmd, done);
2628 ata_scsi_translate(ap, dev, cmd, done, atapi_xlat);
2631 spin_unlock(&ap->host_set->lock);
2632 spin_lock(shost->host_lock);
2637 * ata_scsi_simulate - simulate SCSI command on ATA device
2638 * @ap: port the device is connected to
2639 * @dev: the target device
2640 * @cmd: SCSI command being sent to device.
2641 * @done: SCSI command completion function.
2643 * Interprets and directly executes a select list of SCSI commands
2644 * that can be handled internally.
2647 * spin_lock_irqsave(host_set lock)
2650 void ata_scsi_simulate(struct ata_port *ap, struct ata_device *dev,
2651 struct scsi_cmnd *cmd,
2652 void (*done)(struct scsi_cmnd *))
2654 struct ata_scsi_args args;
2655 const u8 *scsicmd = cmd->cmnd;
2663 switch(scsicmd[0]) {
2664 /* no-op's, complete with success */
2665 case SYNCHRONIZE_CACHE:
2669 case TEST_UNIT_READY:
2670 case FORMAT_UNIT: /* FIXME: correct? */
2671 case SEND_DIAGNOSTIC: /* FIXME: correct? */
2672 ata_scsi_rbuf_fill(&args, ata_scsiop_noop);
2676 if (scsicmd[1] & 2) /* is CmdDt set? */
2677 ata_scsi_invalid_field(cmd, done);
2678 else if ((scsicmd[1] & 1) == 0) /* is EVPD clear? */
2679 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_std);
2680 else if (scsicmd[2] == 0x00)
2681 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_00);
2682 else if (scsicmd[2] == 0x80)
2683 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_80);
2684 else if (scsicmd[2] == 0x83)
2685 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_83);
2687 ata_scsi_invalid_field(cmd, done);
2692 ata_scsi_rbuf_fill(&args, ata_scsiop_mode_sense);
2695 case MODE_SELECT: /* unconditionally return */
2696 case MODE_SELECT_10: /* bad-field-in-cdb */
2697 ata_scsi_invalid_field(cmd, done);
2701 ata_scsi_rbuf_fill(&args, ata_scsiop_read_cap);
2704 case SERVICE_ACTION_IN:
2705 if ((scsicmd[1] & 0x1f) == SAI_READ_CAPACITY_16)
2706 ata_scsi_rbuf_fill(&args, ata_scsiop_read_cap);
2708 ata_scsi_invalid_field(cmd, done);
2712 ata_scsi_rbuf_fill(&args, ata_scsiop_report_luns);
2715 /* mandatory commands we haven't implemented yet */
2718 /* all other commands */
2720 ata_scsi_set_sense(cmd, ILLEGAL_REQUEST, 0x20, 0x0);
2721 /* "Invalid command operation code" */
2727 void ata_scsi_scan_host(struct ata_port *ap)
2729 struct ata_device *dev;
2732 if (ap->flags & ATA_FLAG_PORT_DISABLED)
2735 for (i = 0; i < ATA_MAX_DEVICES; i++) {
2736 dev = &ap->device[i];
2738 if (ata_dev_present(dev))
2739 scsi_scan_target(&ap->host->shost_gendev, 0, i, 0, 0);