libata: irq-pio build fixes
[linux-2.6/zen-sources.git] / drivers / scsi / libata-scsi.c
blobccedb4536977af454a6c95a613fefc4a292d3e83
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_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>
48 #include "libata.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[] = {
67 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 */
72 0, 0, 0, 0,
73 0, /* write retry count */
74 0, 0, 0
77 static const u8 def_cache_mpage[CACHE_MPAGE_LEN] = {
78 CACHE_MPAGE,
79 CACHE_MPAGE_LEN - 2,
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 */
83 0, 0, 0, 0, 0, 0, 0
86 static const u8 def_control_mpage[CONTROL_MPAGE_LEN] = {
87 CONTROL_MPAGE,
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" */
101 done(cmd);
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.
116 * LOCKING:
117 * Defined by the SCSI layer. We don't really care.
119 * RETURNS:
120 * Zero.
122 int ata_std_bios_param(struct scsi_device *sdev, struct block_device *bdev,
123 sector_t capacity, int geom[])
125 geom[0] = 255;
126 geom[1] = 63;
127 sector_div(capacity, 255*63);
128 geom[2] = capacity;
130 return 0;
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
138 * LOCKING:
139 * Defined by the SCSI layer. We don't really care.
141 * RETURNS:
142 * Zero on success, negative errno on error.
145 int ata_cmd_ioctl(struct scsi_device *scsidev, void __user *arg)
147 int rc = 0;
148 u8 scsi_cmd[MAX_COMMAND_SIZE];
149 u8 args[4], *argbuf = NULL;
150 int argsize = 0;
151 struct scsi_sense_hdr sshdr;
152 enum dma_data_direction data_dir;
154 if (arg == NULL)
155 return -EINVAL;
157 if (copy_from_user(args, arg, sizeof(args)))
158 return -EFAULT;
160 memset(scsi_cmd, 0, sizeof(scsi_cmd));
162 if (args[3]) {
163 argsize = SECTOR_SIZE * args[3];
164 argbuf = kmalloc(argsize, GFP_KERNEL);
165 if (argbuf == NULL) {
166 rc = -ENOMEM;
167 goto error;
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;
174 } else {
175 scsi_cmd[1] = (3 << 1); /* Non-data */
176 /* scsi_cmd[2] is already 0 -- no off.line, cc, or data xfer */
177 data_dir = DMA_NONE;
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];
186 scsi_cmd[10] = 0x4f;
187 scsi_cmd[12] = 0xc2;
188 } else {
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)) {
197 rc = -EIO;
198 goto error;
201 /* Need code to retrieve data from check condition? */
203 if ((argbuf)
204 && copy_to_user(arg + sizeof(args), argbuf, argsize))
205 rc = -EFAULT;
206 error:
207 if (argbuf)
208 kfree(argbuf);
210 return rc;
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
218 * LOCKING:
219 * Defined by the SCSI layer. We don't really care.
221 * RETURNS:
222 * Zero on success, negative errno on error.
224 int ata_task_ioctl(struct scsi_device *scsidev, void __user *arg)
226 int rc = 0;
227 u8 scsi_cmd[MAX_COMMAND_SIZE];
228 u8 args[7];
229 struct scsi_sense_hdr sshdr;
231 if (arg == NULL)
232 return -EINVAL;
234 if (copy_from_user(args, arg, sizeof(args)))
235 return -EFAULT;
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,
251 (10*HZ), 5))
252 rc = -EIO;
254 /* Need code to retrieve data from check condition? */
255 return rc;
258 int ata_scsi_ioctl(struct scsi_device *scsidev, int cmd, void __user *arg)
260 struct ata_port *ap;
261 struct ata_device *dev;
262 int val = -EINVAL, rc = -EINVAL;
264 ap = (struct ata_port *) &scsidev->host->hostdata[0];
265 if (!ap)
266 goto out;
268 dev = ata_scsi_find_dev(ap, scsidev);
269 if (!dev) {
270 rc = -ENODEV;
271 goto out;
274 switch (cmd) {
275 case ATA_IOC_GET_IO32:
276 val = 0;
277 if (copy_to_user(arg, &val, 1))
278 return -EFAULT;
279 return 0;
281 case ATA_IOC_SET_IO32:
282 val = (unsigned long) arg;
283 if (val != 0)
284 return -EINVAL;
285 return 0;
287 case HDIO_DRIVE_CMD:
288 if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
289 return -EACCES;
290 return ata_cmd_ioctl(scsidev, arg);
292 case HDIO_DRIVE_TASK:
293 if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
294 return -EACCES;
295 return ata_task_ioctl(scsidev, arg);
297 default:
298 rc = -ENOTTY;
299 break;
302 out:
303 return rc;
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
319 * current command.
321 * LOCKING:
322 * spin_lock_irqsave(host_set lock)
324 * RETURNS:
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);
335 if (qc) {
336 qc->scsicmd = cmd;
337 qc->scsidone = done;
339 if (cmd->use_sg) {
340 qc->__sg = (struct scatterlist *) cmd->request_buffer;
341 qc->n_elem = cmd->use_sg;
342 } else {
343 qc->__sg = &qc->sgent;
344 qc->n_elem = 1;
346 } else {
347 cmd->result = (DID_OK << 16) | (QUEUE_FULL << 1);
348 done(cmd);
351 return qc;
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.
363 * LOCKING:
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 */
373 } else {
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 ");
381 printk("}\n");
383 if (err) {
384 printk(KERN_WARNING "ata%u: error=0x%02x { ", id, err);
385 if (err & 0x04) printk("DriveStatusError ");
386 if (err & 0x80) {
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 ");
394 printk("}\n");
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.
428 * LOCKING:
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,
432 u8 *ascq)
434 int i;
436 /* Based on the 3ware driver translation table */
437 static const unsigned char sense_table[][4] = {
438 /* BBD|ECC|ID|MAR */
439 {0xd1, ABORTED_COMMAND, 0x00, 0x00}, // Device busy Aborted command
440 /* BBD|ECC|ID */
441 {0xd0, ABORTED_COMMAND, 0x00, 0x00}, // Device busy Aborted command
442 /* ECC|MC|MARK */
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
448 /* MCR|MARK */
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
452 /* TRK0 */
453 {0x02, HARDWARE_ERROR, 0x00, 0x00}, // Track 0 not found Hardware error
454 /* Abort & !ICRC */
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
458 /* SRV */
459 {0x10, ABORTED_COMMAND, 0x14, 0x00}, // ID not found Recorded entity not found
460 /* Media change */
461 {0x08, NOT_READY, 0x04, 0x00}, // Media change FIXME: faking offline
462 /* ECC */
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 */
484 if (drv_err) {
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) ==
489 sense_table[i][0]) {
490 *sk = sense_table[i][1];
491 *asc = sense_table[i][2];
492 *ascq = sense_table[i][3];
493 goto translate_done;
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];
507 goto translate_done;
510 /* No error? Undecoded? */
511 printk(KERN_WARNING "ata%u: no sense translation for status: 0x%02x\n",
512 id, drv_stat);
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
516 * has failed.
518 *sk = MEDIUM_ERROR;
519 *asc = 0x11; /* "unrecovered read error" */
520 *ascq = 0x04; /* "auto-reallocation failed" */
522 translate_done:
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,
525 *sk, *asc, *ascq);
526 return;
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.
539 * LOCKING:
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]);
566 sb[1] &= 0x0f;
570 * Sense data is current and format is descriptor.
572 sb[0] = 0x72;
574 desc[0] = 0x09;
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.
586 desc[2] = 0x00;
587 desc[3] = tf->feature; /* == error reg */
588 desc[5] = tf->nsect;
589 desc[7] = tf->lbal;
590 desc[9] = tf->lbam;
591 desc[11] = tf->lbah;
592 desc[12] = tf->device;
593 desc[13] = tf->command; /* == status reg */
596 * Fill in Extend bit, and the high order bytes
597 * if applicable.
599 if (tf->flags & ATA_TFLAG_LBA48) {
600 desc[2] |= 0x01;
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.
615 * LOCKING:
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]);
641 sb[2] &= 0x0f;
644 sb[0] = 0x70;
645 sb[7] = 0x0a;
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;
655 sb[4] = tf->lbah;
656 sb[5] = tf->lbam;
657 sb[6] = tf->lbal;
660 else {
661 /* TODO: C/H/S */
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.
673 * LOCKING:
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) {
685 struct ata_port *ap;
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)
699 max_sectors = 2048;
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
728 * EH_NOT_HANDLED.
730 * LOCKING:
731 * Called from timer context
733 * RETURNS:
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];
740 unsigned long flags;
741 struct ata_queued_cmd *qc;
742 enum scsi_eh_timer_return ret = EH_HANDLED;
744 DPRINTK("ENTER\n");
746 spin_lock_irqsave(&ap->host_set->lock, flags);
747 qc = ata_qc_from_tag(ap, ap->active_tag);
748 if (qc) {
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);
757 return 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.
766 * LOCKING:
767 * Inherited from SCSI layer (none, can sleep)
769 * RETURNS:
770 * Zero.
773 int ata_scsi_error(struct Scsi_Host *host)
775 struct ata_port *ap;
776 unsigned long flags;
778 DPRINTK("ENTER\n");
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);
800 DPRINTK("EXIT\n");
801 return 0;
804 static void ata_eh_scsidone(struct scsi_cmnd *scmd)
806 /* nada */
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;
813 unsigned long flags;
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]
864 * LOCKING:
865 * spin_lock_irqsave(host_set lock)
867 * RETURNS:
868 * Zero on success, non-zero on error.
871 static unsigned int ata_scsi_start_stop_xlat(struct ata_queued_cmd *qc,
872 const u8 *scsicmd)
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;
891 tf->lbah = 0x0;
892 tf->lbam = 0x0;
893 tf->lbal = 0x0;
894 tf->device |= ATA_LBA;
895 } else {
896 /* CHS */
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 */
903 } else {
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.
915 return 0;
917 invalid_fld:
918 ata_scsi_set_sense(qc->scsicmd, ILLEGAL_REQUEST, 0x24, 0x0);
919 /* "Invalid field in cbd" */
920 return 1;
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
930 * FLUSH CACHE EXT.
932 * LOCKING:
933 * spin_lock_irqsave(host_set lock)
935 * RETURNS:
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;
949 else
950 tf->command = ATA_CMD_FLUSH;
952 return 0;
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.
961 * RETURNS:
962 * @plba: the LBA
963 * @plen: the transfer length
966 static void scsi_6_lba_len(const u8 *scsicmd, u64 *plba, u32 *plen)
968 u64 lba = 0;
969 u32 len = 0;
971 VPRINTK("six-byte command\n");
973 lba |= ((u64)scsicmd[2]) << 8;
974 lba |= ((u64)scsicmd[3]);
976 len |= ((u32)scsicmd[4]);
978 *plba = lba;
979 *plen = len;
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.
988 * RETURNS:
989 * @plba: the LBA
990 * @plen: the transfer length
993 static void scsi_10_lba_len(const u8 *scsicmd, u64 *plba, u32 *plen)
995 u64 lba = 0;
996 u32 len = 0;
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]);
1008 *plba = lba;
1009 *plen = len;
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.
1018 * RETURNS:
1019 * @plba: the LBA
1020 * @plen: the transfer length
1023 static void scsi_16_lba_len(const u8 *scsicmd, u64 *plba, u32 *plen)
1025 u64 lba = 0;
1026 u32 len = 0;
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]);
1044 *plba = lba;
1045 *plen = len;
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.
1055 * LOCKING:
1056 * spin_lock_irqsave(host_set lock)
1058 * RETURNS:
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;
1067 u64 block;
1068 u32 n_block;
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);
1077 else
1078 goto invalid_fld;
1080 if (!n_block)
1081 goto nothing_to_do;
1082 if (block >= dev_sectors)
1083 goto out_of_range;
1084 if ((block + n_block) > dev_sectors)
1085 goto out_of_range;
1087 if (dev->flags & ATA_DFLAG_LBA) {
1088 tf->flags |= ATA_TFLAG_LBA;
1090 if (lba_28_ok(block, n_block)) {
1091 /* use LBA28 */
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))
1096 goto out_of_range;
1098 /* use 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;
1107 } else
1108 /* request too large even for LBA48 */
1109 goto out_of_range;
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;
1118 } else {
1119 /* CHS */
1120 u32 sect, head, cyl, track;
1122 if (!lba_28_ok(block, n_block))
1123 goto out_of_range;
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.
1135 Cylinder: 0-65535
1136 Head: 0-15
1137 Sector: 1-255*/
1138 if ((cyl >> 16) || (head >> 4) || (sect >> 8) || (!sect))
1139 goto out_of_range;
1141 tf->command = ATA_CMD_VERIFY;
1142 tf->nsect = n_block & 0xff; /* Sector count 0 means 256 sectors */
1143 tf->lbal = sect;
1144 tf->lbam = cyl;
1145 tf->lbah = cyl >> 8;
1146 tf->device |= head;
1149 return 0;
1151 invalid_fld:
1152 ata_scsi_set_sense(qc->scsicmd, ILLEGAL_REQUEST, 0x24, 0x0);
1153 /* "Invalid field in cbd" */
1154 return 1;
1156 out_of_range:
1157 ata_scsi_set_sense(qc->scsicmd, ILLEGAL_REQUEST, 0x21, 0x0);
1158 /* "Logical Block Address out of range" */
1159 return 1;
1161 nothing_to_do:
1162 qc->scsicmd->result = SAM_STAT_GOOD;
1163 return 1;
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
1174 * support.
1176 * Commands %READ_6, %READ_10, %READ_16, %WRITE_6, %WRITE_10, and
1177 * %WRITE_16 are currently supported.
1179 * LOCKING:
1180 * spin_lock_irqsave(host_set lock)
1182 * RETURNS:
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;
1190 u64 block;
1191 u32 n_block;
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]) {
1201 case READ_10:
1202 case WRITE_10:
1203 scsi_10_lba_len(scsicmd, &block, &n_block);
1204 if (unlikely(scsicmd[1] & (1 << 3)))
1205 tf->flags |= ATA_TFLAG_FUA;
1206 break;
1207 case READ_6:
1208 case WRITE_6:
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.
1214 if (!n_block)
1215 n_block = 256;
1216 break;
1217 case READ_16:
1218 case WRITE_16:
1219 scsi_16_lba_len(scsicmd, &block, &n_block);
1220 if (unlikely(scsicmd[1] & (1 << 3)))
1221 tf->flags |= ATA_TFLAG_FUA;
1222 break;
1223 default:
1224 DPRINTK("no-byte command\n");
1225 goto invalid_fld;
1228 /* Check and compose ATA command */
1229 if (!n_block)
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...
1237 goto nothing_to_do;
1239 if (dev->flags & ATA_DFLAG_LBA) {
1240 tf->flags |= ATA_TFLAG_LBA;
1242 if (lba_28_ok(block, n_block)) {
1243 /* use LBA28 */
1244 tf->device |= (block >> 24) & 0xf;
1245 } else if (lba_48_ok(block, n_block)) {
1246 if (!(dev->flags & ATA_DFLAG_LBA48))
1247 goto out_of_range;
1249 /* use 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;
1257 } else
1258 /* request too large even for LBA48 */
1259 goto out_of_range;
1261 if (unlikely(ata_rwcmd_protocol(qc) < 0))
1262 goto invalid_fld;
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;
1272 } else {
1273 /* CHS */
1274 u32 sect, head, cyl, track;
1276 /* The request -may- be too large for CHS addressing. */
1277 if (!lba_28_ok(block, n_block))
1278 goto out_of_range;
1280 if (unlikely(ata_rwcmd_protocol(qc) < 0))
1281 goto invalid_fld;
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.
1293 Cylinder: 0-65535
1294 Head: 0-15
1295 Sector: 1-255*/
1296 if ((cyl >> 16) || (head >> 4) || (sect >> 8) || (!sect))
1297 goto out_of_range;
1299 qc->nsect = n_block;
1300 tf->nsect = n_block & 0xff; /* Sector count 0 means 256 sectors */
1301 tf->lbal = sect;
1302 tf->lbam = cyl;
1303 tf->lbah = cyl >> 8;
1304 tf->device |= head;
1307 return 0;
1309 invalid_fld:
1310 ata_scsi_set_sense(qc->scsicmd, ILLEGAL_REQUEST, 0x24, 0x0);
1311 /* "Invalid field in cbd" */
1312 return 1;
1314 out_of_range:
1315 ata_scsi_set_sense(qc->scsicmd, ILLEGAL_REQUEST, 0x21, 0x0);
1316 /* "Logical Block Address out of range" */
1317 return 1;
1319 nothing_to_do:
1320 qc->scsicmd->result = SAM_STAT_GOOD;
1321 return 1;
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);
1340 } else {
1341 if (!need_sense) {
1342 cmd->result = SAM_STAT_GOOD;
1343 } else {
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?)
1348 * devices.
1350 ata_gen_fixed_sense(qc);
1354 if (need_sense) {
1355 /* The ata_gen_..._sense routines fill in tf */
1356 ata_dump_status(qc->ap->id, &qc->tf);
1359 qc->scsidone(cmd);
1361 ata_qc_free(qc);
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)
1383 * termination.
1385 * LOCKING:
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;
1397 VPRINTK("ENTER\n");
1399 qc = ata_scsi_qc_new(ap, dev, cmd, done);
1400 if (!qc)
1401 goto err_mem;
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);
1409 goto err_did;
1412 if (cmd->use_sg)
1413 ata_sg_init(qc, cmd->request_buffer, cmd->use_sg);
1414 else
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))
1424 goto early_finish;
1426 /* select device, send command to hardware */
1427 qc->err_mask = ata_qc_issue(qc);
1428 if (qc->err_mask)
1429 ata_qc_complete(qc);
1431 VPRINTK("EXIT\n");
1432 return;
1434 early_finish:
1435 ata_qc_free(qc);
1436 done(cmd);
1437 DPRINTK("EXIT - early finish (good or error)\n");
1438 return;
1440 err_did:
1441 ata_qc_free(qc);
1442 err_mem:
1443 cmd->result = (DID_ERROR << 16);
1444 done(cmd);
1445 DPRINTK("EXIT - internal\n");
1446 return;
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.
1456 * LOCKING:
1457 * spin_lock_irqsave(host_set lock)
1459 * RETURNS:
1460 * Length of response buffer.
1463 static unsigned int ata_scsi_rbuf_get(struct scsi_cmnd *cmd, u8 **buf_out)
1465 u8 *buf;
1466 unsigned int buflen;
1468 if (cmd->use_sg) {
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;
1474 } else {
1475 buf = cmd->request_buffer;
1476 buflen = cmd->request_bufflen;
1479 *buf_out = buf;
1480 return buflen;
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.
1490 * LOCKING:
1491 * spin_lock_irqsave(host_set lock)
1494 static inline void ata_scsi_rbuf_put(struct scsi_cmnd *cmd, u8 *buf)
1496 if (cmd->use_sg) {
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).
1516 * LOCKING:
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))
1524 u8 *rbuf;
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);
1533 if (rc == 0)
1534 cmd->result = SAM_STAT_GOOD;
1535 args->done(cmd);
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-EVPD INQUIRY command output.
1547 * LOCKING:
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)
1554 u8 hdr[] = {
1555 TYPE_DISK,
1557 0x5, /* claim SPC-3 version compatibility */
1559 95 - 4
1562 /* set scsi removeable (RMB) bit per ata bit */
1563 if (ata_id_removeable(args->id))
1564 hdr[1] |= (1 << 7);
1566 VPRINTK("ENTER\n");
1568 memcpy(rbuf, hdr, sizeof(hdr));
1570 if (buflen > 35) {
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);
1578 if (buflen > 63) {
1579 const u8 versions[] = {
1580 0x60, /* SAM-3 (no version claimed) */
1582 0x03,
1583 0x20, /* SBC-2 (no version claimed) */
1585 0x02,
1586 0x60 /* SPC-3 (no version claimed) */
1589 memcpy(rbuf + 59, versions, sizeof(versions));
1592 return 0;
1596 * ata_scsiop_inq_00 - Simulate INQUIRY EVPD 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 EVPD pages available.
1603 * LOCKING:
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 EVPD pages */
1617 if (buflen > 6)
1618 memcpy(rbuf + 4, pages, sizeof(pages));
1620 return 0;
1624 * ata_scsiop_inq_80 - Simulate INQUIRY EVPD 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.
1631 * LOCKING:
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)
1638 const u8 hdr[] = {
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);
1650 return 0;
1653 static const char * const inq_83_str = "Linux ATA-SCSI simulator";
1656 * ata_scsiop_inq_83 - Simulate INQUIRY EVPD page 83, device identity
1657 * @args: device IDENTIFY data / SCSI command of interest.
1658 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1659 * @buflen: Response buffer length.
1661 * Returns device identification. Currently hardcoded to
1662 * return "Linux ATA-SCSI simulator".
1664 * LOCKING:
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)
1671 rbuf[1] = 0x83; /* this page code */
1672 rbuf[3] = 4 + strlen(inq_83_str); /* page len */
1674 /* our one and only identification descriptor (vendor-specific) */
1675 if (buflen > (strlen(inq_83_str) + 4 + 4 - 1)) {
1676 rbuf[4 + 0] = 2; /* code set: ASCII */
1677 rbuf[4 + 3] = strlen(inq_83_str);
1678 memcpy(rbuf + 4 + 4, inq_83_str, strlen(inq_83_str));
1681 return 0;
1685 * ata_scsiop_noop - Command handler that simply returns success.
1686 * @args: device IDENTIFY data / SCSI command of interest.
1687 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1688 * @buflen: Response buffer length.
1690 * No operation. Simply returns success to caller, to indicate
1691 * that the caller should successfully complete this SCSI command.
1693 * LOCKING:
1694 * spin_lock_irqsave(host_set lock)
1697 unsigned int ata_scsiop_noop(struct ata_scsi_args *args, u8 *rbuf,
1698 unsigned int buflen)
1700 VPRINTK("ENTER\n");
1701 return 0;
1705 * ata_msense_push - Push data onto MODE SENSE data output buffer
1706 * @ptr_io: (input/output) Location to store more output data
1707 * @last: End of output data buffer
1708 * @buf: Pointer to BLOB being added to output buffer
1709 * @buflen: Length of BLOB
1711 * Store MODE SENSE data on an output buffer.
1713 * LOCKING:
1714 * None.
1717 static void ata_msense_push(u8 **ptr_io, const u8 *last,
1718 const u8 *buf, unsigned int buflen)
1720 u8 *ptr = *ptr_io;
1722 if ((ptr + buflen - 1) > last)
1723 return;
1725 memcpy(ptr, buf, buflen);
1727 ptr += buflen;
1729 *ptr_io = ptr;
1733 * ata_msense_caching - Simulate MODE SENSE caching info page
1734 * @id: device IDENTIFY data
1735 * @ptr_io: (input/output) Location to store more output data
1736 * @last: End of output data buffer
1738 * Generate a caching info page, which conditionally indicates
1739 * write caching to the SCSI layer, depending on device
1740 * capabilities.
1742 * LOCKING:
1743 * None.
1746 static unsigned int ata_msense_caching(u16 *id, u8 **ptr_io,
1747 const u8 *last)
1749 u8 page[CACHE_MPAGE_LEN];
1751 memcpy(page, def_cache_mpage, sizeof(page));
1752 if (ata_id_wcache_enabled(id))
1753 page[2] |= (1 << 2); /* write cache enable */
1754 if (!ata_id_rahead_enabled(id))
1755 page[12] |= (1 << 5); /* disable read ahead */
1757 ata_msense_push(ptr_io, last, page, sizeof(page));
1758 return sizeof(page);
1762 * ata_msense_ctl_mode - Simulate MODE SENSE control mode page
1763 * @dev: Device associated with this MODE SENSE command
1764 * @ptr_io: (input/output) Location to store more output data
1765 * @last: End of output data buffer
1767 * Generate a generic MODE SENSE control mode page.
1769 * LOCKING:
1770 * None.
1773 static unsigned int ata_msense_ctl_mode(u8 **ptr_io, const u8 *last)
1775 ata_msense_push(ptr_io, last, def_control_mpage,
1776 sizeof(def_control_mpage));
1777 return sizeof(def_control_mpage);
1781 * ata_msense_rw_recovery - Simulate MODE SENSE r/w error recovery page
1782 * @dev: Device associated with this MODE SENSE command
1783 * @ptr_io: (input/output) Location to store more output data
1784 * @last: End of output data buffer
1786 * Generate a generic MODE SENSE r/w error recovery page.
1788 * LOCKING:
1789 * None.
1792 static unsigned int ata_msense_rw_recovery(u8 **ptr_io, const u8 *last)
1795 ata_msense_push(ptr_io, last, def_rw_recovery_mpage,
1796 sizeof(def_rw_recovery_mpage));
1797 return sizeof(def_rw_recovery_mpage);
1801 * We can turn this into a real blacklist if it's needed, for now just
1802 * blacklist any Maxtor BANC1G10 revision firmware
1804 static int ata_dev_supports_fua(u16 *id)
1806 unsigned char model[41], fw[9];
1808 if (!libata_fua)
1809 return 0;
1810 if (!ata_id_has_fua(id))
1811 return 0;
1813 ata_id_c_string(id, model, ATA_ID_PROD_OFS, sizeof(model));
1814 ata_id_c_string(id, fw, ATA_ID_FW_REV_OFS, sizeof(fw));
1816 if (strcmp(model, "Maxtor"))
1817 return 1;
1818 if (strcmp(fw, "BANC1G10"))
1819 return 1;
1821 return 0; /* blacklisted */
1825 * ata_scsiop_mode_sense - Simulate MODE SENSE 6, 10 commands
1826 * @args: device IDENTIFY data / SCSI command of interest.
1827 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1828 * @buflen: Response buffer length.
1830 * Simulate MODE SENSE commands. Assume this is invoked for direct
1831 * access devices (e.g. disks) only. There should be no block
1832 * descriptor for other device types.
1834 * LOCKING:
1835 * spin_lock_irqsave(host_set lock)
1838 unsigned int ata_scsiop_mode_sense(struct ata_scsi_args *args, u8 *rbuf,
1839 unsigned int buflen)
1841 struct ata_device *dev = args->dev;
1842 u8 *scsicmd = args->cmd->cmnd, *p, *last;
1843 const u8 sat_blk_desc[] = {
1844 0, 0, 0, 0, /* number of blocks: sat unspecified */
1846 0, 0x2, 0x0 /* block length: 512 bytes */
1848 u8 pg, spg;
1849 unsigned int ebd, page_control, six_byte, output_len, alloc_len, minlen;
1850 u8 dpofua;
1852 VPRINTK("ENTER\n");
1854 six_byte = (scsicmd[0] == MODE_SENSE);
1855 ebd = !(scsicmd[1] & 0x8); /* dbd bit inverted == edb */
1857 * LLBA bit in msense(10) ignored (compliant)
1860 page_control = scsicmd[2] >> 6;
1861 switch (page_control) {
1862 case 0: /* current */
1863 break; /* supported */
1864 case 3: /* saved */
1865 goto saving_not_supp;
1866 case 1: /* changeable */
1867 case 2: /* defaults */
1868 default:
1869 goto invalid_fld;
1872 if (six_byte) {
1873 output_len = 4 + (ebd ? 8 : 0);
1874 alloc_len = scsicmd[4];
1875 } else {
1876 output_len = 8 + (ebd ? 8 : 0);
1877 alloc_len = (scsicmd[7] << 8) + scsicmd[8];
1879 minlen = (alloc_len < buflen) ? alloc_len : buflen;
1881 p = rbuf + output_len;
1882 last = rbuf + minlen - 1;
1884 pg = scsicmd[2] & 0x3f;
1885 spg = scsicmd[3];
1887 * No mode subpages supported (yet) but asking for _all_
1888 * subpages may be valid
1890 if (spg && (spg != ALL_SUB_MPAGES))
1891 goto invalid_fld;
1893 switch(pg) {
1894 case RW_RECOVERY_MPAGE:
1895 output_len += ata_msense_rw_recovery(&p, last);
1896 break;
1898 case CACHE_MPAGE:
1899 output_len += ata_msense_caching(args->id, &p, last);
1900 break;
1902 case CONTROL_MPAGE: {
1903 output_len += ata_msense_ctl_mode(&p, last);
1904 break;
1907 case ALL_MPAGES:
1908 output_len += ata_msense_rw_recovery(&p, last);
1909 output_len += ata_msense_caching(args->id, &p, last);
1910 output_len += ata_msense_ctl_mode(&p, last);
1911 break;
1913 default: /* invalid page code */
1914 goto invalid_fld;
1917 if (minlen < 1)
1918 return 0;
1920 dpofua = 0;
1921 if (ata_dev_supports_fua(args->id) && dev->flags & ATA_DFLAG_LBA48 &&
1922 (!(dev->flags & ATA_DFLAG_PIO) || dev->multi_count))
1923 dpofua = 1 << 4;
1925 if (six_byte) {
1926 output_len--;
1927 rbuf[0] = output_len;
1928 if (minlen > 2)
1929 rbuf[2] |= dpofua;
1930 if (ebd) {
1931 if (minlen > 3)
1932 rbuf[3] = sizeof(sat_blk_desc);
1933 if (minlen > 11)
1934 memcpy(rbuf + 4, sat_blk_desc,
1935 sizeof(sat_blk_desc));
1937 } else {
1938 output_len -= 2;
1939 rbuf[0] = output_len >> 8;
1940 if (minlen > 1)
1941 rbuf[1] = output_len;
1942 if (minlen > 3)
1943 rbuf[3] |= dpofua;
1944 if (ebd) {
1945 if (minlen > 7)
1946 rbuf[7] = sizeof(sat_blk_desc);
1947 if (minlen > 15)
1948 memcpy(rbuf + 8, sat_blk_desc,
1949 sizeof(sat_blk_desc));
1952 return 0;
1954 invalid_fld:
1955 ata_scsi_set_sense(args->cmd, ILLEGAL_REQUEST, 0x24, 0x0);
1956 /* "Invalid field in cbd" */
1957 return 1;
1959 saving_not_supp:
1960 ata_scsi_set_sense(args->cmd, ILLEGAL_REQUEST, 0x39, 0x0);
1961 /* "Saving parameters not supported" */
1962 return 1;
1966 * ata_scsiop_read_cap - Simulate READ CAPACITY[ 16] commands
1967 * @args: device IDENTIFY data / SCSI command of interest.
1968 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1969 * @buflen: Response buffer length.
1971 * Simulate READ CAPACITY commands.
1973 * LOCKING:
1974 * spin_lock_irqsave(host_set lock)
1977 unsigned int ata_scsiop_read_cap(struct ata_scsi_args *args, u8 *rbuf,
1978 unsigned int buflen)
1980 u64 n_sectors;
1981 u32 tmp;
1983 VPRINTK("ENTER\n");
1985 if (ata_id_has_lba(args->id)) {
1986 if (ata_id_has_lba48(args->id))
1987 n_sectors = ata_id_u64(args->id, 100);
1988 else
1989 n_sectors = ata_id_u32(args->id, 60);
1990 } else {
1991 /* CHS default translation */
1992 n_sectors = args->id[1] * args->id[3] * args->id[6];
1994 if (ata_id_current_chs_valid(args->id))
1995 /* CHS current translation */
1996 n_sectors = ata_id_u32(args->id, 57);
1999 n_sectors--; /* ATA TotalUserSectors - 1 */
2001 if (args->cmd->cmnd[0] == READ_CAPACITY) {
2002 if( n_sectors >= 0xffffffffULL )
2003 tmp = 0xffffffff ; /* Return max count on overflow */
2004 else
2005 tmp = n_sectors ;
2007 /* sector count, 32-bit */
2008 rbuf[0] = tmp >> (8 * 3);
2009 rbuf[1] = tmp >> (8 * 2);
2010 rbuf[2] = tmp >> (8 * 1);
2011 rbuf[3] = tmp;
2013 /* sector size */
2014 tmp = ATA_SECT_SIZE;
2015 rbuf[6] = tmp >> 8;
2016 rbuf[7] = tmp;
2018 } else {
2019 /* sector count, 64-bit */
2020 tmp = n_sectors >> (8 * 4);
2021 rbuf[2] = tmp >> (8 * 3);
2022 rbuf[3] = tmp >> (8 * 2);
2023 rbuf[4] = tmp >> (8 * 1);
2024 rbuf[5] = tmp;
2025 tmp = n_sectors;
2026 rbuf[6] = tmp >> (8 * 3);
2027 rbuf[7] = tmp >> (8 * 2);
2028 rbuf[8] = tmp >> (8 * 1);
2029 rbuf[9] = tmp;
2031 /* sector size */
2032 tmp = ATA_SECT_SIZE;
2033 rbuf[12] = tmp >> 8;
2034 rbuf[13] = tmp;
2037 return 0;
2041 * ata_scsiop_report_luns - Simulate REPORT LUNS command
2042 * @args: device IDENTIFY data / SCSI command of interest.
2043 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2044 * @buflen: Response buffer length.
2046 * Simulate REPORT LUNS command.
2048 * LOCKING:
2049 * spin_lock_irqsave(host_set lock)
2052 unsigned int ata_scsiop_report_luns(struct ata_scsi_args *args, u8 *rbuf,
2053 unsigned int buflen)
2055 VPRINTK("ENTER\n");
2056 rbuf[3] = 8; /* just one lun, LUN 0, size 8 bytes */
2058 return 0;
2062 * ata_scsi_set_sense - Set SCSI sense data and status
2063 * @cmd: SCSI request to be handled
2064 * @sk: SCSI-defined sense key
2065 * @asc: SCSI-defined additional sense code
2066 * @ascq: SCSI-defined additional sense code qualifier
2068 * Helper function that builds a valid fixed format, current
2069 * response code and the given sense key (sk), additional sense
2070 * code (asc) and additional sense code qualifier (ascq) with
2071 * a SCSI command status of %SAM_STAT_CHECK_CONDITION and
2072 * DRIVER_SENSE set in the upper bits of scsi_cmnd::result .
2074 * LOCKING:
2075 * Not required
2078 void ata_scsi_set_sense(struct scsi_cmnd *cmd, u8 sk, u8 asc, u8 ascq)
2080 cmd->result = (DRIVER_SENSE << 24) | SAM_STAT_CHECK_CONDITION;
2082 cmd->sense_buffer[0] = 0x70; /* fixed format, current */
2083 cmd->sense_buffer[2] = sk;
2084 cmd->sense_buffer[7] = 18 - 8; /* additional sense length */
2085 cmd->sense_buffer[12] = asc;
2086 cmd->sense_buffer[13] = ascq;
2090 * ata_scsi_badcmd - End a SCSI request with an error
2091 * @cmd: SCSI request to be handled
2092 * @done: SCSI command completion function
2093 * @asc: SCSI-defined additional sense code
2094 * @ascq: SCSI-defined additional sense code qualifier
2096 * Helper function that completes a SCSI command with
2097 * %SAM_STAT_CHECK_CONDITION, with a sense key %ILLEGAL_REQUEST
2098 * and the specified additional sense codes.
2100 * LOCKING:
2101 * spin_lock_irqsave(host_set lock)
2104 void ata_scsi_badcmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *), u8 asc, u8 ascq)
2106 DPRINTK("ENTER\n");
2107 ata_scsi_set_sense(cmd, ILLEGAL_REQUEST, asc, ascq);
2109 done(cmd);
2112 static void atapi_sense_complete(struct ata_queued_cmd *qc)
2114 if (qc->err_mask && ((qc->err_mask & AC_ERR_DEV) == 0))
2115 /* FIXME: not quite right; we don't want the
2116 * translation of taskfile registers into
2117 * a sense descriptors, since that's only
2118 * correct for ATA, not ATAPI
2120 ata_gen_ata_desc_sense(qc);
2122 qc->scsidone(qc->scsicmd);
2123 ata_qc_free(qc);
2126 /* is it pointless to prefer PIO for "safety reasons"? */
2127 static inline int ata_pio_use_silly(struct ata_port *ap)
2129 return (ap->flags & ATA_FLAG_PIO_DMA);
2132 static void atapi_request_sense(struct ata_queued_cmd *qc)
2134 struct ata_port *ap = qc->ap;
2135 struct scsi_cmnd *cmd = qc->scsicmd;
2137 DPRINTK("ATAPI request sense\n");
2139 /* FIXME: is this needed? */
2140 memset(cmd->sense_buffer, 0, sizeof(cmd->sense_buffer));
2142 ap->ops->tf_read(ap, &qc->tf);
2144 /* fill these in, for the case where they are -not- overwritten */
2145 cmd->sense_buffer[0] = 0x70;
2146 cmd->sense_buffer[2] = qc->tf.feature >> 4;
2148 ata_qc_reinit(qc);
2150 ata_sg_init_one(qc, cmd->sense_buffer, sizeof(cmd->sense_buffer));
2151 qc->dma_dir = DMA_FROM_DEVICE;
2153 memset(&qc->cdb, 0, qc->dev->cdb_len);
2154 qc->cdb[0] = REQUEST_SENSE;
2155 qc->cdb[4] = SCSI_SENSE_BUFFERSIZE;
2157 qc->tf.flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
2158 qc->tf.command = ATA_CMD_PACKET;
2160 if (ata_pio_use_silly(ap)) {
2161 qc->tf.protocol = ATA_PROT_ATAPI_DMA;
2162 qc->tf.feature |= ATAPI_PKT_DMA;
2163 } else {
2164 qc->tf.protocol = ATA_PROT_ATAPI;
2165 qc->tf.lbam = (8 * 1024) & 0xff;
2166 qc->tf.lbah = (8 * 1024) >> 8;
2168 qc->nbytes = SCSI_SENSE_BUFFERSIZE;
2170 qc->complete_fn = atapi_sense_complete;
2172 qc->err_mask = ata_qc_issue(qc);
2173 if (qc->err_mask)
2174 ata_qc_complete(qc);
2176 DPRINTK("EXIT\n");
2179 static void atapi_qc_complete(struct ata_queued_cmd *qc)
2181 struct scsi_cmnd *cmd = qc->scsicmd;
2182 unsigned int err_mask = qc->err_mask;
2184 VPRINTK("ENTER, err_mask 0x%X\n", err_mask);
2186 if (unlikely(err_mask & AC_ERR_DEV)) {
2187 cmd->result = SAM_STAT_CHECK_CONDITION;
2188 atapi_request_sense(qc);
2189 return;
2192 else if (unlikely(err_mask))
2193 /* FIXME: not quite right; we don't want the
2194 * translation of taskfile registers into
2195 * a sense descriptors, since that's only
2196 * correct for ATA, not ATAPI
2198 ata_gen_ata_desc_sense(qc);
2200 else {
2201 u8 *scsicmd = cmd->cmnd;
2203 if ((scsicmd[0] == INQUIRY) && ((scsicmd[1] & 0x03) == 0)) {
2204 u8 *buf = NULL;
2205 unsigned int buflen;
2207 buflen = ata_scsi_rbuf_get(cmd, &buf);
2209 /* ATAPI devices typically report zero for their SCSI version,
2210 * and sometimes deviate from the spec WRT response data
2211 * format. If SCSI version is reported as zero like normal,
2212 * then we make the following fixups: 1) Fake MMC-5 version,
2213 * to indicate to the Linux scsi midlayer this is a modern
2214 * device. 2) Ensure response data format / ATAPI information
2215 * are always correct.
2217 if (buf[2] == 0) {
2218 buf[2] = 0x5;
2219 buf[3] = 0x32;
2222 ata_scsi_rbuf_put(cmd, buf);
2225 cmd->result = SAM_STAT_GOOD;
2228 qc->scsidone(cmd);
2229 ata_qc_free(qc);
2232 * atapi_xlat - Initialize PACKET taskfile
2233 * @qc: command structure to be initialized
2234 * @scsicmd: SCSI CDB associated with this PACKET command
2236 * LOCKING:
2237 * spin_lock_irqsave(host_set lock)
2239 * RETURNS:
2240 * Zero on success, non-zero on failure.
2243 static unsigned int atapi_xlat(struct ata_queued_cmd *qc, const u8 *scsicmd)
2245 struct scsi_cmnd *cmd = qc->scsicmd;
2246 struct ata_device *dev = qc->dev;
2247 int using_pio = (dev->flags & ATA_DFLAG_PIO);
2248 int nodata = (cmd->sc_data_direction == DMA_NONE);
2250 if (!using_pio)
2251 /* Check whether ATAPI DMA is safe */
2252 if (ata_check_atapi_dma(qc))
2253 using_pio = 1;
2255 memcpy(&qc->cdb, scsicmd, dev->cdb_len);
2257 qc->complete_fn = atapi_qc_complete;
2259 qc->tf.flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
2260 if (cmd->sc_data_direction == DMA_TO_DEVICE) {
2261 qc->tf.flags |= ATA_TFLAG_WRITE;
2262 DPRINTK("direction: write\n");
2265 qc->tf.command = ATA_CMD_PACKET;
2267 /* no data, or PIO data xfer */
2268 if (using_pio || nodata) {
2269 if (nodata)
2270 qc->tf.protocol = ATA_PROT_ATAPI_NODATA;
2271 else
2272 qc->tf.protocol = ATA_PROT_ATAPI;
2273 qc->tf.lbam = (8 * 1024) & 0xff;
2274 qc->tf.lbah = (8 * 1024) >> 8;
2277 /* DMA data xfer */
2278 else {
2279 qc->tf.protocol = ATA_PROT_ATAPI_DMA;
2280 qc->tf.feature |= ATAPI_PKT_DMA;
2282 #ifdef ATAPI_ENABLE_DMADIR
2283 /* some SATA bridges need us to indicate data xfer direction */
2284 if (cmd->sc_data_direction != DMA_TO_DEVICE)
2285 qc->tf.feature |= ATAPI_DMADIR;
2286 #endif
2289 qc->nbytes = cmd->bufflen;
2291 return 0;
2295 * ata_scsi_find_dev - lookup ata_device from scsi_cmnd
2296 * @ap: ATA port to which the device is attached
2297 * @scsidev: SCSI device from which we derive the ATA device
2299 * Given various information provided in struct scsi_cmnd,
2300 * map that onto an ATA bus, and using that mapping
2301 * determine which ata_device is associated with the
2302 * SCSI command to be sent.
2304 * LOCKING:
2305 * spin_lock_irqsave(host_set lock)
2307 * RETURNS:
2308 * Associated ATA device, or %NULL if not found.
2311 static struct ata_device *
2312 ata_scsi_find_dev(struct ata_port *ap, const struct scsi_device *scsidev)
2314 struct ata_device *dev;
2316 /* skip commands not addressed to targets we simulate */
2317 if (likely(scsidev->id < ATA_MAX_DEVICES))
2318 dev = &ap->device[scsidev->id];
2319 else
2320 return NULL;
2322 if (unlikely((scsidev->channel != 0) ||
2323 (scsidev->lun != 0)))
2324 return NULL;
2326 if (unlikely(!ata_dev_present(dev)))
2327 return NULL;
2329 if (!atapi_enabled || (ap->flags & ATA_FLAG_NO_ATAPI)) {
2330 if (unlikely(dev->class == ATA_DEV_ATAPI)) {
2331 printk(KERN_WARNING "ata%u(%u): WARNING: ATAPI is %s, device ignored.\n",
2332 ap->id, dev->devno, atapi_enabled ? "not supported with this driver" : "disabled");
2333 return NULL;
2337 return dev;
2341 * ata_scsi_map_proto - Map pass-thru protocol value to taskfile value.
2342 * @byte1: Byte 1 from pass-thru CDB.
2344 * RETURNS:
2345 * ATA_PROT_UNKNOWN if mapping failed/unimplemented, protocol otherwise.
2347 static u8
2348 ata_scsi_map_proto(u8 byte1)
2350 switch((byte1 & 0x1e) >> 1) {
2351 case 3: /* Non-data */
2352 return ATA_PROT_NODATA;
2354 case 6: /* DMA */
2355 return ATA_PROT_DMA;
2357 case 4: /* PIO Data-in */
2358 case 5: /* PIO Data-out */
2359 if (byte1 & 0xe0) {
2360 return ATA_PROT_PIO_MULT;
2362 return ATA_PROT_PIO;
2364 case 10: /* Device Reset */
2365 case 0: /* Hard Reset */
2366 case 1: /* SRST */
2367 case 2: /* Bus Idle */
2368 case 7: /* Packet */
2369 case 8: /* DMA Queued */
2370 case 9: /* Device Diagnostic */
2371 case 11: /* UDMA Data-in */
2372 case 12: /* UDMA Data-Out */
2373 case 13: /* FPDMA */
2374 default: /* Reserved */
2375 break;
2378 return ATA_PROT_UNKNOWN;
2382 * ata_scsi_pass_thru - convert ATA pass-thru CDB to taskfile
2383 * @qc: command structure to be initialized
2384 * @scsicmd: SCSI command to convert
2386 * Handles either 12 or 16-byte versions of the CDB.
2388 * RETURNS:
2389 * Zero on success, non-zero on failure.
2391 static unsigned int
2392 ata_scsi_pass_thru(struct ata_queued_cmd *qc, const u8 *scsicmd)
2394 struct ata_taskfile *tf = &(qc->tf);
2395 struct scsi_cmnd *cmd = qc->scsicmd;
2397 if ((tf->protocol = ata_scsi_map_proto(scsicmd[1])) == ATA_PROT_UNKNOWN)
2398 goto invalid_fld;
2401 * 12 and 16 byte CDBs use different offsets to
2402 * provide the various register values.
2404 if (scsicmd[0] == ATA_16) {
2406 * 16-byte CDB - may contain extended commands.
2408 * If that is the case, copy the upper byte register values.
2410 if (scsicmd[1] & 0x01) {
2411 tf->hob_feature = scsicmd[3];
2412 tf->hob_nsect = scsicmd[5];
2413 tf->hob_lbal = scsicmd[7];
2414 tf->hob_lbam = scsicmd[9];
2415 tf->hob_lbah = scsicmd[11];
2416 tf->flags |= ATA_TFLAG_LBA48;
2417 } else
2418 tf->flags &= ~ATA_TFLAG_LBA48;
2421 * Always copy low byte, device and command registers.
2423 tf->feature = scsicmd[4];
2424 tf->nsect = scsicmd[6];
2425 tf->lbal = scsicmd[8];
2426 tf->lbam = scsicmd[10];
2427 tf->lbah = scsicmd[12];
2428 tf->device = scsicmd[13];
2429 tf->command = scsicmd[14];
2430 } else {
2432 * 12-byte CDB - incapable of extended commands.
2434 tf->flags &= ~ATA_TFLAG_LBA48;
2436 tf->feature = scsicmd[3];
2437 tf->nsect = scsicmd[4];
2438 tf->lbal = scsicmd[5];
2439 tf->lbam = scsicmd[6];
2440 tf->lbah = scsicmd[7];
2441 tf->device = scsicmd[8];
2442 tf->command = scsicmd[9];
2445 * If slave is possible, enforce correct master/slave bit
2447 if (qc->ap->flags & ATA_FLAG_SLAVE_POSS)
2448 tf->device = qc->dev->devno ?
2449 tf->device | ATA_DEV1 : tf->device & ~ATA_DEV1;
2452 * Filter SET_FEATURES - XFER MODE command -- otherwise,
2453 * SET_FEATURES - XFER MODE must be preceded/succeeded
2454 * by an update to hardware-specific registers for each
2455 * controller (i.e. the reason for ->set_piomode(),
2456 * ->set_dmamode(), and ->post_set_mode() hooks).
2458 if ((tf->command == ATA_CMD_SET_FEATURES)
2459 && (tf->feature == SETFEATURES_XFER))
2460 goto invalid_fld;
2463 * Set flags so that all registers will be written,
2464 * and pass on write indication (used for PIO/DMA
2465 * setup.)
2467 tf->flags |= (ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE);
2469 if (cmd->sc_data_direction == DMA_TO_DEVICE)
2470 tf->flags |= ATA_TFLAG_WRITE;
2473 * Set transfer length.
2475 * TODO: find out if we need to do more here to
2476 * cover scatter/gather case.
2478 qc->nsect = cmd->bufflen / ATA_SECT_SIZE;
2480 return 0;
2482 invalid_fld:
2483 ata_scsi_set_sense(qc->scsicmd, ILLEGAL_REQUEST, 0x24, 0x00);
2484 /* "Invalid field in cdb" */
2485 return 1;
2489 * ata_get_xlat_func - check if SCSI to ATA translation is possible
2490 * @dev: ATA device
2491 * @cmd: SCSI command opcode to consider
2493 * Look up the SCSI command given, and determine whether the
2494 * SCSI command is to be translated or simulated.
2496 * RETURNS:
2497 * Pointer to translation function if possible, %NULL if not.
2500 static inline ata_xlat_func_t ata_get_xlat_func(struct ata_device *dev, u8 cmd)
2502 switch (cmd) {
2503 case READ_6:
2504 case READ_10:
2505 case READ_16:
2507 case WRITE_6:
2508 case WRITE_10:
2509 case WRITE_16:
2510 return ata_scsi_rw_xlat;
2512 case SYNCHRONIZE_CACHE:
2513 if (ata_try_flush_cache(dev))
2514 return ata_scsi_flush_xlat;
2515 break;
2517 case VERIFY:
2518 case VERIFY_16:
2519 return ata_scsi_verify_xlat;
2521 case ATA_12:
2522 case ATA_16:
2523 return ata_scsi_pass_thru;
2525 case START_STOP:
2526 return ata_scsi_start_stop_xlat;
2529 return NULL;
2533 * ata_scsi_dump_cdb - dump SCSI command contents to dmesg
2534 * @ap: ATA port to which the command was being sent
2535 * @cmd: SCSI command to dump
2537 * Prints the contents of a SCSI command via printk().
2540 static inline void ata_scsi_dump_cdb(struct ata_port *ap,
2541 struct scsi_cmnd *cmd)
2543 #ifdef ATA_DEBUG
2544 struct scsi_device *scsidev = cmd->device;
2545 u8 *scsicmd = cmd->cmnd;
2547 DPRINTK("CDB (%u:%d,%d,%d) %02x %02x %02x %02x %02x %02x %02x %02x %02x\n",
2548 ap->id,
2549 scsidev->channel, scsidev->id, scsidev->lun,
2550 scsicmd[0], scsicmd[1], scsicmd[2], scsicmd[3],
2551 scsicmd[4], scsicmd[5], scsicmd[6], scsicmd[7],
2552 scsicmd[8]);
2553 #endif
2557 * ata_scsi_queuecmd - Issue SCSI cdb to libata-managed device
2558 * @cmd: SCSI command to be sent
2559 * @done: Completion function, called when command is complete
2561 * In some cases, this function translates SCSI commands into
2562 * ATA taskfiles, and queues the taskfiles to be sent to
2563 * hardware. In other cases, this function simulates a
2564 * SCSI device by evaluating and responding to certain
2565 * SCSI commands. This creates the overall effect of
2566 * ATA and ATAPI devices appearing as SCSI devices.
2568 * LOCKING:
2569 * Releases scsi-layer-held lock, and obtains host_set lock.
2571 * RETURNS:
2572 * Zero.
2575 int ata_scsi_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *))
2577 struct ata_port *ap;
2578 struct ata_device *dev;
2579 struct scsi_device *scsidev = cmd->device;
2580 struct Scsi_Host *shost = scsidev->host;
2582 ap = (struct ata_port *) &shost->hostdata[0];
2584 spin_unlock(shost->host_lock);
2585 spin_lock(&ap->host_set->lock);
2587 ata_scsi_dump_cdb(ap, cmd);
2589 dev = ata_scsi_find_dev(ap, scsidev);
2590 if (unlikely(!dev)) {
2591 cmd->result = (DID_BAD_TARGET << 16);
2592 done(cmd);
2593 goto out_unlock;
2596 if (dev->class == ATA_DEV_ATA) {
2597 ata_xlat_func_t xlat_func = ata_get_xlat_func(dev,
2598 cmd->cmnd[0]);
2600 if (xlat_func)
2601 ata_scsi_translate(ap, dev, cmd, done, xlat_func);
2602 else
2603 ata_scsi_simulate(ap, dev, cmd, done);
2604 } else
2605 ata_scsi_translate(ap, dev, cmd, done, atapi_xlat);
2607 out_unlock:
2608 spin_unlock(&ap->host_set->lock);
2609 spin_lock(shost->host_lock);
2610 return 0;
2614 * ata_scsi_simulate - simulate SCSI command on ATA device
2615 * @ap: port the device is connected to
2616 * @dev: the target device
2617 * @cmd: SCSI command being sent to device.
2618 * @done: SCSI command completion function.
2620 * Interprets and directly executes a select list of SCSI commands
2621 * that can be handled internally.
2623 * LOCKING:
2624 * spin_lock_irqsave(host_set lock)
2627 void ata_scsi_simulate(struct ata_port *ap, struct ata_device *dev,
2628 struct scsi_cmnd *cmd,
2629 void (*done)(struct scsi_cmnd *))
2631 struct ata_scsi_args args;
2632 const u8 *scsicmd = cmd->cmnd;
2634 args.ap = ap;
2635 args.dev = dev;
2636 args.id = dev->id;
2637 args.cmd = cmd;
2638 args.done = done;
2640 switch(scsicmd[0]) {
2641 /* no-op's, complete with success */
2642 case SYNCHRONIZE_CACHE:
2643 case REZERO_UNIT:
2644 case SEEK_6:
2645 case SEEK_10:
2646 case TEST_UNIT_READY:
2647 case FORMAT_UNIT: /* FIXME: correct? */
2648 case SEND_DIAGNOSTIC: /* FIXME: correct? */
2649 ata_scsi_rbuf_fill(&args, ata_scsiop_noop);
2650 break;
2652 case INQUIRY:
2653 if (scsicmd[1] & 2) /* is CmdDt set? */
2654 ata_scsi_invalid_field(cmd, done);
2655 else if ((scsicmd[1] & 1) == 0) /* is EVPD clear? */
2656 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_std);
2657 else if (scsicmd[2] == 0x00)
2658 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_00);
2659 else if (scsicmd[2] == 0x80)
2660 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_80);
2661 else if (scsicmd[2] == 0x83)
2662 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_83);
2663 else
2664 ata_scsi_invalid_field(cmd, done);
2665 break;
2667 case MODE_SENSE:
2668 case MODE_SENSE_10:
2669 ata_scsi_rbuf_fill(&args, ata_scsiop_mode_sense);
2670 break;
2672 case MODE_SELECT: /* unconditionally return */
2673 case MODE_SELECT_10: /* bad-field-in-cdb */
2674 ata_scsi_invalid_field(cmd, done);
2675 break;
2677 case READ_CAPACITY:
2678 ata_scsi_rbuf_fill(&args, ata_scsiop_read_cap);
2679 break;
2681 case SERVICE_ACTION_IN:
2682 if ((scsicmd[1] & 0x1f) == SAI_READ_CAPACITY_16)
2683 ata_scsi_rbuf_fill(&args, ata_scsiop_read_cap);
2684 else
2685 ata_scsi_invalid_field(cmd, done);
2686 break;
2688 case REPORT_LUNS:
2689 ata_scsi_rbuf_fill(&args, ata_scsiop_report_luns);
2690 break;
2692 /* mandatory commands we haven't implemented yet */
2693 case REQUEST_SENSE:
2695 /* all other commands */
2696 default:
2697 ata_scsi_set_sense(cmd, ILLEGAL_REQUEST, 0x20, 0x0);
2698 /* "Invalid command operation code" */
2699 done(cmd);
2700 break;
2704 void ata_scsi_scan_host(struct ata_port *ap)
2706 struct ata_device *dev;
2707 unsigned int i;
2709 if (ap->flags & ATA_FLAG_PORT_DISABLED)
2710 return;
2712 for (i = 0; i < ATA_MAX_DEVICES; i++) {
2713 dev = &ap->device[i];
2715 if (ata_dev_present(dev))
2716 scsi_scan_target(&ap->host->shost_gendev, 0, i, 0, 0);