[PATCH] libata irq-pio: add read/write multiple support
[linux-2.6/verdex.git] / drivers / scsi / libata-scsi.c
blobbb30fcdc929763d767ad369267207dff7a624a53
1 /*
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
6 * on emails.
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)
15 * any later version.
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_device.h>
42 #include <scsi/scsi_request.h>
43 #include <linux/libata.h>
44 #include <linux/hdreg.h>
45 #include <asm/uaccess.h>
47 #include "libata.h"
49 #define SECTOR_SIZE 512
51 typedef unsigned int (*ata_xlat_func_t)(struct ata_queued_cmd *qc, const u8 *scsicmd);
52 static struct ata_device *
53 ata_scsi_find_dev(struct ata_port *ap, const struct scsi_device *scsidev);
55 #define RW_RECOVERY_MPAGE 0x1
56 #define RW_RECOVERY_MPAGE_LEN 12
57 #define CACHE_MPAGE 0x8
58 #define CACHE_MPAGE_LEN 20
59 #define CONTROL_MPAGE 0xa
60 #define CONTROL_MPAGE_LEN 12
61 #define ALL_MPAGES 0x3f
62 #define ALL_SUB_MPAGES 0xff
65 static const u8 def_rw_recovery_mpage[] = {
66 RW_RECOVERY_MPAGE,
67 RW_RECOVERY_MPAGE_LEN - 2,
68 (1 << 7) | /* AWRE, sat-r06 say it shall be 0 */
69 (1 << 6), /* ARRE (auto read reallocation) */
70 0, /* read retry count */
71 0, 0, 0, 0,
72 0, /* write retry count */
73 0, 0, 0
76 static const u8 def_cache_mpage[CACHE_MPAGE_LEN] = {
77 CACHE_MPAGE,
78 CACHE_MPAGE_LEN - 2,
79 0, /* contains WCE, needs to be 0 for logic */
80 0, 0, 0, 0, 0, 0, 0, 0, 0,
81 0, /* contains DRA, needs to be 0 for logic */
82 0, 0, 0, 0, 0, 0, 0
85 static const u8 def_control_mpage[CONTROL_MPAGE_LEN] = {
86 CONTROL_MPAGE,
87 CONTROL_MPAGE_LEN - 2,
88 2, /* DSENSE=0, GLTSD=1 */
89 0, /* [QAM+QERR may be 1, see 05-359r1] */
90 0, 0, 0, 0, 0xff, 0xff,
91 0, 30 /* extended self test time, see 05-359r1 */
95 static void ata_scsi_invalid_field(struct scsi_cmnd *cmd,
96 void (*done)(struct scsi_cmnd *))
98 ata_scsi_set_sense(cmd, ILLEGAL_REQUEST, 0x24, 0x0);
99 /* "Invalid field in cbd" */
100 done(cmd);
104 * ata_std_bios_param - generic bios head/sector/cylinder calculator used by sd.
105 * @sdev: SCSI device for which BIOS geometry is to be determined
106 * @bdev: block device associated with @sdev
107 * @capacity: capacity of SCSI device
108 * @geom: location to which geometry will be output
110 * Generic bios head/sector/cylinder calculator
111 * used by sd. Most BIOSes nowadays expect a XXX/255/16 (CHS)
112 * mapping. Some situations may arise where the disk is not
113 * bootable if this is not used.
115 * LOCKING:
116 * Defined by the SCSI layer. We don't really care.
118 * RETURNS:
119 * Zero.
121 int ata_std_bios_param(struct scsi_device *sdev, struct block_device *bdev,
122 sector_t capacity, int geom[])
124 geom[0] = 255;
125 geom[1] = 63;
126 sector_div(capacity, 255*63);
127 geom[2] = capacity;
129 return 0;
133 * ata_cmd_ioctl - Handler for HDIO_DRIVE_CMD ioctl
134 * @scsidev: Device to which we are issuing command
135 * @arg: User provided data for issuing command
137 * LOCKING:
138 * Defined by the SCSI layer. We don't really care.
140 * RETURNS:
141 * Zero on success, negative errno on error.
144 int ata_cmd_ioctl(struct scsi_device *scsidev, void __user *arg)
146 int rc = 0;
147 u8 scsi_cmd[MAX_COMMAND_SIZE];
148 u8 args[4], *argbuf = NULL;
149 int argsize = 0;
150 struct scsi_request *sreq;
152 if (NULL == (void *)arg)
153 return -EINVAL;
155 if (copy_from_user(args, arg, sizeof(args)))
156 return -EFAULT;
158 sreq = scsi_allocate_request(scsidev, GFP_KERNEL);
159 if (!sreq)
160 return -EINTR;
162 memset(scsi_cmd, 0, sizeof(scsi_cmd));
164 if (args[3]) {
165 argsize = SECTOR_SIZE * args[3];
166 argbuf = kmalloc(argsize, GFP_KERNEL);
167 if (argbuf == NULL) {
168 rc = -ENOMEM;
169 goto error;
172 scsi_cmd[1] = (4 << 1); /* PIO Data-in */
173 scsi_cmd[2] = 0x0e; /* no off.line or cc, read from dev,
174 block count in sector count field */
175 sreq->sr_data_direction = DMA_FROM_DEVICE;
176 } else {
177 scsi_cmd[1] = (3 << 1); /* Non-data */
178 /* scsi_cmd[2] is already 0 -- no off.line, cc, or data xfer */
179 sreq->sr_data_direction = DMA_NONE;
182 scsi_cmd[0] = ATA_16;
184 scsi_cmd[4] = args[2];
185 if (args[0] == WIN_SMART) { /* hack -- ide driver does this too... */
186 scsi_cmd[6] = args[3];
187 scsi_cmd[8] = args[1];
188 scsi_cmd[10] = 0x4f;
189 scsi_cmd[12] = 0xc2;
190 } else {
191 scsi_cmd[6] = args[1];
193 scsi_cmd[14] = args[0];
195 /* Good values for timeout and retries? Values below
196 from scsi_ioctl_send_command() for default case... */
197 scsi_wait_req(sreq, scsi_cmd, argbuf, argsize, (10*HZ), 5);
199 if (sreq->sr_result) {
200 rc = -EIO;
201 goto error;
204 /* Need code to retrieve data from check condition? */
206 if ((argbuf)
207 && copy_to_user((void *)(arg + sizeof(args)), argbuf, argsize))
208 rc = -EFAULT;
209 error:
210 scsi_release_request(sreq);
212 if (argbuf)
213 kfree(argbuf);
215 return rc;
219 * ata_task_ioctl - Handler for HDIO_DRIVE_TASK ioctl
220 * @scsidev: Device to which we are issuing command
221 * @arg: User provided data for issuing command
223 * LOCKING:
224 * Defined by the SCSI layer. We don't really care.
226 * RETURNS:
227 * Zero on success, negative errno on error.
229 int ata_task_ioctl(struct scsi_device *scsidev, void __user *arg)
231 int rc = 0;
232 u8 scsi_cmd[MAX_COMMAND_SIZE];
233 u8 args[7];
234 struct scsi_request *sreq;
236 if (NULL == (void *)arg)
237 return -EINVAL;
239 if (copy_from_user(args, arg, sizeof(args)))
240 return -EFAULT;
242 memset(scsi_cmd, 0, sizeof(scsi_cmd));
243 scsi_cmd[0] = ATA_16;
244 scsi_cmd[1] = (3 << 1); /* Non-data */
245 /* scsi_cmd[2] is already 0 -- no off.line, cc, or data xfer */
246 scsi_cmd[4] = args[1];
247 scsi_cmd[6] = args[2];
248 scsi_cmd[8] = args[3];
249 scsi_cmd[10] = args[4];
250 scsi_cmd[12] = args[5];
251 scsi_cmd[14] = args[0];
253 sreq = scsi_allocate_request(scsidev, GFP_KERNEL);
254 if (!sreq) {
255 rc = -EINTR;
256 goto error;
259 sreq->sr_data_direction = DMA_NONE;
260 /* Good values for timeout and retries? Values below
261 from scsi_ioctl_send_command() for default case... */
262 scsi_wait_req(sreq, scsi_cmd, NULL, 0, (10*HZ), 5);
264 if (sreq->sr_result) {
265 rc = -EIO;
266 goto error;
269 /* Need code to retrieve data from check condition? */
271 error:
272 scsi_release_request(sreq);
273 return rc;
276 int ata_scsi_ioctl(struct scsi_device *scsidev, int cmd, void __user *arg)
278 struct ata_port *ap;
279 struct ata_device *dev;
280 int val = -EINVAL, rc = -EINVAL;
282 ap = (struct ata_port *) &scsidev->host->hostdata[0];
283 if (!ap)
284 goto out;
286 dev = ata_scsi_find_dev(ap, scsidev);
287 if (!dev) {
288 rc = -ENODEV;
289 goto out;
292 switch (cmd) {
293 case ATA_IOC_GET_IO32:
294 val = 0;
295 if (copy_to_user(arg, &val, 1))
296 return -EFAULT;
297 return 0;
299 case ATA_IOC_SET_IO32:
300 val = (unsigned long) arg;
301 if (val != 0)
302 return -EINVAL;
303 return 0;
305 case HDIO_DRIVE_CMD:
306 if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
307 return -EACCES;
308 return ata_cmd_ioctl(scsidev, arg);
310 case HDIO_DRIVE_TASK:
311 if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
312 return -EACCES;
313 return ata_task_ioctl(scsidev, arg);
315 default:
316 rc = -ENOTTY;
317 break;
320 out:
321 return rc;
325 * ata_scsi_qc_new - acquire new ata_queued_cmd reference
326 * @ap: ATA port to which the new command is attached
327 * @dev: ATA device to which the new command is attached
328 * @cmd: SCSI command that originated this ATA command
329 * @done: SCSI command completion function
331 * Obtain a reference to an unused ata_queued_cmd structure,
332 * which is the basic libata structure representing a single
333 * ATA command sent to the hardware.
335 * If a command was available, fill in the SCSI-specific
336 * portions of the structure with information on the
337 * current command.
339 * LOCKING:
340 * spin_lock_irqsave(host_set lock)
342 * RETURNS:
343 * Command allocated, or %NULL if none available.
345 struct ata_queued_cmd *ata_scsi_qc_new(struct ata_port *ap,
346 struct ata_device *dev,
347 struct scsi_cmnd *cmd,
348 void (*done)(struct scsi_cmnd *))
350 struct ata_queued_cmd *qc;
352 qc = ata_qc_new_init(ap, dev);
353 if (qc) {
354 qc->scsicmd = cmd;
355 qc->scsidone = done;
357 if (cmd->use_sg) {
358 qc->__sg = (struct scatterlist *) cmd->request_buffer;
359 qc->n_elem = cmd->use_sg;
360 } else {
361 qc->__sg = &qc->sgent;
362 qc->n_elem = 1;
364 } else {
365 cmd->result = (DID_OK << 16) | (QUEUE_FULL << 1);
366 done(cmd);
369 return qc;
373 * ata_dump_status - user friendly display of error info
374 * @id: id of the port in question
375 * @tf: ptr to filled out taskfile
377 * Decode and dump the ATA error/status registers for the user so
378 * that they have some idea what really happened at the non
379 * make-believe layer.
381 * LOCKING:
382 * inherited from caller
384 void ata_dump_status(unsigned id, struct ata_taskfile *tf)
386 u8 stat = tf->command, err = tf->feature;
388 printk(KERN_WARNING "ata%u: status=0x%02x { ", id, stat);
389 if (stat & ATA_BUSY) {
390 printk("Busy }\n"); /* Data is not valid in this case */
391 } else {
392 if (stat & 0x40) printk("DriveReady ");
393 if (stat & 0x20) printk("DeviceFault ");
394 if (stat & 0x10) printk("SeekComplete ");
395 if (stat & 0x08) printk("DataRequest ");
396 if (stat & 0x04) printk("CorrectedError ");
397 if (stat & 0x02) printk("Index ");
398 if (stat & 0x01) printk("Error ");
399 printk("}\n");
401 if (err) {
402 printk(KERN_WARNING "ata%u: error=0x%02x { ", id, err);
403 if (err & 0x04) printk("DriveStatusError ");
404 if (err & 0x80) {
405 if (err & 0x04) printk("BadCRC ");
406 else printk("Sector ");
408 if (err & 0x40) printk("UncorrectableError ");
409 if (err & 0x10) printk("SectorIdNotFound ");
410 if (err & 0x02) printk("TrackZeroNotFound ");
411 if (err & 0x01) printk("AddrMarkNotFound ");
412 printk("}\n");
418 * ata_to_sense_error - convert ATA error to SCSI error
419 * @id: ATA device number
420 * @drv_stat: value contained in ATA status register
421 * @drv_err: value contained in ATA error register
422 * @sk: the sense key we'll fill out
423 * @asc: the additional sense code we'll fill out
424 * @ascq: the additional sense code qualifier we'll fill out
426 * Converts an ATA error into a SCSI error. Fill out pointers to
427 * SK, ASC, and ASCQ bytes for later use in fixed or descriptor
428 * format sense blocks.
430 * LOCKING:
431 * spin_lock_irqsave(host_set lock)
433 void ata_to_sense_error(unsigned id, u8 drv_stat, u8 drv_err, u8 *sk, u8 *asc,
434 u8 *ascq)
436 int i;
438 /* Based on the 3ware driver translation table */
439 static unsigned char sense_table[][4] = {
440 /* BBD|ECC|ID|MAR */
441 {0xd1, ABORTED_COMMAND, 0x00, 0x00}, // Device busy Aborted command
442 /* BBD|ECC|ID */
443 {0xd0, ABORTED_COMMAND, 0x00, 0x00}, // Device busy Aborted command
444 /* ECC|MC|MARK */
445 {0x61, HARDWARE_ERROR, 0x00, 0x00}, // Device fault Hardware error
446 /* ICRC|ABRT */ /* NB: ICRC & !ABRT is BBD */
447 {0x84, ABORTED_COMMAND, 0x47, 0x00}, // Data CRC error SCSI parity error
448 /* MC|ID|ABRT|TRK0|MARK */
449 {0x37, NOT_READY, 0x04, 0x00}, // Unit offline Not ready
450 /* MCR|MARK */
451 {0x09, NOT_READY, 0x04, 0x00}, // Unrecovered disk error Not ready
452 /* Bad address mark */
453 {0x01, MEDIUM_ERROR, 0x13, 0x00}, // Address mark not found Address mark not found for data field
454 /* TRK0 */
455 {0x02, HARDWARE_ERROR, 0x00, 0x00}, // Track 0 not found Hardware error
456 /* Abort & !ICRC */
457 {0x04, ABORTED_COMMAND, 0x00, 0x00}, // Aborted command Aborted command
458 /* Media change request */
459 {0x08, NOT_READY, 0x04, 0x00}, // Media change request FIXME: faking offline
460 /* SRV */
461 {0x10, ABORTED_COMMAND, 0x14, 0x00}, // ID not found Recorded entity not found
462 /* Media change */
463 {0x08, NOT_READY, 0x04, 0x00}, // Media change FIXME: faking offline
464 /* ECC */
465 {0x40, MEDIUM_ERROR, 0x11, 0x04}, // Uncorrectable ECC error Unrecovered read error
466 /* BBD - block marked bad */
467 {0x80, MEDIUM_ERROR, 0x11, 0x04}, // Block marked bad Medium error, unrecovered read error
468 {0xFF, 0xFF, 0xFF, 0xFF}, // END mark
470 static unsigned char stat_table[][4] = {
471 /* Must be first because BUSY means no other bits valid */
472 {0x80, ABORTED_COMMAND, 0x47, 0x00}, // Busy, fake parity for now
473 {0x20, HARDWARE_ERROR, 0x00, 0x00}, // Device fault
474 {0x08, ABORTED_COMMAND, 0x47, 0x00}, // Timed out in xfer, fake parity for now
475 {0x04, RECOVERED_ERROR, 0x11, 0x00}, // Recovered ECC error Medium error, recovered
476 {0xFF, 0xFF, 0xFF, 0xFF}, // END mark
480 * Is this an error we can process/parse
482 if (drv_stat & ATA_BUSY) {
483 drv_err = 0; /* Ignore the err bits, they're invalid */
486 if (drv_err) {
487 /* Look for drv_err */
488 for (i = 0; sense_table[i][0] != 0xFF; i++) {
489 /* Look for best matches first */
490 if ((sense_table[i][0] & drv_err) ==
491 sense_table[i][0]) {
492 *sk = sense_table[i][1];
493 *asc = sense_table[i][2];
494 *ascq = sense_table[i][3];
495 goto translate_done;
498 /* No immediate match */
499 printk(KERN_WARNING "ata%u: no sense translation for "
500 "error 0x%02x\n", id, drv_err);
503 /* Fall back to interpreting status bits */
504 for (i = 0; stat_table[i][0] != 0xFF; i++) {
505 if (stat_table[i][0] & drv_stat) {
506 *sk = stat_table[i][1];
507 *asc = stat_table[i][2];
508 *ascq = stat_table[i][3];
509 goto translate_done;
512 /* No error? Undecoded? */
513 printk(KERN_WARNING "ata%u: no sense translation for status: 0x%02x\n",
514 id, drv_stat);
516 /* For our last chance pick, use medium read error because
517 * it's much more common than an ATA drive telling you a write
518 * has failed.
520 *sk = MEDIUM_ERROR;
521 *asc = 0x11; /* "unrecovered read error" */
522 *ascq = 0x04; /* "auto-reallocation failed" */
524 translate_done:
525 printk(KERN_ERR "ata%u: translated ATA stat/err 0x%02x/%02x to "
526 "SCSI SK/ASC/ASCQ 0x%x/%02x/%02x\n", id, drv_stat, drv_err,
527 *sk, *asc, *ascq);
528 return;
532 * ata_gen_ata_desc_sense - Generate check condition sense block.
533 * @qc: Command that completed.
535 * This function is specific to the ATA descriptor format sense
536 * block specified for the ATA pass through commands. Regardless
537 * of whether the command errored or not, return a sense
538 * block. Copy all controller registers into the sense
539 * block. Clear sense key, ASC & ASCQ if there is no error.
541 * LOCKING:
542 * spin_lock_irqsave(host_set lock)
544 void ata_gen_ata_desc_sense(struct ata_queued_cmd *qc)
546 struct scsi_cmnd *cmd = qc->scsicmd;
547 struct ata_taskfile *tf = &qc->tf;
548 unsigned char *sb = cmd->sense_buffer;
549 unsigned char *desc = sb + 8;
551 memset(sb, 0, SCSI_SENSE_BUFFERSIZE);
553 cmd->result = (DRIVER_SENSE << 24) | SAM_STAT_CHECK_CONDITION;
556 * Read the controller registers.
558 assert(NULL != qc->ap->ops->tf_read);
559 qc->ap->ops->tf_read(qc->ap, tf);
562 * Use ata_to_sense_error() to map status register bits
563 * onto sense key, asc & ascq.
565 if (tf->command & (ATA_BUSY | ATA_DF | ATA_ERR | ATA_DRQ)) {
566 ata_to_sense_error(qc->ap->id, tf->command, tf->feature,
567 &sb[1], &sb[2], &sb[3]);
568 sb[1] &= 0x0f;
572 * Sense data is current and format is descriptor.
574 sb[0] = 0x72;
576 desc[0] = 0x09;
579 * Set length of additional sense data.
580 * Since we only populate descriptor 0, the total
581 * length is the same (fixed) length as descriptor 0.
583 desc[1] = sb[7] = 14;
586 * Copy registers into sense buffer.
588 desc[2] = 0x00;
589 desc[3] = tf->feature; /* == error reg */
590 desc[5] = tf->nsect;
591 desc[7] = tf->lbal;
592 desc[9] = tf->lbam;
593 desc[11] = tf->lbah;
594 desc[12] = tf->device;
595 desc[13] = tf->command; /* == status reg */
598 * Fill in Extend bit, and the high order bytes
599 * if applicable.
601 if (tf->flags & ATA_TFLAG_LBA48) {
602 desc[2] |= 0x01;
603 desc[4] = tf->hob_nsect;
604 desc[6] = tf->hob_lbal;
605 desc[8] = tf->hob_lbam;
606 desc[10] = tf->hob_lbah;
611 * ata_gen_fixed_sense - generate a SCSI fixed sense block
612 * @qc: Command that we are erroring out
614 * Leverage ata_to_sense_error() to give us the codes. Fit our
615 * LBA in here if there's room.
617 * LOCKING:
618 * inherited from caller
620 void ata_gen_fixed_sense(struct ata_queued_cmd *qc)
622 struct scsi_cmnd *cmd = qc->scsicmd;
623 struct ata_taskfile *tf = &qc->tf;
624 unsigned char *sb = cmd->sense_buffer;
626 memset(sb, 0, SCSI_SENSE_BUFFERSIZE);
628 cmd->result = (DRIVER_SENSE << 24) | SAM_STAT_CHECK_CONDITION;
631 * Read the controller registers.
633 assert(NULL != qc->ap->ops->tf_read);
634 qc->ap->ops->tf_read(qc->ap, tf);
637 * Use ata_to_sense_error() to map status register bits
638 * onto sense key, asc & ascq.
640 if (tf->command & (ATA_BUSY | ATA_DF | ATA_ERR | ATA_DRQ)) {
641 ata_to_sense_error(qc->ap->id, tf->command, tf->feature,
642 &sb[2], &sb[12], &sb[13]);
643 sb[2] &= 0x0f;
646 sb[0] = 0x70;
647 sb[7] = 0x0a;
649 if (tf->flags & ATA_TFLAG_LBA48) {
650 /* TODO: find solution for LBA48 descriptors */
653 else if (tf->flags & ATA_TFLAG_LBA) {
654 /* A small (28b) LBA will fit in the 32b info field */
655 sb[0] |= 0x80; /* set valid bit */
656 sb[3] = tf->device & 0x0f;
657 sb[4] = tf->lbah;
658 sb[5] = tf->lbam;
659 sb[6] = tf->lbal;
662 else {
663 /* TODO: C/H/S */
668 * ata_scsi_slave_config - Set SCSI device attributes
669 * @sdev: SCSI device to examine
671 * This is called before we actually start reading
672 * and writing to the device, to configure certain
673 * SCSI mid-layer behaviors.
675 * LOCKING:
676 * Defined by SCSI layer. We don't really care.
679 int ata_scsi_slave_config(struct scsi_device *sdev)
681 sdev->use_10_for_rw = 1;
682 sdev->use_10_for_ms = 1;
684 blk_queue_max_phys_segments(sdev->request_queue, LIBATA_MAX_PRD);
686 if (sdev->id < ATA_MAX_DEVICES) {
687 struct ata_port *ap;
688 struct ata_device *dev;
690 ap = (struct ata_port *) &sdev->host->hostdata[0];
691 dev = &ap->device[sdev->id];
693 /* TODO: 1024 is an arbitrary number, not the
694 * hardware maximum. This should be increased to
695 * 65534 when Jens Axboe's patch for dynamically
696 * determining max_sectors is merged.
698 if ((dev->flags & ATA_DFLAG_LBA48) &&
699 ((dev->flags & ATA_DFLAG_LOCK_SECTORS) == 0)) {
701 * do not overwrite sdev->host->max_sectors, since
702 * other drives on this host may not support LBA48
704 blk_queue_max_sectors(sdev->request_queue, 2048);
708 * SATA DMA transfers must be multiples of 4 byte, so
709 * we need to pad ATAPI transfers using an extra sg.
710 * Decrement max hw segments accordingly.
712 if (dev->class == ATA_DEV_ATAPI) {
713 request_queue_t *q = sdev->request_queue;
714 blk_queue_max_hw_segments(q, q->max_hw_segments - 1);
718 return 0; /* scsi layer doesn't check return value, sigh */
722 * ata_scsi_error - SCSI layer error handler callback
723 * @host: SCSI host on which error occurred
725 * Handles SCSI-layer-thrown error events.
727 * LOCKING:
728 * Inherited from SCSI layer (none, can sleep)
730 * RETURNS:
731 * Zero.
734 int ata_scsi_error(struct Scsi_Host *host)
736 struct ata_port *ap;
738 DPRINTK("ENTER\n");
740 ap = (struct ata_port *) &host->hostdata[0];
741 ap->ops->eng_timeout(ap);
743 /* TODO: this is per-command; when queueing is supported
744 * this code will either change or move to a more
745 * appropriate place
747 host->host_failed--;
748 INIT_LIST_HEAD(&host->eh_cmd_q);
750 DPRINTK("EXIT\n");
751 return 0;
755 * ata_scsi_start_stop_xlat - Translate SCSI START STOP UNIT command
756 * @qc: Storage for translated ATA taskfile
757 * @scsicmd: SCSI command to translate
759 * Sets up an ATA taskfile to issue STANDBY (to stop) or READ VERIFY
760 * (to start). Perhaps these commands should be preceded by
761 * CHECK POWER MODE to see what power mode the device is already in.
762 * [See SAT revision 5 at www.t10.org]
764 * LOCKING:
765 * spin_lock_irqsave(host_set lock)
767 * RETURNS:
768 * Zero on success, non-zero on error.
771 static unsigned int ata_scsi_start_stop_xlat(struct ata_queued_cmd *qc,
772 const u8 *scsicmd)
774 struct ata_taskfile *tf = &qc->tf;
776 tf->flags |= ATA_TFLAG_DEVICE | ATA_TFLAG_ISADDR;
777 tf->protocol = ATA_PROT_NODATA;
778 if (scsicmd[1] & 0x1) {
779 ; /* ignore IMMED bit, violates sat-r05 */
781 if (scsicmd[4] & 0x2)
782 goto invalid_fld; /* LOEJ bit set not supported */
783 if (((scsicmd[4] >> 4) & 0xf) != 0)
784 goto invalid_fld; /* power conditions not supported */
785 if (scsicmd[4] & 0x1) {
786 tf->nsect = 1; /* 1 sector, lba=0 */
788 if (qc->dev->flags & ATA_DFLAG_LBA) {
789 qc->tf.flags |= ATA_TFLAG_LBA;
791 tf->lbah = 0x0;
792 tf->lbam = 0x0;
793 tf->lbal = 0x0;
794 tf->device |= ATA_LBA;
795 } else {
796 /* CHS */
797 tf->lbal = 0x1; /* sect */
798 tf->lbam = 0x0; /* cyl low */
799 tf->lbah = 0x0; /* cyl high */
802 tf->command = ATA_CMD_VERIFY; /* READ VERIFY */
803 } else {
804 tf->nsect = 0; /* time period value (0 implies now) */
805 tf->command = ATA_CMD_STANDBY;
806 /* Consider: ATA STANDBY IMMEDIATE command */
809 * Standby and Idle condition timers could be implemented but that
810 * would require libata to implement the Power condition mode page
811 * and allow the user to change it. Changing mode pages requires
812 * MODE SELECT to be implemented.
815 return 0;
817 invalid_fld:
818 ata_scsi_set_sense(qc->scsicmd, ILLEGAL_REQUEST, 0x24, 0x0);
819 /* "Invalid field in cbd" */
820 return 1;
825 * ata_scsi_flush_xlat - Translate SCSI SYNCHRONIZE CACHE command
826 * @qc: Storage for translated ATA taskfile
827 * @scsicmd: SCSI command to translate (ignored)
829 * Sets up an ATA taskfile to issue FLUSH CACHE or
830 * FLUSH CACHE EXT.
832 * LOCKING:
833 * spin_lock_irqsave(host_set lock)
835 * RETURNS:
836 * Zero on success, non-zero on error.
839 static unsigned int ata_scsi_flush_xlat(struct ata_queued_cmd *qc, const u8 *scsicmd)
841 struct ata_taskfile *tf = &qc->tf;
843 tf->flags |= ATA_TFLAG_DEVICE;
844 tf->protocol = ATA_PROT_NODATA;
846 if ((qc->dev->flags & ATA_DFLAG_LBA48) &&
847 (ata_id_has_flush_ext(qc->dev->id)))
848 tf->command = ATA_CMD_FLUSH_EXT;
849 else
850 tf->command = ATA_CMD_FLUSH;
852 return 0;
856 * scsi_6_lba_len - Get LBA and transfer length
857 * @scsicmd: SCSI command to translate
859 * Calculate LBA and transfer length for 6-byte commands.
861 * RETURNS:
862 * @plba: the LBA
863 * @plen: the transfer length
866 static void scsi_6_lba_len(const u8 *scsicmd, u64 *plba, u32 *plen)
868 u64 lba = 0;
869 u32 len = 0;
871 VPRINTK("six-byte command\n");
873 lba |= ((u64)scsicmd[2]) << 8;
874 lba |= ((u64)scsicmd[3]);
876 len |= ((u32)scsicmd[4]);
878 *plba = lba;
879 *plen = len;
883 * scsi_10_lba_len - Get LBA and transfer length
884 * @scsicmd: SCSI command to translate
886 * Calculate LBA and transfer length for 10-byte commands.
888 * RETURNS:
889 * @plba: the LBA
890 * @plen: the transfer length
893 static void scsi_10_lba_len(const u8 *scsicmd, u64 *plba, u32 *plen)
895 u64 lba = 0;
896 u32 len = 0;
898 VPRINTK("ten-byte command\n");
900 lba |= ((u64)scsicmd[2]) << 24;
901 lba |= ((u64)scsicmd[3]) << 16;
902 lba |= ((u64)scsicmd[4]) << 8;
903 lba |= ((u64)scsicmd[5]);
905 len |= ((u32)scsicmd[7]) << 8;
906 len |= ((u32)scsicmd[8]);
908 *plba = lba;
909 *plen = len;
913 * scsi_16_lba_len - Get LBA and transfer length
914 * @scsicmd: SCSI command to translate
916 * Calculate LBA and transfer length for 16-byte commands.
918 * RETURNS:
919 * @plba: the LBA
920 * @plen: the transfer length
923 static void scsi_16_lba_len(const u8 *scsicmd, u64 *plba, u32 *plen)
925 u64 lba = 0;
926 u32 len = 0;
928 VPRINTK("sixteen-byte command\n");
930 lba |= ((u64)scsicmd[2]) << 56;
931 lba |= ((u64)scsicmd[3]) << 48;
932 lba |= ((u64)scsicmd[4]) << 40;
933 lba |= ((u64)scsicmd[5]) << 32;
934 lba |= ((u64)scsicmd[6]) << 24;
935 lba |= ((u64)scsicmd[7]) << 16;
936 lba |= ((u64)scsicmd[8]) << 8;
937 lba |= ((u64)scsicmd[9]);
939 len |= ((u32)scsicmd[10]) << 24;
940 len |= ((u32)scsicmd[11]) << 16;
941 len |= ((u32)scsicmd[12]) << 8;
942 len |= ((u32)scsicmd[13]);
944 *plba = lba;
945 *plen = len;
949 * ata_scsi_verify_xlat - Translate SCSI VERIFY command into an ATA one
950 * @qc: Storage for translated ATA taskfile
951 * @scsicmd: SCSI command to translate
953 * Converts SCSI VERIFY command to an ATA READ VERIFY command.
955 * LOCKING:
956 * spin_lock_irqsave(host_set lock)
958 * RETURNS:
959 * Zero on success, non-zero on error.
962 static unsigned int ata_scsi_verify_xlat(struct ata_queued_cmd *qc, const u8 *scsicmd)
964 struct ata_taskfile *tf = &qc->tf;
965 struct ata_device *dev = qc->dev;
966 u64 dev_sectors = qc->dev->n_sectors;
967 u64 block;
968 u32 n_block;
970 tf->flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
971 tf->protocol = ATA_PROT_NODATA;
973 if (scsicmd[0] == VERIFY)
974 scsi_10_lba_len(scsicmd, &block, &n_block);
975 else if (scsicmd[0] == VERIFY_16)
976 scsi_16_lba_len(scsicmd, &block, &n_block);
977 else
978 goto invalid_fld;
980 if (!n_block)
981 goto nothing_to_do;
982 if (block >= dev_sectors)
983 goto out_of_range;
984 if ((block + n_block) > dev_sectors)
985 goto out_of_range;
987 if (dev->flags & ATA_DFLAG_LBA) {
988 tf->flags |= ATA_TFLAG_LBA;
990 if (dev->flags & ATA_DFLAG_LBA48) {
991 if (n_block > (64 * 1024))
992 goto invalid_fld;
994 /* use LBA48 */
995 tf->flags |= ATA_TFLAG_LBA48;
996 tf->command = ATA_CMD_VERIFY_EXT;
998 tf->hob_nsect = (n_block >> 8) & 0xff;
1000 tf->hob_lbah = (block >> 40) & 0xff;
1001 tf->hob_lbam = (block >> 32) & 0xff;
1002 tf->hob_lbal = (block >> 24) & 0xff;
1003 } else {
1004 if (n_block > 256)
1005 goto invalid_fld;
1007 /* use LBA28 */
1008 tf->command = ATA_CMD_VERIFY;
1010 tf->device |= (block >> 24) & 0xf;
1013 tf->nsect = n_block & 0xff;
1015 tf->lbah = (block >> 16) & 0xff;
1016 tf->lbam = (block >> 8) & 0xff;
1017 tf->lbal = block & 0xff;
1019 tf->device |= ATA_LBA;
1020 } else {
1021 /* CHS */
1022 u32 sect, head, cyl, track;
1024 if (n_block > 256)
1025 goto invalid_fld;
1027 /* Convert LBA to CHS */
1028 track = (u32)block / dev->sectors;
1029 cyl = track / dev->heads;
1030 head = track % dev->heads;
1031 sect = (u32)block % dev->sectors + 1;
1033 DPRINTK("block %u track %u cyl %u head %u sect %u\n",
1034 (u32)block, track, cyl, head, sect);
1036 /* Check whether the converted CHS can fit.
1037 Cylinder: 0-65535
1038 Head: 0-15
1039 Sector: 1-255*/
1040 if ((cyl >> 16) || (head >> 4) || (sect >> 8) || (!sect))
1041 goto out_of_range;
1043 tf->command = ATA_CMD_VERIFY;
1044 tf->nsect = n_block & 0xff; /* Sector count 0 means 256 sectors */
1045 tf->lbal = sect;
1046 tf->lbam = cyl;
1047 tf->lbah = cyl >> 8;
1048 tf->device |= head;
1051 return 0;
1053 invalid_fld:
1054 ata_scsi_set_sense(qc->scsicmd, ILLEGAL_REQUEST, 0x24, 0x0);
1055 /* "Invalid field in cbd" */
1056 return 1;
1058 out_of_range:
1059 ata_scsi_set_sense(qc->scsicmd, ILLEGAL_REQUEST, 0x21, 0x0);
1060 /* "Logical Block Address out of range" */
1061 return 1;
1063 nothing_to_do:
1064 qc->scsicmd->result = SAM_STAT_GOOD;
1065 return 1;
1069 * ata_scsi_rw_xlat - Translate SCSI r/w command into an ATA one
1070 * @qc: Storage for translated ATA taskfile
1071 * @scsicmd: SCSI command to translate
1073 * Converts any of six SCSI read/write commands into the
1074 * ATA counterpart, including starting sector (LBA),
1075 * sector count, and taking into account the device's LBA48
1076 * support.
1078 * Commands %READ_6, %READ_10, %READ_16, %WRITE_6, %WRITE_10, and
1079 * %WRITE_16 are currently supported.
1081 * LOCKING:
1082 * spin_lock_irqsave(host_set lock)
1084 * RETURNS:
1085 * Zero on success, non-zero on error.
1088 static unsigned int ata_scsi_rw_xlat(struct ata_queued_cmd *qc, const u8 *scsicmd)
1090 struct ata_taskfile *tf = &qc->tf;
1091 struct ata_device *dev = qc->dev;
1092 u64 block;
1093 u32 n_block;
1095 tf->flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
1097 if (scsicmd[0] == WRITE_10 || scsicmd[0] == WRITE_6 ||
1098 scsicmd[0] == WRITE_16)
1099 tf->flags |= ATA_TFLAG_WRITE;
1101 /* Calculate the SCSI LBA and transfer length. */
1102 switch (scsicmd[0]) {
1103 case READ_10:
1104 case WRITE_10:
1105 scsi_10_lba_len(scsicmd, &block, &n_block);
1106 break;
1107 case READ_6:
1108 case WRITE_6:
1109 scsi_6_lba_len(scsicmd, &block, &n_block);
1111 /* for 6-byte r/w commands, transfer length 0
1112 * means 256 blocks of data, not 0 block.
1114 if (!n_block)
1115 n_block = 256;
1116 break;
1117 case READ_16:
1118 case WRITE_16:
1119 scsi_16_lba_len(scsicmd, &block, &n_block);
1120 break;
1121 default:
1122 DPRINTK("no-byte command\n");
1123 goto invalid_fld;
1126 /* Check and compose ATA command */
1127 if (!n_block)
1128 /* For 10-byte and 16-byte SCSI R/W commands, transfer
1129 * length 0 means transfer 0 block of data.
1130 * However, for ATA R/W commands, sector count 0 means
1131 * 256 or 65536 sectors, not 0 sectors as in SCSI.
1133 goto nothing_to_do;
1135 if (dev->flags & ATA_DFLAG_LBA) {
1136 tf->flags |= ATA_TFLAG_LBA;
1138 if (dev->flags & ATA_DFLAG_LBA48) {
1139 /* The request -may- be too large for LBA48. */
1140 if ((block >> 48) || (n_block > 65536))
1141 goto out_of_range;
1143 /* use LBA48 */
1144 tf->flags |= ATA_TFLAG_LBA48;
1146 tf->hob_nsect = (n_block >> 8) & 0xff;
1148 tf->hob_lbah = (block >> 40) & 0xff;
1149 tf->hob_lbam = (block >> 32) & 0xff;
1150 tf->hob_lbal = (block >> 24) & 0xff;
1151 } else {
1152 /* use LBA28 */
1154 /* The request -may- be too large for LBA28. */
1155 if ((block >> 28) || (n_block > 256))
1156 goto out_of_range;
1158 tf->device |= (block >> 24) & 0xf;
1161 ata_rwcmd_protocol(qc);
1163 qc->nsect = n_block;
1164 tf->nsect = n_block & 0xff;
1166 tf->lbah = (block >> 16) & 0xff;
1167 tf->lbam = (block >> 8) & 0xff;
1168 tf->lbal = block & 0xff;
1170 tf->device |= ATA_LBA;
1171 } else {
1172 /* CHS */
1173 u32 sect, head, cyl, track;
1175 /* The request -may- be too large for CHS addressing. */
1176 if ((block >> 28) || (n_block > 256))
1177 goto out_of_range;
1179 ata_rwcmd_protocol(qc);
1181 /* Convert LBA to CHS */
1182 track = (u32)block / dev->sectors;
1183 cyl = track / dev->heads;
1184 head = track % dev->heads;
1185 sect = (u32)block % dev->sectors + 1;
1187 DPRINTK("block %u track %u cyl %u head %u sect %u\n",
1188 (u32)block, track, cyl, head, sect);
1190 /* Check whether the converted CHS can fit.
1191 Cylinder: 0-65535
1192 Head: 0-15
1193 Sector: 1-255*/
1194 if ((cyl >> 16) || (head >> 4) || (sect >> 8) || (!sect))
1195 goto out_of_range;
1197 qc->nsect = n_block;
1198 tf->nsect = n_block & 0xff; /* Sector count 0 means 256 sectors */
1199 tf->lbal = sect;
1200 tf->lbam = cyl;
1201 tf->lbah = cyl >> 8;
1202 tf->device |= head;
1205 return 0;
1207 invalid_fld:
1208 ata_scsi_set_sense(qc->scsicmd, ILLEGAL_REQUEST, 0x24, 0x0);
1209 /* "Invalid field in cbd" */
1210 return 1;
1212 out_of_range:
1213 ata_scsi_set_sense(qc->scsicmd, ILLEGAL_REQUEST, 0x21, 0x0);
1214 /* "Logical Block Address out of range" */
1215 return 1;
1217 nothing_to_do:
1218 qc->scsicmd->result = SAM_STAT_GOOD;
1219 return 1;
1222 static int ata_scsi_qc_complete(struct ata_queued_cmd *qc,
1223 unsigned int err_mask)
1225 struct scsi_cmnd *cmd = qc->scsicmd;
1226 u8 *cdb = cmd->cmnd;
1227 int need_sense = (err_mask != 0);
1229 /* For ATA pass thru (SAT) commands, generate a sense block if
1230 * user mandated it or if there's an error. Note that if we
1231 * generate because the user forced us to, a check condition
1232 * is generated and the ATA register values are returned
1233 * whether the command completed successfully or not. If there
1234 * was no error, SK, ASC and ASCQ will all be zero.
1236 if (((cdb[0] == ATA_16) || (cdb[0] == ATA_12)) &&
1237 ((cdb[2] & 0x20) || need_sense)) {
1238 ata_gen_ata_desc_sense(qc);
1239 } else {
1240 if (!need_sense) {
1241 cmd->result = SAM_STAT_GOOD;
1242 } else {
1243 /* TODO: decide which descriptor format to use
1244 * for 48b LBA devices and call that here
1245 * instead of the fixed desc, which is only
1246 * good for smaller LBA (and maybe CHS?)
1247 * devices.
1249 ata_gen_fixed_sense(qc);
1253 if (need_sense) {
1254 /* The ata_gen_..._sense routines fill in tf */
1255 ata_dump_status(qc->ap->id, &qc->tf);
1258 qc->scsidone(cmd);
1260 return 0;
1264 * ata_scsi_translate - Translate then issue SCSI command to ATA device
1265 * @ap: ATA port to which the command is addressed
1266 * @dev: ATA device to which the command is addressed
1267 * @cmd: SCSI command to execute
1268 * @done: SCSI command completion function
1269 * @xlat_func: Actor which translates @cmd to an ATA taskfile
1271 * Our ->queuecommand() function has decided that the SCSI
1272 * command issued can be directly translated into an ATA
1273 * command, rather than handled internally.
1275 * This function sets up an ata_queued_cmd structure for the
1276 * SCSI command, and sends that ata_queued_cmd to the hardware.
1278 * The xlat_func argument (actor) returns 0 if ready to execute
1279 * ATA command, else 1 to finish translation. If 1 is returned
1280 * then cmd->result (and possibly cmd->sense_buffer) are assumed
1281 * to be set reflecting an error condition or clean (early)
1282 * termination.
1284 * LOCKING:
1285 * spin_lock_irqsave(host_set lock)
1288 static void ata_scsi_translate(struct ata_port *ap, struct ata_device *dev,
1289 struct scsi_cmnd *cmd,
1290 void (*done)(struct scsi_cmnd *),
1291 ata_xlat_func_t xlat_func)
1293 struct ata_queued_cmd *qc;
1294 u8 *scsicmd = cmd->cmnd;
1296 VPRINTK("ENTER\n");
1298 qc = ata_scsi_qc_new(ap, dev, cmd, done);
1299 if (!qc)
1300 goto err_mem;
1302 /* data is present; dma-map it */
1303 if (cmd->sc_data_direction == DMA_FROM_DEVICE ||
1304 cmd->sc_data_direction == DMA_TO_DEVICE) {
1305 if (unlikely(cmd->request_bufflen < 1)) {
1306 printk(KERN_WARNING "ata%u(%u): WARNING: zero len r/w req\n",
1307 ap->id, dev->devno);
1308 goto err_did;
1311 if (cmd->use_sg)
1312 ata_sg_init(qc, cmd->request_buffer, cmd->use_sg);
1313 else
1314 ata_sg_init_one(qc, cmd->request_buffer,
1315 cmd->request_bufflen);
1317 qc->dma_dir = cmd->sc_data_direction;
1320 qc->complete_fn = ata_scsi_qc_complete;
1322 if (xlat_func(qc, scsicmd))
1323 goto early_finish;
1325 /* select device, send command to hardware */
1326 if (ata_qc_issue(qc))
1327 goto err_did;
1329 VPRINTK("EXIT\n");
1330 return;
1332 early_finish:
1333 ata_qc_free(qc);
1334 done(cmd);
1335 DPRINTK("EXIT - early finish (good or error)\n");
1336 return;
1338 err_did:
1339 ata_qc_free(qc);
1340 err_mem:
1341 cmd->result = (DID_ERROR << 16);
1342 done(cmd);
1343 DPRINTK("EXIT - internal\n");
1344 return;
1348 * ata_scsi_rbuf_get - Map response buffer.
1349 * @cmd: SCSI command containing buffer to be mapped.
1350 * @buf_out: Pointer to mapped area.
1352 * Maps buffer contained within SCSI command @cmd.
1354 * LOCKING:
1355 * spin_lock_irqsave(host_set lock)
1357 * RETURNS:
1358 * Length of response buffer.
1361 static unsigned int ata_scsi_rbuf_get(struct scsi_cmnd *cmd, u8 **buf_out)
1363 u8 *buf;
1364 unsigned int buflen;
1366 if (cmd->use_sg) {
1367 struct scatterlist *sg;
1369 sg = (struct scatterlist *) cmd->request_buffer;
1370 buf = kmap_atomic(sg->page, KM_USER0) + sg->offset;
1371 buflen = sg->length;
1372 } else {
1373 buf = cmd->request_buffer;
1374 buflen = cmd->request_bufflen;
1377 *buf_out = buf;
1378 return buflen;
1382 * ata_scsi_rbuf_put - Unmap response buffer.
1383 * @cmd: SCSI command containing buffer to be unmapped.
1384 * @buf: buffer to unmap
1386 * Unmaps response buffer contained within @cmd.
1388 * LOCKING:
1389 * spin_lock_irqsave(host_set lock)
1392 static inline void ata_scsi_rbuf_put(struct scsi_cmnd *cmd, u8 *buf)
1394 if (cmd->use_sg) {
1395 struct scatterlist *sg;
1397 sg = (struct scatterlist *) cmd->request_buffer;
1398 kunmap_atomic(buf - sg->offset, KM_USER0);
1403 * ata_scsi_rbuf_fill - wrapper for SCSI command simulators
1404 * @args: device IDENTIFY data / SCSI command of interest.
1405 * @actor: Callback hook for desired SCSI command simulator
1407 * Takes care of the hard work of simulating a SCSI command...
1408 * Mapping the response buffer, calling the command's handler,
1409 * and handling the handler's return value. This return value
1410 * indicates whether the handler wishes the SCSI command to be
1411 * completed successfully (0), or not (in which case cmd->result
1412 * and sense buffer are assumed to be set).
1414 * LOCKING:
1415 * spin_lock_irqsave(host_set lock)
1418 void ata_scsi_rbuf_fill(struct ata_scsi_args *args,
1419 unsigned int (*actor) (struct ata_scsi_args *args,
1420 u8 *rbuf, unsigned int buflen))
1422 u8 *rbuf;
1423 unsigned int buflen, rc;
1424 struct scsi_cmnd *cmd = args->cmd;
1426 buflen = ata_scsi_rbuf_get(cmd, &rbuf);
1427 memset(rbuf, 0, buflen);
1428 rc = actor(args, rbuf, buflen);
1429 ata_scsi_rbuf_put(cmd, rbuf);
1431 if (rc == 0)
1432 cmd->result = SAM_STAT_GOOD;
1433 args->done(cmd);
1437 * ata_scsiop_inq_std - Simulate INQUIRY command
1438 * @args: device IDENTIFY data / SCSI command of interest.
1439 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1440 * @buflen: Response buffer length.
1442 * Returns standard device identification data associated
1443 * with non-EVPD INQUIRY command output.
1445 * LOCKING:
1446 * spin_lock_irqsave(host_set lock)
1449 unsigned int ata_scsiop_inq_std(struct ata_scsi_args *args, u8 *rbuf,
1450 unsigned int buflen)
1452 u8 hdr[] = {
1453 TYPE_DISK,
1455 0x5, /* claim SPC-3 version compatibility */
1457 95 - 4
1460 /* set scsi removeable (RMB) bit per ata bit */
1461 if (ata_id_removeable(args->id))
1462 hdr[1] |= (1 << 7);
1464 VPRINTK("ENTER\n");
1466 memcpy(rbuf, hdr, sizeof(hdr));
1468 if (buflen > 35) {
1469 memcpy(&rbuf[8], "ATA ", 8);
1470 ata_dev_id_string(args->id, &rbuf[16], ATA_ID_PROD_OFS, 16);
1471 ata_dev_id_string(args->id, &rbuf[32], ATA_ID_FW_REV_OFS, 4);
1472 if (rbuf[32] == 0 || rbuf[32] == ' ')
1473 memcpy(&rbuf[32], "n/a ", 4);
1476 if (buflen > 63) {
1477 const u8 versions[] = {
1478 0x60, /* SAM-3 (no version claimed) */
1480 0x03,
1481 0x20, /* SBC-2 (no version claimed) */
1483 0x02,
1484 0x60 /* SPC-3 (no version claimed) */
1487 memcpy(rbuf + 59, versions, sizeof(versions));
1490 return 0;
1494 * ata_scsiop_inq_00 - Simulate INQUIRY EVPD page 0, list of pages
1495 * @args: device IDENTIFY data / SCSI command of interest.
1496 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1497 * @buflen: Response buffer length.
1499 * Returns list of inquiry EVPD pages available.
1501 * LOCKING:
1502 * spin_lock_irqsave(host_set lock)
1505 unsigned int ata_scsiop_inq_00(struct ata_scsi_args *args, u8 *rbuf,
1506 unsigned int buflen)
1508 const u8 pages[] = {
1509 0x00, /* page 0x00, this page */
1510 0x80, /* page 0x80, unit serial no page */
1511 0x83 /* page 0x83, device ident page */
1513 rbuf[3] = sizeof(pages); /* number of supported EVPD pages */
1515 if (buflen > 6)
1516 memcpy(rbuf + 4, pages, sizeof(pages));
1518 return 0;
1522 * ata_scsiop_inq_80 - Simulate INQUIRY EVPD page 80, device serial number
1523 * @args: device IDENTIFY data / SCSI command of interest.
1524 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1525 * @buflen: Response buffer length.
1527 * Returns ATA device serial number.
1529 * LOCKING:
1530 * spin_lock_irqsave(host_set lock)
1533 unsigned int ata_scsiop_inq_80(struct ata_scsi_args *args, u8 *rbuf,
1534 unsigned int buflen)
1536 const u8 hdr[] = {
1538 0x80, /* this page code */
1540 ATA_SERNO_LEN, /* page len */
1542 memcpy(rbuf, hdr, sizeof(hdr));
1544 if (buflen > (ATA_SERNO_LEN + 4 - 1))
1545 ata_dev_id_string(args->id, (unsigned char *) &rbuf[4],
1546 ATA_ID_SERNO_OFS, ATA_SERNO_LEN);
1548 return 0;
1551 static const char *inq_83_str = "Linux ATA-SCSI simulator";
1554 * ata_scsiop_inq_83 - Simulate INQUIRY EVPD page 83, device identity
1555 * @args: device IDENTIFY data / SCSI command of interest.
1556 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1557 * @buflen: Response buffer length.
1559 * Returns device identification. Currently hardcoded to
1560 * return "Linux ATA-SCSI simulator".
1562 * LOCKING:
1563 * spin_lock_irqsave(host_set lock)
1566 unsigned int ata_scsiop_inq_83(struct ata_scsi_args *args, u8 *rbuf,
1567 unsigned int buflen)
1569 rbuf[1] = 0x83; /* this page code */
1570 rbuf[3] = 4 + strlen(inq_83_str); /* page len */
1572 /* our one and only identification descriptor (vendor-specific) */
1573 if (buflen > (strlen(inq_83_str) + 4 + 4 - 1)) {
1574 rbuf[4 + 0] = 2; /* code set: ASCII */
1575 rbuf[4 + 3] = strlen(inq_83_str);
1576 memcpy(rbuf + 4 + 4, inq_83_str, strlen(inq_83_str));
1579 return 0;
1583 * ata_scsiop_noop - Command handler that simply returns success.
1584 * @args: device IDENTIFY data / SCSI command of interest.
1585 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1586 * @buflen: Response buffer length.
1588 * No operation. Simply returns success to caller, to indicate
1589 * that the caller should successfully complete this SCSI command.
1591 * LOCKING:
1592 * spin_lock_irqsave(host_set lock)
1595 unsigned int ata_scsiop_noop(struct ata_scsi_args *args, u8 *rbuf,
1596 unsigned int buflen)
1598 VPRINTK("ENTER\n");
1599 return 0;
1603 * ata_msense_push - Push data onto MODE SENSE data output buffer
1604 * @ptr_io: (input/output) Location to store more output data
1605 * @last: End of output data buffer
1606 * @buf: Pointer to BLOB being added to output buffer
1607 * @buflen: Length of BLOB
1609 * Store MODE SENSE data on an output buffer.
1611 * LOCKING:
1612 * None.
1615 static void ata_msense_push(u8 **ptr_io, const u8 *last,
1616 const u8 *buf, unsigned int buflen)
1618 u8 *ptr = *ptr_io;
1620 if ((ptr + buflen - 1) > last)
1621 return;
1623 memcpy(ptr, buf, buflen);
1625 ptr += buflen;
1627 *ptr_io = ptr;
1631 * ata_msense_caching - Simulate MODE SENSE caching info page
1632 * @id: device IDENTIFY data
1633 * @ptr_io: (input/output) Location to store more output data
1634 * @last: End of output data buffer
1636 * Generate a caching info page, which conditionally indicates
1637 * write caching to the SCSI layer, depending on device
1638 * capabilities.
1640 * LOCKING:
1641 * None.
1644 static unsigned int ata_msense_caching(u16 *id, u8 **ptr_io,
1645 const u8 *last)
1647 u8 page[CACHE_MPAGE_LEN];
1649 memcpy(page, def_cache_mpage, sizeof(page));
1650 if (ata_id_wcache_enabled(id))
1651 page[2] |= (1 << 2); /* write cache enable */
1652 if (!ata_id_rahead_enabled(id))
1653 page[12] |= (1 << 5); /* disable read ahead */
1655 ata_msense_push(ptr_io, last, page, sizeof(page));
1656 return sizeof(page);
1660 * ata_msense_ctl_mode - Simulate MODE SENSE control mode page
1661 * @dev: Device associated with this MODE SENSE command
1662 * @ptr_io: (input/output) Location to store more output data
1663 * @last: End of output data buffer
1665 * Generate a generic MODE SENSE control mode page.
1667 * LOCKING:
1668 * None.
1671 static unsigned int ata_msense_ctl_mode(u8 **ptr_io, const u8 *last)
1673 ata_msense_push(ptr_io, last, def_control_mpage,
1674 sizeof(def_control_mpage));
1675 return sizeof(def_control_mpage);
1679 * ata_msense_rw_recovery - Simulate MODE SENSE r/w error recovery page
1680 * @dev: Device associated with this MODE SENSE command
1681 * @ptr_io: (input/output) Location to store more output data
1682 * @last: End of output data buffer
1684 * Generate a generic MODE SENSE r/w error recovery page.
1686 * LOCKING:
1687 * None.
1690 static unsigned int ata_msense_rw_recovery(u8 **ptr_io, const u8 *last)
1693 ata_msense_push(ptr_io, last, def_rw_recovery_mpage,
1694 sizeof(def_rw_recovery_mpage));
1695 return sizeof(def_rw_recovery_mpage);
1699 * ata_scsiop_mode_sense - Simulate MODE SENSE 6, 10 commands
1700 * @args: device IDENTIFY data / SCSI command of interest.
1701 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1702 * @buflen: Response buffer length.
1704 * Simulate MODE SENSE commands. Assume this is invoked for direct
1705 * access devices (e.g. disks) only. There should be no block
1706 * descriptor for other device types.
1708 * LOCKING:
1709 * spin_lock_irqsave(host_set lock)
1712 unsigned int ata_scsiop_mode_sense(struct ata_scsi_args *args, u8 *rbuf,
1713 unsigned int buflen)
1715 u8 *scsicmd = args->cmd->cmnd, *p, *last;
1716 const u8 sat_blk_desc[] = {
1717 0, 0, 0, 0, /* number of blocks: sat unspecified */
1719 0, 0x2, 0x0 /* block length: 512 bytes */
1721 u8 pg, spg;
1722 unsigned int ebd, page_control, six_byte, output_len, alloc_len, minlen;
1724 VPRINTK("ENTER\n");
1726 six_byte = (scsicmd[0] == MODE_SENSE);
1727 ebd = !(scsicmd[1] & 0x8); /* dbd bit inverted == edb */
1729 * LLBA bit in msense(10) ignored (compliant)
1732 page_control = scsicmd[2] >> 6;
1733 switch (page_control) {
1734 case 0: /* current */
1735 break; /* supported */
1736 case 3: /* saved */
1737 goto saving_not_supp;
1738 case 1: /* changeable */
1739 case 2: /* defaults */
1740 default:
1741 goto invalid_fld;
1744 if (six_byte) {
1745 output_len = 4 + (ebd ? 8 : 0);
1746 alloc_len = scsicmd[4];
1747 } else {
1748 output_len = 8 + (ebd ? 8 : 0);
1749 alloc_len = (scsicmd[7] << 8) + scsicmd[8];
1751 minlen = (alloc_len < buflen) ? alloc_len : buflen;
1753 p = rbuf + output_len;
1754 last = rbuf + minlen - 1;
1756 pg = scsicmd[2] & 0x3f;
1757 spg = scsicmd[3];
1759 * No mode subpages supported (yet) but asking for _all_
1760 * subpages may be valid
1762 if (spg && (spg != ALL_SUB_MPAGES))
1763 goto invalid_fld;
1765 switch(pg) {
1766 case RW_RECOVERY_MPAGE:
1767 output_len += ata_msense_rw_recovery(&p, last);
1768 break;
1770 case CACHE_MPAGE:
1771 output_len += ata_msense_caching(args->id, &p, last);
1772 break;
1774 case CONTROL_MPAGE: {
1775 output_len += ata_msense_ctl_mode(&p, last);
1776 break;
1779 case ALL_MPAGES:
1780 output_len += ata_msense_rw_recovery(&p, last);
1781 output_len += ata_msense_caching(args->id, &p, last);
1782 output_len += ata_msense_ctl_mode(&p, last);
1783 break;
1785 default: /* invalid page code */
1786 goto invalid_fld;
1789 if (minlen < 1)
1790 return 0;
1791 if (six_byte) {
1792 output_len--;
1793 rbuf[0] = output_len;
1794 if (ebd) {
1795 if (minlen > 3)
1796 rbuf[3] = sizeof(sat_blk_desc);
1797 if (minlen > 11)
1798 memcpy(rbuf + 4, sat_blk_desc,
1799 sizeof(sat_blk_desc));
1801 } else {
1802 output_len -= 2;
1803 rbuf[0] = output_len >> 8;
1804 if (minlen > 1)
1805 rbuf[1] = output_len;
1806 if (ebd) {
1807 if (minlen > 7)
1808 rbuf[7] = sizeof(sat_blk_desc);
1809 if (minlen > 15)
1810 memcpy(rbuf + 8, sat_blk_desc,
1811 sizeof(sat_blk_desc));
1814 return 0;
1816 invalid_fld:
1817 ata_scsi_set_sense(args->cmd, ILLEGAL_REQUEST, 0x24, 0x0);
1818 /* "Invalid field in cbd" */
1819 return 1;
1821 saving_not_supp:
1822 ata_scsi_set_sense(args->cmd, ILLEGAL_REQUEST, 0x39, 0x0);
1823 /* "Saving parameters not supported" */
1824 return 1;
1828 * ata_scsiop_read_cap - Simulate READ CAPACITY[ 16] commands
1829 * @args: device IDENTIFY data / SCSI command of interest.
1830 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1831 * @buflen: Response buffer length.
1833 * Simulate READ CAPACITY commands.
1835 * LOCKING:
1836 * spin_lock_irqsave(host_set lock)
1839 unsigned int ata_scsiop_read_cap(struct ata_scsi_args *args, u8 *rbuf,
1840 unsigned int buflen)
1842 u64 n_sectors;
1843 u32 tmp;
1845 VPRINTK("ENTER\n");
1847 if (ata_id_has_lba(args->id)) {
1848 if (ata_id_has_lba48(args->id))
1849 n_sectors = ata_id_u64(args->id, 100);
1850 else
1851 n_sectors = ata_id_u32(args->id, 60);
1852 } else {
1853 /* CHS default translation */
1854 n_sectors = args->id[1] * args->id[3] * args->id[6];
1856 if (ata_id_current_chs_valid(args->id))
1857 /* CHS current translation */
1858 n_sectors = ata_id_u32(args->id, 57);
1861 n_sectors--; /* ATA TotalUserSectors - 1 */
1863 if (args->cmd->cmnd[0] == READ_CAPACITY) {
1864 if( n_sectors >= 0xffffffffULL )
1865 tmp = 0xffffffff ; /* Return max count on overflow */
1866 else
1867 tmp = n_sectors ;
1869 /* sector count, 32-bit */
1870 rbuf[0] = tmp >> (8 * 3);
1871 rbuf[1] = tmp >> (8 * 2);
1872 rbuf[2] = tmp >> (8 * 1);
1873 rbuf[3] = tmp;
1875 /* sector size */
1876 tmp = ATA_SECT_SIZE;
1877 rbuf[6] = tmp >> 8;
1878 rbuf[7] = tmp;
1880 } else {
1881 /* sector count, 64-bit */
1882 tmp = n_sectors >> (8 * 4);
1883 rbuf[2] = tmp >> (8 * 3);
1884 rbuf[3] = tmp >> (8 * 2);
1885 rbuf[4] = tmp >> (8 * 1);
1886 rbuf[5] = tmp;
1887 tmp = n_sectors;
1888 rbuf[6] = tmp >> (8 * 3);
1889 rbuf[7] = tmp >> (8 * 2);
1890 rbuf[8] = tmp >> (8 * 1);
1891 rbuf[9] = tmp;
1893 /* sector size */
1894 tmp = ATA_SECT_SIZE;
1895 rbuf[12] = tmp >> 8;
1896 rbuf[13] = tmp;
1899 return 0;
1903 * ata_scsiop_report_luns - Simulate REPORT LUNS command
1904 * @args: device IDENTIFY data / SCSI command of interest.
1905 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1906 * @buflen: Response buffer length.
1908 * Simulate REPORT LUNS command.
1910 * LOCKING:
1911 * spin_lock_irqsave(host_set lock)
1914 unsigned int ata_scsiop_report_luns(struct ata_scsi_args *args, u8 *rbuf,
1915 unsigned int buflen)
1917 VPRINTK("ENTER\n");
1918 rbuf[3] = 8; /* just one lun, LUN 0, size 8 bytes */
1920 return 0;
1924 * ata_scsi_set_sense - Set SCSI sense data and status
1925 * @cmd: SCSI request to be handled
1926 * @sk: SCSI-defined sense key
1927 * @asc: SCSI-defined additional sense code
1928 * @ascq: SCSI-defined additional sense code qualifier
1930 * Helper function that builds a valid fixed format, current
1931 * response code and the given sense key (sk), additional sense
1932 * code (asc) and additional sense code qualifier (ascq) with
1933 * a SCSI command status of %SAM_STAT_CHECK_CONDITION and
1934 * DRIVER_SENSE set in the upper bits of scsi_cmnd::result .
1936 * LOCKING:
1937 * Not required
1940 void ata_scsi_set_sense(struct scsi_cmnd *cmd, u8 sk, u8 asc, u8 ascq)
1942 cmd->result = (DRIVER_SENSE << 24) | SAM_STAT_CHECK_CONDITION;
1944 cmd->sense_buffer[0] = 0x70; /* fixed format, current */
1945 cmd->sense_buffer[2] = sk;
1946 cmd->sense_buffer[7] = 18 - 8; /* additional sense length */
1947 cmd->sense_buffer[12] = asc;
1948 cmd->sense_buffer[13] = ascq;
1952 * ata_scsi_badcmd - End a SCSI request with an error
1953 * @cmd: SCSI request to be handled
1954 * @done: SCSI command completion function
1955 * @asc: SCSI-defined additional sense code
1956 * @ascq: SCSI-defined additional sense code qualifier
1958 * Helper function that completes a SCSI command with
1959 * %SAM_STAT_CHECK_CONDITION, with a sense key %ILLEGAL_REQUEST
1960 * and the specified additional sense codes.
1962 * LOCKING:
1963 * spin_lock_irqsave(host_set lock)
1966 void ata_scsi_badcmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *), u8 asc, u8 ascq)
1968 DPRINTK("ENTER\n");
1969 ata_scsi_set_sense(cmd, ILLEGAL_REQUEST, asc, ascq);
1971 done(cmd);
1974 void atapi_request_sense(struct ata_port *ap, struct ata_device *dev,
1975 struct scsi_cmnd *cmd)
1977 DECLARE_COMPLETION(wait);
1978 struct ata_queued_cmd *qc;
1979 unsigned long flags;
1980 int rc;
1982 DPRINTK("ATAPI request sense\n");
1984 qc = ata_qc_new_init(ap, dev);
1985 BUG_ON(qc == NULL);
1987 /* FIXME: is this needed? */
1988 memset(cmd->sense_buffer, 0, sizeof(cmd->sense_buffer));
1990 ata_sg_init_one(qc, cmd->sense_buffer, sizeof(cmd->sense_buffer));
1991 qc->dma_dir = DMA_FROM_DEVICE;
1993 memset(&qc->cdb, 0, ap->cdb_len);
1994 qc->cdb[0] = REQUEST_SENSE;
1995 qc->cdb[4] = SCSI_SENSE_BUFFERSIZE;
1997 qc->tf.flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
1998 qc->tf.command = ATA_CMD_PACKET;
2000 qc->tf.protocol = ATA_PROT_ATAPI;
2001 qc->tf.lbam = (8 * 1024) & 0xff;
2002 qc->tf.lbah = (8 * 1024) >> 8;
2003 qc->nbytes = SCSI_SENSE_BUFFERSIZE;
2005 qc->waiting = &wait;
2006 qc->complete_fn = ata_qc_complete_noop;
2008 spin_lock_irqsave(&ap->host_set->lock, flags);
2009 rc = ata_qc_issue(qc);
2010 spin_unlock_irqrestore(&ap->host_set->lock, flags);
2012 if (rc)
2013 ata_port_disable(ap);
2014 else
2015 wait_for_completion(&wait);
2017 DPRINTK("EXIT\n");
2020 static int atapi_qc_complete(struct ata_queued_cmd *qc, unsigned int err_mask)
2022 struct scsi_cmnd *cmd = qc->scsicmd;
2024 VPRINTK("ENTER, err_mask 0x%X\n", err_mask);
2026 if (unlikely(err_mask & AC_ERR_DEV)) {
2027 DPRINTK("request check condition\n");
2029 /* FIXME: command completion with check condition
2030 * but no sense causes the error handler to run,
2031 * which then issues REQUEST SENSE, fills in the sense
2032 * buffer, and completes the command (for the second
2033 * time). We need to issue REQUEST SENSE some other
2034 * way, to avoid completing the command twice.
2036 cmd->result = SAM_STAT_CHECK_CONDITION;
2038 qc->scsidone(cmd);
2040 return 1;
2043 else if (unlikely(err_mask))
2044 /* FIXME: not quite right; we don't want the
2045 * translation of taskfile registers into
2046 * a sense descriptors, since that's only
2047 * correct for ATA, not ATAPI
2049 ata_gen_ata_desc_sense(qc);
2051 else {
2052 u8 *scsicmd = cmd->cmnd;
2054 if (scsicmd[0] == INQUIRY) {
2055 u8 *buf = NULL;
2056 unsigned int buflen;
2058 buflen = ata_scsi_rbuf_get(cmd, &buf);
2060 /* ATAPI devices typically report zero for their SCSI version,
2061 * and sometimes deviate from the spec WRT response data
2062 * format. If SCSI version is reported as zero like normal,
2063 * then we make the following fixups: 1) Fake MMC-5 version,
2064 * to indicate to the Linux scsi midlayer this is a modern
2065 * device. 2) Ensure response data format / ATAPI information
2066 * are always correct.
2068 /* FIXME: do we ever override EVPD pages and the like, with
2069 * this code?
2071 if (buf[2] == 0) {
2072 buf[2] = 0x5;
2073 buf[3] = 0x32;
2076 ata_scsi_rbuf_put(cmd, buf);
2079 cmd->result = SAM_STAT_GOOD;
2082 qc->scsidone(cmd);
2083 return 0;
2086 * atapi_xlat - Initialize PACKET taskfile
2087 * @qc: command structure to be initialized
2088 * @scsicmd: SCSI CDB associated with this PACKET command
2090 * LOCKING:
2091 * spin_lock_irqsave(host_set lock)
2093 * RETURNS:
2094 * Zero on success, non-zero on failure.
2097 static unsigned int atapi_xlat(struct ata_queued_cmd *qc, const u8 *scsicmd)
2099 struct scsi_cmnd *cmd = qc->scsicmd;
2100 struct ata_device *dev = qc->dev;
2101 int using_pio = (dev->flags & ATA_DFLAG_PIO);
2102 int nodata = (cmd->sc_data_direction == DMA_NONE);
2104 if (!using_pio)
2105 /* Check whether ATAPI DMA is safe */
2106 if (ata_check_atapi_dma(qc))
2107 using_pio = 1;
2109 memcpy(&qc->cdb, scsicmd, qc->ap->cdb_len);
2111 qc->complete_fn = atapi_qc_complete;
2113 qc->tf.flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
2114 if (cmd->sc_data_direction == DMA_TO_DEVICE) {
2115 qc->tf.flags |= ATA_TFLAG_WRITE;
2116 DPRINTK("direction: write\n");
2119 qc->tf.command = ATA_CMD_PACKET;
2121 /* no data, or PIO data xfer */
2122 if (using_pio || nodata) {
2123 if (nodata)
2124 qc->tf.protocol = ATA_PROT_ATAPI_NODATA;
2125 else
2126 qc->tf.protocol = ATA_PROT_ATAPI;
2127 qc->tf.lbam = (8 * 1024) & 0xff;
2128 qc->tf.lbah = (8 * 1024) >> 8;
2131 /* DMA data xfer */
2132 else {
2133 qc->tf.protocol = ATA_PROT_ATAPI_DMA;
2134 qc->tf.feature |= ATAPI_PKT_DMA;
2136 #ifdef ATAPI_ENABLE_DMADIR
2137 /* some SATA bridges need us to indicate data xfer direction */
2138 if (cmd->sc_data_direction != DMA_TO_DEVICE)
2139 qc->tf.feature |= ATAPI_DMADIR;
2140 #endif
2143 qc->nbytes = cmd->bufflen;
2145 return 0;
2149 * ata_scsi_find_dev - lookup ata_device from scsi_cmnd
2150 * @ap: ATA port to which the device is attached
2151 * @scsidev: SCSI device from which we derive the ATA device
2153 * Given various information provided in struct scsi_cmnd,
2154 * map that onto an ATA bus, and using that mapping
2155 * determine which ata_device is associated with the
2156 * SCSI command to be sent.
2158 * LOCKING:
2159 * spin_lock_irqsave(host_set lock)
2161 * RETURNS:
2162 * Associated ATA device, or %NULL if not found.
2165 static struct ata_device *
2166 ata_scsi_find_dev(struct ata_port *ap, const struct scsi_device *scsidev)
2168 struct ata_device *dev;
2170 /* skip commands not addressed to targets we simulate */
2171 if (likely(scsidev->id < ATA_MAX_DEVICES))
2172 dev = &ap->device[scsidev->id];
2173 else
2174 return NULL;
2176 if (unlikely((scsidev->channel != 0) ||
2177 (scsidev->lun != 0)))
2178 return NULL;
2180 if (unlikely(!ata_dev_present(dev)))
2181 return NULL;
2183 if (!atapi_enabled) {
2184 if (unlikely(dev->class == ATA_DEV_ATAPI))
2185 return NULL;
2188 return dev;
2192 * ata_scsi_map_proto - Map pass-thru protocol value to taskfile value.
2193 * @byte1: Byte 1 from pass-thru CDB.
2195 * RETURNS:
2196 * ATA_PROT_UNKNOWN if mapping failed/unimplemented, protocol otherwise.
2198 static u8
2199 ata_scsi_map_proto(u8 byte1)
2201 switch((byte1 & 0x1e) >> 1) {
2202 case 3: /* Non-data */
2203 return ATA_PROT_NODATA;
2205 case 6: /* DMA */
2206 return ATA_PROT_DMA;
2208 case 4: /* PIO Data-in */
2209 case 5: /* PIO Data-out */
2210 if (byte1 & 0xe0) {
2211 return ATA_PROT_PIO_MULT;
2213 return ATA_PROT_PIO;
2215 case 10: /* Device Reset */
2216 case 0: /* Hard Reset */
2217 case 1: /* SRST */
2218 case 2: /* Bus Idle */
2219 case 7: /* Packet */
2220 case 8: /* DMA Queued */
2221 case 9: /* Device Diagnostic */
2222 case 11: /* UDMA Data-in */
2223 case 12: /* UDMA Data-Out */
2224 case 13: /* FPDMA */
2225 default: /* Reserved */
2226 break;
2229 return ATA_PROT_UNKNOWN;
2233 * ata_scsi_pass_thru - convert ATA pass-thru CDB to taskfile
2234 * @qc: command structure to be initialized
2235 * @scsicmd: SCSI command to convert
2237 * Handles either 12 or 16-byte versions of the CDB.
2239 * RETURNS:
2240 * Zero on success, non-zero on failure.
2242 static unsigned int
2243 ata_scsi_pass_thru(struct ata_queued_cmd *qc, const u8 *scsicmd)
2245 struct ata_taskfile *tf = &(qc->tf);
2246 struct scsi_cmnd *cmd = qc->scsicmd;
2248 if ((tf->protocol = ata_scsi_map_proto(scsicmd[1])) == ATA_PROT_UNKNOWN)
2249 return 1;
2252 * 12 and 16 byte CDBs use different offsets to
2253 * provide the various register values.
2255 if (scsicmd[0] == ATA_16) {
2257 * 16-byte CDB - may contain extended commands.
2259 * If that is the case, copy the upper byte register values.
2261 if (scsicmd[1] & 0x01) {
2262 tf->hob_feature = scsicmd[3];
2263 tf->hob_nsect = scsicmd[5];
2264 tf->hob_lbal = scsicmd[7];
2265 tf->hob_lbam = scsicmd[9];
2266 tf->hob_lbah = scsicmd[11];
2267 tf->flags |= ATA_TFLAG_LBA48;
2268 } else
2269 tf->flags &= ~ATA_TFLAG_LBA48;
2272 * Always copy low byte, device and command registers.
2274 tf->feature = scsicmd[4];
2275 tf->nsect = scsicmd[6];
2276 tf->lbal = scsicmd[8];
2277 tf->lbam = scsicmd[10];
2278 tf->lbah = scsicmd[12];
2279 tf->device = scsicmd[13];
2280 tf->command = scsicmd[14];
2281 } else {
2283 * 12-byte CDB - incapable of extended commands.
2285 tf->flags &= ~ATA_TFLAG_LBA48;
2287 tf->feature = scsicmd[3];
2288 tf->nsect = scsicmd[4];
2289 tf->lbal = scsicmd[5];
2290 tf->lbam = scsicmd[6];
2291 tf->lbah = scsicmd[7];
2292 tf->device = scsicmd[8];
2293 tf->command = scsicmd[9];
2297 * Filter SET_FEATURES - XFER MODE command -- otherwise,
2298 * SET_FEATURES - XFER MODE must be preceded/succeeded
2299 * by an update to hardware-specific registers for each
2300 * controller (i.e. the reason for ->set_piomode(),
2301 * ->set_dmamode(), and ->post_set_mode() hooks).
2303 if ((tf->command == ATA_CMD_SET_FEATURES)
2304 && (tf->feature == SETFEATURES_XFER))
2305 return 1;
2308 * Set flags so that all registers will be written,
2309 * and pass on write indication (used for PIO/DMA
2310 * setup.)
2312 tf->flags |= (ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE);
2314 if (cmd->sc_data_direction == DMA_TO_DEVICE)
2315 tf->flags |= ATA_TFLAG_WRITE;
2318 * Set transfer length.
2320 * TODO: find out if we need to do more here to
2321 * cover scatter/gather case.
2323 qc->nsect = cmd->bufflen / ATA_SECT_SIZE;
2325 return 0;
2329 * ata_get_xlat_func - check if SCSI to ATA translation is possible
2330 * @dev: ATA device
2331 * @cmd: SCSI command opcode to consider
2333 * Look up the SCSI command given, and determine whether the
2334 * SCSI command is to be translated or simulated.
2336 * RETURNS:
2337 * Pointer to translation function if possible, %NULL if not.
2340 static inline ata_xlat_func_t ata_get_xlat_func(struct ata_device *dev, u8 cmd)
2342 switch (cmd) {
2343 case READ_6:
2344 case READ_10:
2345 case READ_16:
2347 case WRITE_6:
2348 case WRITE_10:
2349 case WRITE_16:
2350 return ata_scsi_rw_xlat;
2352 case SYNCHRONIZE_CACHE:
2353 if (ata_try_flush_cache(dev))
2354 return ata_scsi_flush_xlat;
2355 break;
2357 case VERIFY:
2358 case VERIFY_16:
2359 return ata_scsi_verify_xlat;
2361 case ATA_12:
2362 case ATA_16:
2363 return ata_scsi_pass_thru;
2365 case START_STOP:
2366 return ata_scsi_start_stop_xlat;
2369 return NULL;
2373 * ata_scsi_dump_cdb - dump SCSI command contents to dmesg
2374 * @ap: ATA port to which the command was being sent
2375 * @cmd: SCSI command to dump
2377 * Prints the contents of a SCSI command via printk().
2380 static inline void ata_scsi_dump_cdb(struct ata_port *ap,
2381 struct scsi_cmnd *cmd)
2383 #ifdef ATA_DEBUG
2384 struct scsi_device *scsidev = cmd->device;
2385 u8 *scsicmd = cmd->cmnd;
2387 DPRINTK("CDB (%u:%d,%d,%d) %02x %02x %02x %02x %02x %02x %02x %02x %02x\n",
2388 ap->id,
2389 scsidev->channel, scsidev->id, scsidev->lun,
2390 scsicmd[0], scsicmd[1], scsicmd[2], scsicmd[3],
2391 scsicmd[4], scsicmd[5], scsicmd[6], scsicmd[7],
2392 scsicmd[8]);
2393 #endif
2397 * ata_scsi_queuecmd - Issue SCSI cdb to libata-managed device
2398 * @cmd: SCSI command to be sent
2399 * @done: Completion function, called when command is complete
2401 * In some cases, this function translates SCSI commands into
2402 * ATA taskfiles, and queues the taskfiles to be sent to
2403 * hardware. In other cases, this function simulates a
2404 * SCSI device by evaluating and responding to certain
2405 * SCSI commands. This creates the overall effect of
2406 * ATA and ATAPI devices appearing as SCSI devices.
2408 * LOCKING:
2409 * Releases scsi-layer-held lock, and obtains host_set lock.
2411 * RETURNS:
2412 * Zero.
2415 int ata_scsi_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *))
2417 struct ata_port *ap;
2418 struct ata_device *dev;
2419 struct scsi_device *scsidev = cmd->device;
2420 struct Scsi_Host *shost = scsidev->host;
2422 ap = (struct ata_port *) &shost->hostdata[0];
2424 spin_unlock(shost->host_lock);
2425 spin_lock(&ap->host_set->lock);
2427 ata_scsi_dump_cdb(ap, cmd);
2429 dev = ata_scsi_find_dev(ap, scsidev);
2430 if (unlikely(!dev)) {
2431 cmd->result = (DID_BAD_TARGET << 16);
2432 done(cmd);
2433 goto out_unlock;
2436 if (dev->class == ATA_DEV_ATA) {
2437 ata_xlat_func_t xlat_func = ata_get_xlat_func(dev,
2438 cmd->cmnd[0]);
2440 if (xlat_func)
2441 ata_scsi_translate(ap, dev, cmd, done, xlat_func);
2442 else
2443 ata_scsi_simulate(dev->id, cmd, done);
2444 } else
2445 ata_scsi_translate(ap, dev, cmd, done, atapi_xlat);
2447 out_unlock:
2448 spin_unlock(&ap->host_set->lock);
2449 spin_lock(shost->host_lock);
2450 return 0;
2454 * ata_scsi_simulate - simulate SCSI command on ATA device
2455 * @id: current IDENTIFY data for target device.
2456 * @cmd: SCSI command being sent to device.
2457 * @done: SCSI command completion function.
2459 * Interprets and directly executes a select list of SCSI commands
2460 * that can be handled internally.
2462 * LOCKING:
2463 * spin_lock_irqsave(host_set lock)
2466 void ata_scsi_simulate(u16 *id,
2467 struct scsi_cmnd *cmd,
2468 void (*done)(struct scsi_cmnd *))
2470 struct ata_scsi_args args;
2471 const u8 *scsicmd = cmd->cmnd;
2473 args.id = id;
2474 args.cmd = cmd;
2475 args.done = done;
2477 switch(scsicmd[0]) {
2478 /* no-op's, complete with success */
2479 case SYNCHRONIZE_CACHE:
2480 case REZERO_UNIT:
2481 case SEEK_6:
2482 case SEEK_10:
2483 case TEST_UNIT_READY:
2484 case FORMAT_UNIT: /* FIXME: correct? */
2485 case SEND_DIAGNOSTIC: /* FIXME: correct? */
2486 ata_scsi_rbuf_fill(&args, ata_scsiop_noop);
2487 break;
2489 case INQUIRY:
2490 if (scsicmd[1] & 2) /* is CmdDt set? */
2491 ata_scsi_invalid_field(cmd, done);
2492 else if ((scsicmd[1] & 1) == 0) /* is EVPD clear? */
2493 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_std);
2494 else if (scsicmd[2] == 0x00)
2495 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_00);
2496 else if (scsicmd[2] == 0x80)
2497 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_80);
2498 else if (scsicmd[2] == 0x83)
2499 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_83);
2500 else
2501 ata_scsi_invalid_field(cmd, done);
2502 break;
2504 case MODE_SENSE:
2505 case MODE_SENSE_10:
2506 ata_scsi_rbuf_fill(&args, ata_scsiop_mode_sense);
2507 break;
2509 case MODE_SELECT: /* unconditionally return */
2510 case MODE_SELECT_10: /* bad-field-in-cdb */
2511 ata_scsi_invalid_field(cmd, done);
2512 break;
2514 case READ_CAPACITY:
2515 ata_scsi_rbuf_fill(&args, ata_scsiop_read_cap);
2516 break;
2518 case SERVICE_ACTION_IN:
2519 if ((scsicmd[1] & 0x1f) == SAI_READ_CAPACITY_16)
2520 ata_scsi_rbuf_fill(&args, ata_scsiop_read_cap);
2521 else
2522 ata_scsi_invalid_field(cmd, done);
2523 break;
2525 case REPORT_LUNS:
2526 ata_scsi_rbuf_fill(&args, ata_scsiop_report_luns);
2527 break;
2529 /* mandatory commands we haven't implemented yet */
2530 case REQUEST_SENSE:
2532 /* all other commands */
2533 default:
2534 ata_scsi_set_sense(cmd, ILLEGAL_REQUEST, 0x20, 0x0);
2535 /* "Invalid command operation code" */
2536 done(cmd);
2537 break;
2541 void ata_scsi_scan_host(struct ata_port *ap)
2543 struct ata_device *dev;
2544 unsigned int i;
2546 if (ap->flags & ATA_FLAG_PORT_DISABLED)
2547 return;
2549 for (i = 0; i < ATA_MAX_DEVICES; i++) {
2550 dev = &ap->device[i];
2552 if (ata_dev_present(dev))
2553 scsi_scan_target(&ap->host->shost_gendev, 0, i, 0, 0);