Merge branch 'master'
[linux-2.6/linux-loongson.git] / drivers / scsi / libata-scsi.c
blob2d328b3af0671391595c0ee40cf4f5769b8b1daa
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 assert(NULL != qc->ap->ops->tf_read);
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 assert(NULL != qc->ap->ops->tf_read);
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;
688 ap = (struct ata_port *) &sdev->host->hostdata[0];
689 dev = &ap->device[sdev->id];
691 /* TODO: 1024 is an arbitrary number, not the
692 * hardware maximum. This should be increased to
693 * 65534 when Jens Axboe's patch for dynamically
694 * determining max_sectors is merged.
696 if ((dev->flags & ATA_DFLAG_LBA48) &&
697 ((dev->flags & ATA_DFLAG_LOCK_SECTORS) == 0)) {
699 * do not overwrite sdev->host->max_sectors, since
700 * other drives on this host may not support LBA48
702 blk_queue_max_sectors(sdev->request_queue, 2048);
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_error - SCSI layer error handler callback
721 * @host: SCSI host on which error occurred
723 * Handles SCSI-layer-thrown error events.
725 * LOCKING:
726 * Inherited from SCSI layer (none, can sleep)
728 * RETURNS:
729 * Zero.
732 int ata_scsi_error(struct Scsi_Host *host)
734 struct ata_port *ap;
736 DPRINTK("ENTER\n");
738 ap = (struct ata_port *) &host->hostdata[0];
739 ap->ops->eng_timeout(ap);
741 assert(host->host_failed == 0 && list_empty(&host->eh_cmd_q));
743 scsi_eh_flush_done_q(&ap->eh_done_q);
745 DPRINTK("EXIT\n");
746 return 0;
749 static void ata_eh_scsidone(struct scsi_cmnd *scmd)
751 /* nada */
754 static void __ata_eh_qc_complete(struct ata_queued_cmd *qc)
756 struct ata_port *ap = qc->ap;
757 struct scsi_cmnd *scmd = qc->scsicmd;
758 unsigned long flags;
760 spin_lock_irqsave(&ap->host_set->lock, flags);
761 qc->scsidone = ata_eh_scsidone;
762 ata_qc_complete(qc);
763 assert(!ata_tag_valid(qc->tag));
764 spin_unlock_irqrestore(&ap->host_set->lock, flags);
766 scsi_eh_finish_cmd(scmd, &ap->eh_done_q);
770 * ata_eh_qc_complete - Complete an active ATA command from EH
771 * @qc: Command to complete
773 * Indicate to the mid and upper layers that an ATA command has
774 * completed. To be used from EH.
776 void ata_eh_qc_complete(struct ata_queued_cmd *qc)
778 struct scsi_cmnd *scmd = qc->scsicmd;
779 scmd->retries = scmd->allowed;
780 __ata_eh_qc_complete(qc);
784 * ata_eh_qc_retry - Tell midlayer to retry an ATA command after EH
785 * @qc: Command to retry
787 * Indicate to the mid and upper layers that an ATA command
788 * should be retried. To be used from EH.
790 * SCSI midlayer limits the number of retries to scmd->allowed.
791 * This function might need to adjust scmd->retries for commands
792 * which get retried due to unrelated NCQ failures.
794 void ata_eh_qc_retry(struct ata_queued_cmd *qc)
796 __ata_eh_qc_complete(qc);
800 * ata_scsi_start_stop_xlat - Translate SCSI START STOP UNIT command
801 * @qc: Storage for translated ATA taskfile
802 * @scsicmd: SCSI command to translate
804 * Sets up an ATA taskfile to issue STANDBY (to stop) or READ VERIFY
805 * (to start). Perhaps these commands should be preceded by
806 * CHECK POWER MODE to see what power mode the device is already in.
807 * [See SAT revision 5 at www.t10.org]
809 * LOCKING:
810 * spin_lock_irqsave(host_set lock)
812 * RETURNS:
813 * Zero on success, non-zero on error.
816 static unsigned int ata_scsi_start_stop_xlat(struct ata_queued_cmd *qc,
817 const u8 *scsicmd)
819 struct ata_taskfile *tf = &qc->tf;
821 tf->flags |= ATA_TFLAG_DEVICE | ATA_TFLAG_ISADDR;
822 tf->protocol = ATA_PROT_NODATA;
823 if (scsicmd[1] & 0x1) {
824 ; /* ignore IMMED bit, violates sat-r05 */
826 if (scsicmd[4] & 0x2)
827 goto invalid_fld; /* LOEJ bit set not supported */
828 if (((scsicmd[4] >> 4) & 0xf) != 0)
829 goto invalid_fld; /* power conditions not supported */
830 if (scsicmd[4] & 0x1) {
831 tf->nsect = 1; /* 1 sector, lba=0 */
833 if (qc->dev->flags & ATA_DFLAG_LBA) {
834 qc->tf.flags |= ATA_TFLAG_LBA;
836 tf->lbah = 0x0;
837 tf->lbam = 0x0;
838 tf->lbal = 0x0;
839 tf->device |= ATA_LBA;
840 } else {
841 /* CHS */
842 tf->lbal = 0x1; /* sect */
843 tf->lbam = 0x0; /* cyl low */
844 tf->lbah = 0x0; /* cyl high */
847 tf->command = ATA_CMD_VERIFY; /* READ VERIFY */
848 } else {
849 tf->nsect = 0; /* time period value (0 implies now) */
850 tf->command = ATA_CMD_STANDBY;
851 /* Consider: ATA STANDBY IMMEDIATE command */
854 * Standby and Idle condition timers could be implemented but that
855 * would require libata to implement the Power condition mode page
856 * and allow the user to change it. Changing mode pages requires
857 * MODE SELECT to be implemented.
860 return 0;
862 invalid_fld:
863 ata_scsi_set_sense(qc->scsicmd, ILLEGAL_REQUEST, 0x24, 0x0);
864 /* "Invalid field in cbd" */
865 return 1;
870 * ata_scsi_flush_xlat - Translate SCSI SYNCHRONIZE CACHE command
871 * @qc: Storage for translated ATA taskfile
872 * @scsicmd: SCSI command to translate (ignored)
874 * Sets up an ATA taskfile to issue FLUSH CACHE or
875 * FLUSH CACHE EXT.
877 * LOCKING:
878 * spin_lock_irqsave(host_set lock)
880 * RETURNS:
881 * Zero on success, non-zero on error.
884 static unsigned int ata_scsi_flush_xlat(struct ata_queued_cmd *qc, const u8 *scsicmd)
886 struct ata_taskfile *tf = &qc->tf;
888 tf->flags |= ATA_TFLAG_DEVICE;
889 tf->protocol = ATA_PROT_NODATA;
891 if ((qc->dev->flags & ATA_DFLAG_LBA48) &&
892 (ata_id_has_flush_ext(qc->dev->id)))
893 tf->command = ATA_CMD_FLUSH_EXT;
894 else
895 tf->command = ATA_CMD_FLUSH;
897 return 0;
901 * scsi_6_lba_len - Get LBA and transfer length
902 * @scsicmd: SCSI command to translate
904 * Calculate LBA and transfer length for 6-byte commands.
906 * RETURNS:
907 * @plba: the LBA
908 * @plen: the transfer length
911 static void scsi_6_lba_len(const u8 *scsicmd, u64 *plba, u32 *plen)
913 u64 lba = 0;
914 u32 len = 0;
916 VPRINTK("six-byte command\n");
918 lba |= ((u64)scsicmd[2]) << 8;
919 lba |= ((u64)scsicmd[3]);
921 len |= ((u32)scsicmd[4]);
923 *plba = lba;
924 *plen = len;
928 * scsi_10_lba_len - Get LBA and transfer length
929 * @scsicmd: SCSI command to translate
931 * Calculate LBA and transfer length for 10-byte commands.
933 * RETURNS:
934 * @plba: the LBA
935 * @plen: the transfer length
938 static void scsi_10_lba_len(const u8 *scsicmd, u64 *plba, u32 *plen)
940 u64 lba = 0;
941 u32 len = 0;
943 VPRINTK("ten-byte command\n");
945 lba |= ((u64)scsicmd[2]) << 24;
946 lba |= ((u64)scsicmd[3]) << 16;
947 lba |= ((u64)scsicmd[4]) << 8;
948 lba |= ((u64)scsicmd[5]);
950 len |= ((u32)scsicmd[7]) << 8;
951 len |= ((u32)scsicmd[8]);
953 *plba = lba;
954 *plen = len;
958 * scsi_16_lba_len - Get LBA and transfer length
959 * @scsicmd: SCSI command to translate
961 * Calculate LBA and transfer length for 16-byte commands.
963 * RETURNS:
964 * @plba: the LBA
965 * @plen: the transfer length
968 static void scsi_16_lba_len(const u8 *scsicmd, u64 *plba, u32 *plen)
970 u64 lba = 0;
971 u32 len = 0;
973 VPRINTK("sixteen-byte command\n");
975 lba |= ((u64)scsicmd[2]) << 56;
976 lba |= ((u64)scsicmd[3]) << 48;
977 lba |= ((u64)scsicmd[4]) << 40;
978 lba |= ((u64)scsicmd[5]) << 32;
979 lba |= ((u64)scsicmd[6]) << 24;
980 lba |= ((u64)scsicmd[7]) << 16;
981 lba |= ((u64)scsicmd[8]) << 8;
982 lba |= ((u64)scsicmd[9]);
984 len |= ((u32)scsicmd[10]) << 24;
985 len |= ((u32)scsicmd[11]) << 16;
986 len |= ((u32)scsicmd[12]) << 8;
987 len |= ((u32)scsicmd[13]);
989 *plba = lba;
990 *plen = len;
994 * ata_scsi_verify_xlat - Translate SCSI VERIFY command into an ATA one
995 * @qc: Storage for translated ATA taskfile
996 * @scsicmd: SCSI command to translate
998 * Converts SCSI VERIFY command to an ATA READ VERIFY command.
1000 * LOCKING:
1001 * spin_lock_irqsave(host_set lock)
1003 * RETURNS:
1004 * Zero on success, non-zero on error.
1007 static unsigned int ata_scsi_verify_xlat(struct ata_queued_cmd *qc, const u8 *scsicmd)
1009 struct ata_taskfile *tf = &qc->tf;
1010 struct ata_device *dev = qc->dev;
1011 u64 dev_sectors = qc->dev->n_sectors;
1012 u64 block;
1013 u32 n_block;
1015 tf->flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
1016 tf->protocol = ATA_PROT_NODATA;
1018 if (scsicmd[0] == VERIFY)
1019 scsi_10_lba_len(scsicmd, &block, &n_block);
1020 else if (scsicmd[0] == VERIFY_16)
1021 scsi_16_lba_len(scsicmd, &block, &n_block);
1022 else
1023 goto invalid_fld;
1025 if (!n_block)
1026 goto nothing_to_do;
1027 if (block >= dev_sectors)
1028 goto out_of_range;
1029 if ((block + n_block) > dev_sectors)
1030 goto out_of_range;
1032 if (dev->flags & ATA_DFLAG_LBA) {
1033 tf->flags |= ATA_TFLAG_LBA;
1035 if (lba_28_ok(block, n_block)) {
1036 /* use LBA28 */
1037 tf->command = ATA_CMD_VERIFY;
1038 tf->device |= (block >> 24) & 0xf;
1039 } else if (lba_48_ok(block, n_block)) {
1040 if (!(dev->flags & ATA_DFLAG_LBA48))
1041 goto out_of_range;
1043 /* use LBA48 */
1044 tf->flags |= ATA_TFLAG_LBA48;
1045 tf->command = ATA_CMD_VERIFY_EXT;
1047 tf->hob_nsect = (n_block >> 8) & 0xff;
1049 tf->hob_lbah = (block >> 40) & 0xff;
1050 tf->hob_lbam = (block >> 32) & 0xff;
1051 tf->hob_lbal = (block >> 24) & 0xff;
1052 } else
1053 /* request too large even for LBA48 */
1054 goto out_of_range;
1056 tf->nsect = n_block & 0xff;
1058 tf->lbah = (block >> 16) & 0xff;
1059 tf->lbam = (block >> 8) & 0xff;
1060 tf->lbal = block & 0xff;
1062 tf->device |= ATA_LBA;
1063 } else {
1064 /* CHS */
1065 u32 sect, head, cyl, track;
1067 if (!lba_28_ok(block, n_block))
1068 goto out_of_range;
1070 /* Convert LBA to CHS */
1071 track = (u32)block / dev->sectors;
1072 cyl = track / dev->heads;
1073 head = track % dev->heads;
1074 sect = (u32)block % dev->sectors + 1;
1076 DPRINTK("block %u track %u cyl %u head %u sect %u\n",
1077 (u32)block, track, cyl, head, sect);
1079 /* Check whether the converted CHS can fit.
1080 Cylinder: 0-65535
1081 Head: 0-15
1082 Sector: 1-255*/
1083 if ((cyl >> 16) || (head >> 4) || (sect >> 8) || (!sect))
1084 goto out_of_range;
1086 tf->command = ATA_CMD_VERIFY;
1087 tf->nsect = n_block & 0xff; /* Sector count 0 means 256 sectors */
1088 tf->lbal = sect;
1089 tf->lbam = cyl;
1090 tf->lbah = cyl >> 8;
1091 tf->device |= head;
1094 return 0;
1096 invalid_fld:
1097 ata_scsi_set_sense(qc->scsicmd, ILLEGAL_REQUEST, 0x24, 0x0);
1098 /* "Invalid field in cbd" */
1099 return 1;
1101 out_of_range:
1102 ata_scsi_set_sense(qc->scsicmd, ILLEGAL_REQUEST, 0x21, 0x0);
1103 /* "Logical Block Address out of range" */
1104 return 1;
1106 nothing_to_do:
1107 qc->scsicmd->result = SAM_STAT_GOOD;
1108 return 1;
1112 * ata_scsi_rw_xlat - Translate SCSI r/w command into an ATA one
1113 * @qc: Storage for translated ATA taskfile
1114 * @scsicmd: SCSI command to translate
1116 * Converts any of six SCSI read/write commands into the
1117 * ATA counterpart, including starting sector (LBA),
1118 * sector count, and taking into account the device's LBA48
1119 * support.
1121 * Commands %READ_6, %READ_10, %READ_16, %WRITE_6, %WRITE_10, and
1122 * %WRITE_16 are currently supported.
1124 * LOCKING:
1125 * spin_lock_irqsave(host_set lock)
1127 * RETURNS:
1128 * Zero on success, non-zero on error.
1131 static unsigned int ata_scsi_rw_xlat(struct ata_queued_cmd *qc, const u8 *scsicmd)
1133 struct ata_taskfile *tf = &qc->tf;
1134 struct ata_device *dev = qc->dev;
1135 u64 block;
1136 u32 n_block;
1138 tf->flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
1140 if (scsicmd[0] == WRITE_10 || scsicmd[0] == WRITE_6 ||
1141 scsicmd[0] == WRITE_16)
1142 tf->flags |= ATA_TFLAG_WRITE;
1144 /* Calculate the SCSI LBA, transfer length and FUA. */
1145 switch (scsicmd[0]) {
1146 case READ_10:
1147 case WRITE_10:
1148 scsi_10_lba_len(scsicmd, &block, &n_block);
1149 if (unlikely(scsicmd[1] & (1 << 3)))
1150 tf->flags |= ATA_TFLAG_FUA;
1151 break;
1152 case READ_6:
1153 case WRITE_6:
1154 scsi_6_lba_len(scsicmd, &block, &n_block);
1156 /* for 6-byte r/w commands, transfer length 0
1157 * means 256 blocks of data, not 0 block.
1159 if (!n_block)
1160 n_block = 256;
1161 break;
1162 case READ_16:
1163 case WRITE_16:
1164 scsi_16_lba_len(scsicmd, &block, &n_block);
1165 if (unlikely(scsicmd[1] & (1 << 3)))
1166 tf->flags |= ATA_TFLAG_FUA;
1167 break;
1168 default:
1169 DPRINTK("no-byte command\n");
1170 goto invalid_fld;
1173 /* Check and compose ATA command */
1174 if (!n_block)
1175 /* For 10-byte and 16-byte SCSI R/W commands, transfer
1176 * length 0 means transfer 0 block of data.
1177 * However, for ATA R/W commands, sector count 0 means
1178 * 256 or 65536 sectors, not 0 sectors as in SCSI.
1180 * WARNING: one or two older ATA drives treat 0 as 0...
1182 goto nothing_to_do;
1184 if (dev->flags & ATA_DFLAG_LBA) {
1185 tf->flags |= ATA_TFLAG_LBA;
1187 if (lba_28_ok(block, n_block)) {
1188 /* use LBA28 */
1189 tf->device |= (block >> 24) & 0xf;
1190 } else if (lba_48_ok(block, n_block)) {
1191 if (!(dev->flags & ATA_DFLAG_LBA48))
1192 goto out_of_range;
1194 /* use LBA48 */
1195 tf->flags |= ATA_TFLAG_LBA48;
1197 tf->hob_nsect = (n_block >> 8) & 0xff;
1199 tf->hob_lbah = (block >> 40) & 0xff;
1200 tf->hob_lbam = (block >> 32) & 0xff;
1201 tf->hob_lbal = (block >> 24) & 0xff;
1202 } else
1203 /* request too large even for LBA48 */
1204 goto out_of_range;
1206 if (unlikely(ata_rwcmd_protocol(qc) < 0))
1207 goto invalid_fld;
1209 qc->nsect = n_block;
1210 tf->nsect = n_block & 0xff;
1212 tf->lbah = (block >> 16) & 0xff;
1213 tf->lbam = (block >> 8) & 0xff;
1214 tf->lbal = block & 0xff;
1216 tf->device |= ATA_LBA;
1217 } else {
1218 /* CHS */
1219 u32 sect, head, cyl, track;
1221 /* The request -may- be too large for CHS addressing. */
1222 if (!lba_28_ok(block, n_block))
1223 goto out_of_range;
1225 if (unlikely(ata_rwcmd_protocol(qc) < 0))
1226 goto invalid_fld;
1228 /* Convert LBA to CHS */
1229 track = (u32)block / dev->sectors;
1230 cyl = track / dev->heads;
1231 head = track % dev->heads;
1232 sect = (u32)block % dev->sectors + 1;
1234 DPRINTK("block %u track %u cyl %u head %u sect %u\n",
1235 (u32)block, track, cyl, head, sect);
1237 /* Check whether the converted CHS can fit.
1238 Cylinder: 0-65535
1239 Head: 0-15
1240 Sector: 1-255*/
1241 if ((cyl >> 16) || (head >> 4) || (sect >> 8) || (!sect))
1242 goto out_of_range;
1244 qc->nsect = n_block;
1245 tf->nsect = n_block & 0xff; /* Sector count 0 means 256 sectors */
1246 tf->lbal = sect;
1247 tf->lbam = cyl;
1248 tf->lbah = cyl >> 8;
1249 tf->device |= head;
1252 return 0;
1254 invalid_fld:
1255 ata_scsi_set_sense(qc->scsicmd, ILLEGAL_REQUEST, 0x24, 0x0);
1256 /* "Invalid field in cbd" */
1257 return 1;
1259 out_of_range:
1260 ata_scsi_set_sense(qc->scsicmd, ILLEGAL_REQUEST, 0x21, 0x0);
1261 /* "Logical Block Address out of range" */
1262 return 1;
1264 nothing_to_do:
1265 qc->scsicmd->result = SAM_STAT_GOOD;
1266 return 1;
1269 static void ata_scsi_qc_complete(struct ata_queued_cmd *qc)
1271 struct scsi_cmnd *cmd = qc->scsicmd;
1272 u8 *cdb = cmd->cmnd;
1273 int need_sense = (qc->err_mask != 0);
1275 /* For ATA pass thru (SAT) commands, generate a sense block if
1276 * user mandated it or if there's an error. Note that if we
1277 * generate because the user forced us to, a check condition
1278 * is generated and the ATA register values are returned
1279 * whether the command completed successfully or not. If there
1280 * was no error, SK, ASC and ASCQ will all be zero.
1282 if (((cdb[0] == ATA_16) || (cdb[0] == ATA_12)) &&
1283 ((cdb[2] & 0x20) || need_sense)) {
1284 ata_gen_ata_desc_sense(qc);
1285 } else {
1286 if (!need_sense) {
1287 cmd->result = SAM_STAT_GOOD;
1288 } else {
1289 /* TODO: decide which descriptor format to use
1290 * for 48b LBA devices and call that here
1291 * instead of the fixed desc, which is only
1292 * good for smaller LBA (and maybe CHS?)
1293 * devices.
1295 ata_gen_fixed_sense(qc);
1299 if (need_sense) {
1300 /* The ata_gen_..._sense routines fill in tf */
1301 ata_dump_status(qc->ap->id, &qc->tf);
1304 qc->scsidone(cmd);
1306 ata_qc_free(qc);
1310 * ata_scsi_translate - Translate then issue SCSI command to ATA device
1311 * @ap: ATA port to which the command is addressed
1312 * @dev: ATA device to which the command is addressed
1313 * @cmd: SCSI command to execute
1314 * @done: SCSI command completion function
1315 * @xlat_func: Actor which translates @cmd to an ATA taskfile
1317 * Our ->queuecommand() function has decided that the SCSI
1318 * command issued can be directly translated into an ATA
1319 * command, rather than handled internally.
1321 * This function sets up an ata_queued_cmd structure for the
1322 * SCSI command, and sends that ata_queued_cmd to the hardware.
1324 * The xlat_func argument (actor) returns 0 if ready to execute
1325 * ATA command, else 1 to finish translation. If 1 is returned
1326 * then cmd->result (and possibly cmd->sense_buffer) are assumed
1327 * to be set reflecting an error condition or clean (early)
1328 * termination.
1330 * LOCKING:
1331 * spin_lock_irqsave(host_set lock)
1334 static void ata_scsi_translate(struct ata_port *ap, struct ata_device *dev,
1335 struct scsi_cmnd *cmd,
1336 void (*done)(struct scsi_cmnd *),
1337 ata_xlat_func_t xlat_func)
1339 struct ata_queued_cmd *qc;
1340 u8 *scsicmd = cmd->cmnd;
1342 VPRINTK("ENTER\n");
1344 qc = ata_scsi_qc_new(ap, dev, cmd, done);
1345 if (!qc)
1346 goto err_mem;
1348 /* data is present; dma-map it */
1349 if (cmd->sc_data_direction == DMA_FROM_DEVICE ||
1350 cmd->sc_data_direction == DMA_TO_DEVICE) {
1351 if (unlikely(cmd->request_bufflen < 1)) {
1352 printk(KERN_WARNING "ata%u(%u): WARNING: zero len r/w req\n",
1353 ap->id, dev->devno);
1354 goto err_did;
1357 if (cmd->use_sg)
1358 ata_sg_init(qc, cmd->request_buffer, cmd->use_sg);
1359 else
1360 ata_sg_init_one(qc, cmd->request_buffer,
1361 cmd->request_bufflen);
1363 qc->dma_dir = cmd->sc_data_direction;
1366 qc->complete_fn = ata_scsi_qc_complete;
1368 if (xlat_func(qc, scsicmd))
1369 goto early_finish;
1371 /* select device, send command to hardware */
1372 qc->err_mask = ata_qc_issue(qc);
1373 if (qc->err_mask)
1374 ata_qc_complete(qc);
1376 VPRINTK("EXIT\n");
1377 return;
1379 early_finish:
1380 ata_qc_free(qc);
1381 done(cmd);
1382 DPRINTK("EXIT - early finish (good or error)\n");
1383 return;
1385 err_did:
1386 ata_qc_free(qc);
1387 err_mem:
1388 cmd->result = (DID_ERROR << 16);
1389 done(cmd);
1390 DPRINTK("EXIT - internal\n");
1391 return;
1395 * ata_scsi_rbuf_get - Map response buffer.
1396 * @cmd: SCSI command containing buffer to be mapped.
1397 * @buf_out: Pointer to mapped area.
1399 * Maps buffer contained within SCSI command @cmd.
1401 * LOCKING:
1402 * spin_lock_irqsave(host_set lock)
1404 * RETURNS:
1405 * Length of response buffer.
1408 static unsigned int ata_scsi_rbuf_get(struct scsi_cmnd *cmd, u8 **buf_out)
1410 u8 *buf;
1411 unsigned int buflen;
1413 if (cmd->use_sg) {
1414 struct scatterlist *sg;
1416 sg = (struct scatterlist *) cmd->request_buffer;
1417 buf = kmap_atomic(sg->page, KM_USER0) + sg->offset;
1418 buflen = sg->length;
1419 } else {
1420 buf = cmd->request_buffer;
1421 buflen = cmd->request_bufflen;
1424 *buf_out = buf;
1425 return buflen;
1429 * ata_scsi_rbuf_put - Unmap response buffer.
1430 * @cmd: SCSI command containing buffer to be unmapped.
1431 * @buf: buffer to unmap
1433 * Unmaps response buffer contained within @cmd.
1435 * LOCKING:
1436 * spin_lock_irqsave(host_set lock)
1439 static inline void ata_scsi_rbuf_put(struct scsi_cmnd *cmd, u8 *buf)
1441 if (cmd->use_sg) {
1442 struct scatterlist *sg;
1444 sg = (struct scatterlist *) cmd->request_buffer;
1445 kunmap_atomic(buf - sg->offset, KM_USER0);
1450 * ata_scsi_rbuf_fill - wrapper for SCSI command simulators
1451 * @args: device IDENTIFY data / SCSI command of interest.
1452 * @actor: Callback hook for desired SCSI command simulator
1454 * Takes care of the hard work of simulating a SCSI command...
1455 * Mapping the response buffer, calling the command's handler,
1456 * and handling the handler's return value. This return value
1457 * indicates whether the handler wishes the SCSI command to be
1458 * completed successfully (0), or not (in which case cmd->result
1459 * and sense buffer are assumed to be set).
1461 * LOCKING:
1462 * spin_lock_irqsave(host_set lock)
1465 void ata_scsi_rbuf_fill(struct ata_scsi_args *args,
1466 unsigned int (*actor) (struct ata_scsi_args *args,
1467 u8 *rbuf, unsigned int buflen))
1469 u8 *rbuf;
1470 unsigned int buflen, rc;
1471 struct scsi_cmnd *cmd = args->cmd;
1473 buflen = ata_scsi_rbuf_get(cmd, &rbuf);
1474 memset(rbuf, 0, buflen);
1475 rc = actor(args, rbuf, buflen);
1476 ata_scsi_rbuf_put(cmd, rbuf);
1478 if (rc == 0)
1479 cmd->result = SAM_STAT_GOOD;
1480 args->done(cmd);
1484 * ata_scsiop_inq_std - Simulate INQUIRY command
1485 * @args: device IDENTIFY data / SCSI command of interest.
1486 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1487 * @buflen: Response buffer length.
1489 * Returns standard device identification data associated
1490 * with non-EVPD INQUIRY command output.
1492 * LOCKING:
1493 * spin_lock_irqsave(host_set lock)
1496 unsigned int ata_scsiop_inq_std(struct ata_scsi_args *args, u8 *rbuf,
1497 unsigned int buflen)
1499 u8 hdr[] = {
1500 TYPE_DISK,
1502 0x5, /* claim SPC-3 version compatibility */
1504 95 - 4
1507 /* set scsi removeable (RMB) bit per ata bit */
1508 if (ata_id_removeable(args->id))
1509 hdr[1] |= (1 << 7);
1511 VPRINTK("ENTER\n");
1513 memcpy(rbuf, hdr, sizeof(hdr));
1515 if (buflen > 35) {
1516 memcpy(&rbuf[8], "ATA ", 8);
1517 ata_dev_id_string(args->id, &rbuf[16], ATA_ID_PROD_OFS, 16);
1518 ata_dev_id_string(args->id, &rbuf[32], ATA_ID_FW_REV_OFS, 4);
1519 if (rbuf[32] == 0 || rbuf[32] == ' ')
1520 memcpy(&rbuf[32], "n/a ", 4);
1523 if (buflen > 63) {
1524 const u8 versions[] = {
1525 0x60, /* SAM-3 (no version claimed) */
1527 0x03,
1528 0x20, /* SBC-2 (no version claimed) */
1530 0x02,
1531 0x60 /* SPC-3 (no version claimed) */
1534 memcpy(rbuf + 59, versions, sizeof(versions));
1537 return 0;
1541 * ata_scsiop_inq_00 - Simulate INQUIRY EVPD page 0, list of pages
1542 * @args: device IDENTIFY data / SCSI command of interest.
1543 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1544 * @buflen: Response buffer length.
1546 * Returns list of inquiry EVPD pages available.
1548 * LOCKING:
1549 * spin_lock_irqsave(host_set lock)
1552 unsigned int ata_scsiop_inq_00(struct ata_scsi_args *args, u8 *rbuf,
1553 unsigned int buflen)
1555 const u8 pages[] = {
1556 0x00, /* page 0x00, this page */
1557 0x80, /* page 0x80, unit serial no page */
1558 0x83 /* page 0x83, device ident page */
1560 rbuf[3] = sizeof(pages); /* number of supported EVPD pages */
1562 if (buflen > 6)
1563 memcpy(rbuf + 4, pages, sizeof(pages));
1565 return 0;
1569 * ata_scsiop_inq_80 - Simulate INQUIRY EVPD page 80, device serial number
1570 * @args: device IDENTIFY data / SCSI command of interest.
1571 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1572 * @buflen: Response buffer length.
1574 * Returns ATA device serial number.
1576 * LOCKING:
1577 * spin_lock_irqsave(host_set lock)
1580 unsigned int ata_scsiop_inq_80(struct ata_scsi_args *args, u8 *rbuf,
1581 unsigned int buflen)
1583 const u8 hdr[] = {
1585 0x80, /* this page code */
1587 ATA_SERNO_LEN, /* page len */
1589 memcpy(rbuf, hdr, sizeof(hdr));
1591 if (buflen > (ATA_SERNO_LEN + 4 - 1))
1592 ata_dev_id_string(args->id, (unsigned char *) &rbuf[4],
1593 ATA_ID_SERNO_OFS, ATA_SERNO_LEN);
1595 return 0;
1598 static const char * const inq_83_str = "Linux ATA-SCSI simulator";
1601 * ata_scsiop_inq_83 - Simulate INQUIRY EVPD page 83, device identity
1602 * @args: device IDENTIFY data / SCSI command of interest.
1603 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1604 * @buflen: Response buffer length.
1606 * Returns device identification. Currently hardcoded to
1607 * return "Linux ATA-SCSI simulator".
1609 * LOCKING:
1610 * spin_lock_irqsave(host_set lock)
1613 unsigned int ata_scsiop_inq_83(struct ata_scsi_args *args, u8 *rbuf,
1614 unsigned int buflen)
1616 rbuf[1] = 0x83; /* this page code */
1617 rbuf[3] = 4 + strlen(inq_83_str); /* page len */
1619 /* our one and only identification descriptor (vendor-specific) */
1620 if (buflen > (strlen(inq_83_str) + 4 + 4 - 1)) {
1621 rbuf[4 + 0] = 2; /* code set: ASCII */
1622 rbuf[4 + 3] = strlen(inq_83_str);
1623 memcpy(rbuf + 4 + 4, inq_83_str, strlen(inq_83_str));
1626 return 0;
1630 * ata_scsiop_noop - Command handler that simply returns success.
1631 * @args: device IDENTIFY data / SCSI command of interest.
1632 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1633 * @buflen: Response buffer length.
1635 * No operation. Simply returns success to caller, to indicate
1636 * that the caller should successfully complete this SCSI command.
1638 * LOCKING:
1639 * spin_lock_irqsave(host_set lock)
1642 unsigned int ata_scsiop_noop(struct ata_scsi_args *args, u8 *rbuf,
1643 unsigned int buflen)
1645 VPRINTK("ENTER\n");
1646 return 0;
1650 * ata_msense_push - Push data onto MODE SENSE data output buffer
1651 * @ptr_io: (input/output) Location to store more output data
1652 * @last: End of output data buffer
1653 * @buf: Pointer to BLOB being added to output buffer
1654 * @buflen: Length of BLOB
1656 * Store MODE SENSE data on an output buffer.
1658 * LOCKING:
1659 * None.
1662 static void ata_msense_push(u8 **ptr_io, const u8 *last,
1663 const u8 *buf, unsigned int buflen)
1665 u8 *ptr = *ptr_io;
1667 if ((ptr + buflen - 1) > last)
1668 return;
1670 memcpy(ptr, buf, buflen);
1672 ptr += buflen;
1674 *ptr_io = ptr;
1678 * ata_msense_caching - Simulate MODE SENSE caching info page
1679 * @id: device IDENTIFY data
1680 * @ptr_io: (input/output) Location to store more output data
1681 * @last: End of output data buffer
1683 * Generate a caching info page, which conditionally indicates
1684 * write caching to the SCSI layer, depending on device
1685 * capabilities.
1687 * LOCKING:
1688 * None.
1691 static unsigned int ata_msense_caching(u16 *id, u8 **ptr_io,
1692 const u8 *last)
1694 u8 page[CACHE_MPAGE_LEN];
1696 memcpy(page, def_cache_mpage, sizeof(page));
1697 if (ata_id_wcache_enabled(id))
1698 page[2] |= (1 << 2); /* write cache enable */
1699 if (!ata_id_rahead_enabled(id))
1700 page[12] |= (1 << 5); /* disable read ahead */
1702 ata_msense_push(ptr_io, last, page, sizeof(page));
1703 return sizeof(page);
1707 * ata_msense_ctl_mode - Simulate MODE SENSE control mode page
1708 * @dev: Device associated with this MODE SENSE command
1709 * @ptr_io: (input/output) Location to store more output data
1710 * @last: End of output data buffer
1712 * Generate a generic MODE SENSE control mode page.
1714 * LOCKING:
1715 * None.
1718 static unsigned int ata_msense_ctl_mode(u8 **ptr_io, const u8 *last)
1720 ata_msense_push(ptr_io, last, def_control_mpage,
1721 sizeof(def_control_mpage));
1722 return sizeof(def_control_mpage);
1726 * ata_msense_rw_recovery - Simulate MODE SENSE r/w error recovery page
1727 * @dev: Device associated with this MODE SENSE command
1728 * @ptr_io: (input/output) Location to store more output data
1729 * @last: End of output data buffer
1731 * Generate a generic MODE SENSE r/w error recovery page.
1733 * LOCKING:
1734 * None.
1737 static unsigned int ata_msense_rw_recovery(u8 **ptr_io, const u8 *last)
1740 ata_msense_push(ptr_io, last, def_rw_recovery_mpage,
1741 sizeof(def_rw_recovery_mpage));
1742 return sizeof(def_rw_recovery_mpage);
1746 * We can turn this into a real blacklist if it's needed, for now just
1747 * blacklist any Maxtor BANC1G10 revision firmware
1749 static int ata_dev_supports_fua(u16 *id)
1751 unsigned char model[41], fw[9];
1753 if (!ata_id_has_fua(id))
1754 return 0;
1756 model[40] = '\0';
1757 fw[8] = '\0';
1759 ata_dev_id_string(id, model, ATA_ID_PROD_OFS, sizeof(model) - 1);
1760 ata_dev_id_string(id, fw, ATA_ID_FW_REV_OFS, sizeof(fw) - 1);
1762 if (strncmp(model, "Maxtor", 6))
1763 return 1;
1764 if (strncmp(fw, "BANC1G10", 8))
1765 return 1;
1767 return 0; /* blacklisted */
1771 * ata_scsiop_mode_sense - Simulate MODE SENSE 6, 10 commands
1772 * @args: device IDENTIFY data / SCSI command of interest.
1773 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1774 * @buflen: Response buffer length.
1776 * Simulate MODE SENSE commands. Assume this is invoked for direct
1777 * access devices (e.g. disks) only. There should be no block
1778 * descriptor for other device types.
1780 * LOCKING:
1781 * spin_lock_irqsave(host_set lock)
1784 unsigned int ata_scsiop_mode_sense(struct ata_scsi_args *args, u8 *rbuf,
1785 unsigned int buflen)
1787 struct ata_device *dev = args->dev;
1788 u8 *scsicmd = args->cmd->cmnd, *p, *last;
1789 const u8 sat_blk_desc[] = {
1790 0, 0, 0, 0, /* number of blocks: sat unspecified */
1792 0, 0x2, 0x0 /* block length: 512 bytes */
1794 u8 pg, spg;
1795 unsigned int ebd, page_control, six_byte, output_len, alloc_len, minlen;
1796 u8 dpofua;
1798 VPRINTK("ENTER\n");
1800 six_byte = (scsicmd[0] == MODE_SENSE);
1801 ebd = !(scsicmd[1] & 0x8); /* dbd bit inverted == edb */
1803 * LLBA bit in msense(10) ignored (compliant)
1806 page_control = scsicmd[2] >> 6;
1807 switch (page_control) {
1808 case 0: /* current */
1809 break; /* supported */
1810 case 3: /* saved */
1811 goto saving_not_supp;
1812 case 1: /* changeable */
1813 case 2: /* defaults */
1814 default:
1815 goto invalid_fld;
1818 if (six_byte) {
1819 output_len = 4 + (ebd ? 8 : 0);
1820 alloc_len = scsicmd[4];
1821 } else {
1822 output_len = 8 + (ebd ? 8 : 0);
1823 alloc_len = (scsicmd[7] << 8) + scsicmd[8];
1825 minlen = (alloc_len < buflen) ? alloc_len : buflen;
1827 p = rbuf + output_len;
1828 last = rbuf + minlen - 1;
1830 pg = scsicmd[2] & 0x3f;
1831 spg = scsicmd[3];
1833 * No mode subpages supported (yet) but asking for _all_
1834 * subpages may be valid
1836 if (spg && (spg != ALL_SUB_MPAGES))
1837 goto invalid_fld;
1839 switch(pg) {
1840 case RW_RECOVERY_MPAGE:
1841 output_len += ata_msense_rw_recovery(&p, last);
1842 break;
1844 case CACHE_MPAGE:
1845 output_len += ata_msense_caching(args->id, &p, last);
1846 break;
1848 case CONTROL_MPAGE: {
1849 output_len += ata_msense_ctl_mode(&p, last);
1850 break;
1853 case ALL_MPAGES:
1854 output_len += ata_msense_rw_recovery(&p, last);
1855 output_len += ata_msense_caching(args->id, &p, last);
1856 output_len += ata_msense_ctl_mode(&p, last);
1857 break;
1859 default: /* invalid page code */
1860 goto invalid_fld;
1863 if (minlen < 1)
1864 return 0;
1866 dpofua = 0;
1867 if (ata_dev_supports_fua(args->id) && dev->flags & ATA_DFLAG_LBA48 &&
1868 (!(dev->flags & ATA_DFLAG_PIO) || dev->multi_count))
1869 dpofua = 1 << 4;
1871 if (six_byte) {
1872 output_len--;
1873 rbuf[0] = output_len;
1874 if (minlen > 2)
1875 rbuf[2] |= dpofua;
1876 if (ebd) {
1877 if (minlen > 3)
1878 rbuf[3] = sizeof(sat_blk_desc);
1879 if (minlen > 11)
1880 memcpy(rbuf + 4, sat_blk_desc,
1881 sizeof(sat_blk_desc));
1883 } else {
1884 output_len -= 2;
1885 rbuf[0] = output_len >> 8;
1886 if (minlen > 1)
1887 rbuf[1] = output_len;
1888 if (minlen > 3)
1889 rbuf[3] |= dpofua;
1890 if (ebd) {
1891 if (minlen > 7)
1892 rbuf[7] = sizeof(sat_blk_desc);
1893 if (minlen > 15)
1894 memcpy(rbuf + 8, sat_blk_desc,
1895 sizeof(sat_blk_desc));
1898 return 0;
1900 invalid_fld:
1901 ata_scsi_set_sense(args->cmd, ILLEGAL_REQUEST, 0x24, 0x0);
1902 /* "Invalid field in cbd" */
1903 return 1;
1905 saving_not_supp:
1906 ata_scsi_set_sense(args->cmd, ILLEGAL_REQUEST, 0x39, 0x0);
1907 /* "Saving parameters not supported" */
1908 return 1;
1912 * ata_scsiop_read_cap - Simulate READ CAPACITY[ 16] commands
1913 * @args: device IDENTIFY data / SCSI command of interest.
1914 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1915 * @buflen: Response buffer length.
1917 * Simulate READ CAPACITY commands.
1919 * LOCKING:
1920 * spin_lock_irqsave(host_set lock)
1923 unsigned int ata_scsiop_read_cap(struct ata_scsi_args *args, u8 *rbuf,
1924 unsigned int buflen)
1926 u64 n_sectors;
1927 u32 tmp;
1929 VPRINTK("ENTER\n");
1931 if (ata_id_has_lba(args->id)) {
1932 if (ata_id_has_lba48(args->id))
1933 n_sectors = ata_id_u64(args->id, 100);
1934 else
1935 n_sectors = ata_id_u32(args->id, 60);
1936 } else {
1937 /* CHS default translation */
1938 n_sectors = args->id[1] * args->id[3] * args->id[6];
1940 if (ata_id_current_chs_valid(args->id))
1941 /* CHS current translation */
1942 n_sectors = ata_id_u32(args->id, 57);
1945 n_sectors--; /* ATA TotalUserSectors - 1 */
1947 if (args->cmd->cmnd[0] == READ_CAPACITY) {
1948 if( n_sectors >= 0xffffffffULL )
1949 tmp = 0xffffffff ; /* Return max count on overflow */
1950 else
1951 tmp = n_sectors ;
1953 /* sector count, 32-bit */
1954 rbuf[0] = tmp >> (8 * 3);
1955 rbuf[1] = tmp >> (8 * 2);
1956 rbuf[2] = tmp >> (8 * 1);
1957 rbuf[3] = tmp;
1959 /* sector size */
1960 tmp = ATA_SECT_SIZE;
1961 rbuf[6] = tmp >> 8;
1962 rbuf[7] = tmp;
1964 } else {
1965 /* sector count, 64-bit */
1966 tmp = n_sectors >> (8 * 4);
1967 rbuf[2] = tmp >> (8 * 3);
1968 rbuf[3] = tmp >> (8 * 2);
1969 rbuf[4] = tmp >> (8 * 1);
1970 rbuf[5] = tmp;
1971 tmp = n_sectors;
1972 rbuf[6] = tmp >> (8 * 3);
1973 rbuf[7] = tmp >> (8 * 2);
1974 rbuf[8] = tmp >> (8 * 1);
1975 rbuf[9] = tmp;
1977 /* sector size */
1978 tmp = ATA_SECT_SIZE;
1979 rbuf[12] = tmp >> 8;
1980 rbuf[13] = tmp;
1983 return 0;
1987 * ata_scsiop_report_luns - Simulate REPORT LUNS command
1988 * @args: device IDENTIFY data / SCSI command of interest.
1989 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1990 * @buflen: Response buffer length.
1992 * Simulate REPORT LUNS command.
1994 * LOCKING:
1995 * spin_lock_irqsave(host_set lock)
1998 unsigned int ata_scsiop_report_luns(struct ata_scsi_args *args, u8 *rbuf,
1999 unsigned int buflen)
2001 VPRINTK("ENTER\n");
2002 rbuf[3] = 8; /* just one lun, LUN 0, size 8 bytes */
2004 return 0;
2008 * ata_scsi_set_sense - Set SCSI sense data and status
2009 * @cmd: SCSI request to be handled
2010 * @sk: SCSI-defined sense key
2011 * @asc: SCSI-defined additional sense code
2012 * @ascq: SCSI-defined additional sense code qualifier
2014 * Helper function that builds a valid fixed format, current
2015 * response code and the given sense key (sk), additional sense
2016 * code (asc) and additional sense code qualifier (ascq) with
2017 * a SCSI command status of %SAM_STAT_CHECK_CONDITION and
2018 * DRIVER_SENSE set in the upper bits of scsi_cmnd::result .
2020 * LOCKING:
2021 * Not required
2024 void ata_scsi_set_sense(struct scsi_cmnd *cmd, u8 sk, u8 asc, u8 ascq)
2026 cmd->result = (DRIVER_SENSE << 24) | SAM_STAT_CHECK_CONDITION;
2028 cmd->sense_buffer[0] = 0x70; /* fixed format, current */
2029 cmd->sense_buffer[2] = sk;
2030 cmd->sense_buffer[7] = 18 - 8; /* additional sense length */
2031 cmd->sense_buffer[12] = asc;
2032 cmd->sense_buffer[13] = ascq;
2036 * ata_scsi_badcmd - End a SCSI request with an error
2037 * @cmd: SCSI request to be handled
2038 * @done: SCSI command completion function
2039 * @asc: SCSI-defined additional sense code
2040 * @ascq: SCSI-defined additional sense code qualifier
2042 * Helper function that completes a SCSI command with
2043 * %SAM_STAT_CHECK_CONDITION, with a sense key %ILLEGAL_REQUEST
2044 * and the specified additional sense codes.
2046 * LOCKING:
2047 * spin_lock_irqsave(host_set lock)
2050 void ata_scsi_badcmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *), u8 asc, u8 ascq)
2052 DPRINTK("ENTER\n");
2053 ata_scsi_set_sense(cmd, ILLEGAL_REQUEST, asc, ascq);
2055 done(cmd);
2058 static void atapi_sense_complete(struct ata_queued_cmd *qc)
2060 if (qc->err_mask && ((qc->err_mask & AC_ERR_DEV) == 0))
2061 /* FIXME: not quite right; we don't want the
2062 * translation of taskfile registers into
2063 * a sense descriptors, since that's only
2064 * correct for ATA, not ATAPI
2066 ata_gen_ata_desc_sense(qc);
2068 qc->scsidone(qc->scsicmd);
2069 ata_qc_free(qc);
2072 /* is it pointless to prefer PIO for "safety reasons"? */
2073 static inline int ata_pio_use_silly(struct ata_port *ap)
2075 return (ap->flags & ATA_FLAG_PIO_DMA);
2078 static void atapi_request_sense(struct ata_queued_cmd *qc)
2080 struct ata_port *ap = qc->ap;
2081 struct scsi_cmnd *cmd = qc->scsicmd;
2083 DPRINTK("ATAPI request sense\n");
2085 /* FIXME: is this needed? */
2086 memset(cmd->sense_buffer, 0, sizeof(cmd->sense_buffer));
2088 ap->ops->tf_read(ap, &qc->tf);
2090 /* fill these in, for the case where they are -not- overwritten */
2091 cmd->sense_buffer[0] = 0x70;
2092 cmd->sense_buffer[2] = qc->tf.feature >> 4;
2094 ata_qc_reinit(qc);
2096 ata_sg_init_one(qc, cmd->sense_buffer, sizeof(cmd->sense_buffer));
2097 qc->dma_dir = DMA_FROM_DEVICE;
2099 memset(&qc->cdb, 0, ap->cdb_len);
2100 qc->cdb[0] = REQUEST_SENSE;
2101 qc->cdb[4] = SCSI_SENSE_BUFFERSIZE;
2103 qc->tf.flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
2104 qc->tf.command = ATA_CMD_PACKET;
2106 if (ata_pio_use_silly(ap)) {
2107 qc->tf.protocol = ATA_PROT_ATAPI_DMA;
2108 qc->tf.feature |= ATAPI_PKT_DMA;
2109 } else {
2110 qc->tf.protocol = ATA_PROT_ATAPI;
2111 qc->tf.lbam = (8 * 1024) & 0xff;
2112 qc->tf.lbah = (8 * 1024) >> 8;
2114 qc->nbytes = SCSI_SENSE_BUFFERSIZE;
2116 qc->complete_fn = atapi_sense_complete;
2118 qc->err_mask = ata_qc_issue(qc);
2119 if (qc->err_mask)
2120 ata_qc_complete(qc);
2122 DPRINTK("EXIT\n");
2125 static void atapi_qc_complete(struct ata_queued_cmd *qc)
2127 struct scsi_cmnd *cmd = qc->scsicmd;
2128 unsigned int err_mask = qc->err_mask;
2130 VPRINTK("ENTER, err_mask 0x%X\n", err_mask);
2132 if (unlikely(err_mask & AC_ERR_DEV)) {
2133 cmd->result = SAM_STAT_CHECK_CONDITION;
2134 atapi_request_sense(qc);
2135 return;
2138 else if (unlikely(err_mask))
2139 /* FIXME: not quite right; we don't want the
2140 * translation of taskfile registers into
2141 * a sense descriptors, since that's only
2142 * correct for ATA, not ATAPI
2144 ata_gen_ata_desc_sense(qc);
2146 else {
2147 u8 *scsicmd = cmd->cmnd;
2149 if ((scsicmd[0] == INQUIRY) && ((scsicmd[1] & 0x03) == 0)) {
2150 u8 *buf = NULL;
2151 unsigned int buflen;
2153 buflen = ata_scsi_rbuf_get(cmd, &buf);
2155 /* ATAPI devices typically report zero for their SCSI version,
2156 * and sometimes deviate from the spec WRT response data
2157 * format. If SCSI version is reported as zero like normal,
2158 * then we make the following fixups: 1) Fake MMC-5 version,
2159 * to indicate to the Linux scsi midlayer this is a modern
2160 * device. 2) Ensure response data format / ATAPI information
2161 * are always correct.
2163 if (buf[2] == 0) {
2164 buf[2] = 0x5;
2165 buf[3] = 0x32;
2168 ata_scsi_rbuf_put(cmd, buf);
2171 cmd->result = SAM_STAT_GOOD;
2174 qc->scsidone(cmd);
2175 ata_qc_free(qc);
2178 * atapi_xlat - Initialize PACKET taskfile
2179 * @qc: command structure to be initialized
2180 * @scsicmd: SCSI CDB associated with this PACKET command
2182 * LOCKING:
2183 * spin_lock_irqsave(host_set lock)
2185 * RETURNS:
2186 * Zero on success, non-zero on failure.
2189 static unsigned int atapi_xlat(struct ata_queued_cmd *qc, const u8 *scsicmd)
2191 struct scsi_cmnd *cmd = qc->scsicmd;
2192 struct ata_device *dev = qc->dev;
2193 int using_pio = (dev->flags & ATA_DFLAG_PIO);
2194 int nodata = (cmd->sc_data_direction == DMA_NONE);
2196 if (!using_pio)
2197 /* Check whether ATAPI DMA is safe */
2198 if (ata_check_atapi_dma(qc))
2199 using_pio = 1;
2201 memcpy(&qc->cdb, scsicmd, qc->ap->cdb_len);
2203 qc->complete_fn = atapi_qc_complete;
2205 qc->tf.flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
2206 if (cmd->sc_data_direction == DMA_TO_DEVICE) {
2207 qc->tf.flags |= ATA_TFLAG_WRITE;
2208 DPRINTK("direction: write\n");
2211 qc->tf.command = ATA_CMD_PACKET;
2213 /* no data, or PIO data xfer */
2214 if (using_pio || nodata) {
2215 if (nodata)
2216 qc->tf.protocol = ATA_PROT_ATAPI_NODATA;
2217 else
2218 qc->tf.protocol = ATA_PROT_ATAPI;
2219 qc->tf.lbam = (8 * 1024) & 0xff;
2220 qc->tf.lbah = (8 * 1024) >> 8;
2223 /* DMA data xfer */
2224 else {
2225 qc->tf.protocol = ATA_PROT_ATAPI_DMA;
2226 qc->tf.feature |= ATAPI_PKT_DMA;
2228 #ifdef ATAPI_ENABLE_DMADIR
2229 /* some SATA bridges need us to indicate data xfer direction */
2230 if (cmd->sc_data_direction != DMA_TO_DEVICE)
2231 qc->tf.feature |= ATAPI_DMADIR;
2232 #endif
2235 qc->nbytes = cmd->bufflen;
2237 return 0;
2241 * ata_scsi_find_dev - lookup ata_device from scsi_cmnd
2242 * @ap: ATA port to which the device is attached
2243 * @scsidev: SCSI device from which we derive the ATA device
2245 * Given various information provided in struct scsi_cmnd,
2246 * map that onto an ATA bus, and using that mapping
2247 * determine which ata_device is associated with the
2248 * SCSI command to be sent.
2250 * LOCKING:
2251 * spin_lock_irqsave(host_set lock)
2253 * RETURNS:
2254 * Associated ATA device, or %NULL if not found.
2257 static struct ata_device *
2258 ata_scsi_find_dev(struct ata_port *ap, const struct scsi_device *scsidev)
2260 struct ata_device *dev;
2262 /* skip commands not addressed to targets we simulate */
2263 if (likely(scsidev->id < ATA_MAX_DEVICES))
2264 dev = &ap->device[scsidev->id];
2265 else
2266 return NULL;
2268 if (unlikely((scsidev->channel != 0) ||
2269 (scsidev->lun != 0)))
2270 return NULL;
2272 if (unlikely(!ata_dev_present(dev)))
2273 return NULL;
2275 if (!atapi_enabled || (ap->flags & ATA_FLAG_NO_ATAPI)) {
2276 if (unlikely(dev->class == ATA_DEV_ATAPI)) {
2277 printk(KERN_WARNING "ata%u(%u): WARNING: ATAPI is %s, device ignored.\n",
2278 ap->id, dev->devno, atapi_enabled ? "not supported with this driver" : "disabled");
2279 return NULL;
2283 return dev;
2287 * ata_scsi_map_proto - Map pass-thru protocol value to taskfile value.
2288 * @byte1: Byte 1 from pass-thru CDB.
2290 * RETURNS:
2291 * ATA_PROT_UNKNOWN if mapping failed/unimplemented, protocol otherwise.
2293 static u8
2294 ata_scsi_map_proto(u8 byte1)
2296 switch((byte1 & 0x1e) >> 1) {
2297 case 3: /* Non-data */
2298 return ATA_PROT_NODATA;
2300 case 6: /* DMA */
2301 return ATA_PROT_DMA;
2303 case 4: /* PIO Data-in */
2304 case 5: /* PIO Data-out */
2305 if (byte1 & 0xe0) {
2306 return ATA_PROT_PIO_MULT;
2308 return ATA_PROT_PIO;
2310 case 10: /* Device Reset */
2311 case 0: /* Hard Reset */
2312 case 1: /* SRST */
2313 case 2: /* Bus Idle */
2314 case 7: /* Packet */
2315 case 8: /* DMA Queued */
2316 case 9: /* Device Diagnostic */
2317 case 11: /* UDMA Data-in */
2318 case 12: /* UDMA Data-Out */
2319 case 13: /* FPDMA */
2320 default: /* Reserved */
2321 break;
2324 return ATA_PROT_UNKNOWN;
2328 * ata_scsi_pass_thru - convert ATA pass-thru CDB to taskfile
2329 * @qc: command structure to be initialized
2330 * @scsicmd: SCSI command to convert
2332 * Handles either 12 or 16-byte versions of the CDB.
2334 * RETURNS:
2335 * Zero on success, non-zero on failure.
2337 static unsigned int
2338 ata_scsi_pass_thru(struct ata_queued_cmd *qc, const u8 *scsicmd)
2340 struct ata_taskfile *tf = &(qc->tf);
2341 struct scsi_cmnd *cmd = qc->scsicmd;
2343 if ((tf->protocol = ata_scsi_map_proto(scsicmd[1])) == ATA_PROT_UNKNOWN)
2344 goto invalid_fld;
2347 * 12 and 16 byte CDBs use different offsets to
2348 * provide the various register values.
2350 if (scsicmd[0] == ATA_16) {
2352 * 16-byte CDB - may contain extended commands.
2354 * If that is the case, copy the upper byte register values.
2356 if (scsicmd[1] & 0x01) {
2357 tf->hob_feature = scsicmd[3];
2358 tf->hob_nsect = scsicmd[5];
2359 tf->hob_lbal = scsicmd[7];
2360 tf->hob_lbam = scsicmd[9];
2361 tf->hob_lbah = scsicmd[11];
2362 tf->flags |= ATA_TFLAG_LBA48;
2363 } else
2364 tf->flags &= ~ATA_TFLAG_LBA48;
2367 * Always copy low byte, device and command registers.
2369 tf->feature = scsicmd[4];
2370 tf->nsect = scsicmd[6];
2371 tf->lbal = scsicmd[8];
2372 tf->lbam = scsicmd[10];
2373 tf->lbah = scsicmd[12];
2374 tf->device = scsicmd[13];
2375 tf->command = scsicmd[14];
2376 } else {
2378 * 12-byte CDB - incapable of extended commands.
2380 tf->flags &= ~ATA_TFLAG_LBA48;
2382 tf->feature = scsicmd[3];
2383 tf->nsect = scsicmd[4];
2384 tf->lbal = scsicmd[5];
2385 tf->lbam = scsicmd[6];
2386 tf->lbah = scsicmd[7];
2387 tf->device = scsicmd[8];
2388 tf->command = scsicmd[9];
2391 * If slave is possible, enforce correct master/slave bit
2393 if (qc->ap->flags & ATA_FLAG_SLAVE_POSS)
2394 tf->device = qc->dev->devno ?
2395 tf->device | ATA_DEV1 : tf->device & ~ATA_DEV1;
2398 * Filter SET_FEATURES - XFER MODE command -- otherwise,
2399 * SET_FEATURES - XFER MODE must be preceded/succeeded
2400 * by an update to hardware-specific registers for each
2401 * controller (i.e. the reason for ->set_piomode(),
2402 * ->set_dmamode(), and ->post_set_mode() hooks).
2404 if ((tf->command == ATA_CMD_SET_FEATURES)
2405 && (tf->feature == SETFEATURES_XFER))
2406 goto invalid_fld;
2409 * Set flags so that all registers will be written,
2410 * and pass on write indication (used for PIO/DMA
2411 * setup.)
2413 tf->flags |= (ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE);
2415 if (cmd->sc_data_direction == DMA_TO_DEVICE)
2416 tf->flags |= ATA_TFLAG_WRITE;
2419 * Set transfer length.
2421 * TODO: find out if we need to do more here to
2422 * cover scatter/gather case.
2424 qc->nsect = cmd->bufflen / ATA_SECT_SIZE;
2426 return 0;
2428 invalid_fld:
2429 ata_scsi_set_sense(qc->scsicmd, ILLEGAL_REQUEST, 0x24, 0x00);
2430 /* "Invalid field in cdb" */
2431 return 1;
2435 * ata_get_xlat_func - check if SCSI to ATA translation is possible
2436 * @dev: ATA device
2437 * @cmd: SCSI command opcode to consider
2439 * Look up the SCSI command given, and determine whether the
2440 * SCSI command is to be translated or simulated.
2442 * RETURNS:
2443 * Pointer to translation function if possible, %NULL if not.
2446 static inline ata_xlat_func_t ata_get_xlat_func(struct ata_device *dev, u8 cmd)
2448 switch (cmd) {
2449 case READ_6:
2450 case READ_10:
2451 case READ_16:
2453 case WRITE_6:
2454 case WRITE_10:
2455 case WRITE_16:
2456 return ata_scsi_rw_xlat;
2458 case SYNCHRONIZE_CACHE:
2459 if (ata_try_flush_cache(dev))
2460 return ata_scsi_flush_xlat;
2461 break;
2463 case VERIFY:
2464 case VERIFY_16:
2465 return ata_scsi_verify_xlat;
2467 case ATA_12:
2468 case ATA_16:
2469 return ata_scsi_pass_thru;
2471 case START_STOP:
2472 return ata_scsi_start_stop_xlat;
2475 return NULL;
2479 * ata_scsi_dump_cdb - dump SCSI command contents to dmesg
2480 * @ap: ATA port to which the command was being sent
2481 * @cmd: SCSI command to dump
2483 * Prints the contents of a SCSI command via printk().
2486 static inline void ata_scsi_dump_cdb(struct ata_port *ap,
2487 struct scsi_cmnd *cmd)
2489 #ifdef ATA_DEBUG
2490 struct scsi_device *scsidev = cmd->device;
2491 u8 *scsicmd = cmd->cmnd;
2493 DPRINTK("CDB (%u:%d,%d,%d) %02x %02x %02x %02x %02x %02x %02x %02x %02x\n",
2494 ap->id,
2495 scsidev->channel, scsidev->id, scsidev->lun,
2496 scsicmd[0], scsicmd[1], scsicmd[2], scsicmd[3],
2497 scsicmd[4], scsicmd[5], scsicmd[6], scsicmd[7],
2498 scsicmd[8]);
2499 #endif
2503 * ata_scsi_queuecmd - Issue SCSI cdb to libata-managed device
2504 * @cmd: SCSI command to be sent
2505 * @done: Completion function, called when command is complete
2507 * In some cases, this function translates SCSI commands into
2508 * ATA taskfiles, and queues the taskfiles to be sent to
2509 * hardware. In other cases, this function simulates a
2510 * SCSI device by evaluating and responding to certain
2511 * SCSI commands. This creates the overall effect of
2512 * ATA and ATAPI devices appearing as SCSI devices.
2514 * LOCKING:
2515 * Releases scsi-layer-held lock, and obtains host_set lock.
2517 * RETURNS:
2518 * Zero.
2521 int ata_scsi_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *))
2523 struct ata_port *ap;
2524 struct ata_device *dev;
2525 struct scsi_device *scsidev = cmd->device;
2526 struct Scsi_Host *shost = scsidev->host;
2528 ap = (struct ata_port *) &shost->hostdata[0];
2530 spin_unlock(shost->host_lock);
2531 spin_lock(&ap->host_set->lock);
2533 ata_scsi_dump_cdb(ap, cmd);
2535 dev = ata_scsi_find_dev(ap, scsidev);
2536 if (unlikely(!dev)) {
2537 cmd->result = (DID_BAD_TARGET << 16);
2538 done(cmd);
2539 goto out_unlock;
2542 if (dev->class == ATA_DEV_ATA) {
2543 ata_xlat_func_t xlat_func = ata_get_xlat_func(dev,
2544 cmd->cmnd[0]);
2546 if (xlat_func)
2547 ata_scsi_translate(ap, dev, cmd, done, xlat_func);
2548 else
2549 ata_scsi_simulate(ap, dev, cmd, done);
2550 } else
2551 ata_scsi_translate(ap, dev, cmd, done, atapi_xlat);
2553 out_unlock:
2554 spin_unlock(&ap->host_set->lock);
2555 spin_lock(shost->host_lock);
2556 return 0;
2560 * ata_scsi_simulate - simulate SCSI command on ATA device
2561 * @ap: port the device is connected to
2562 * @dev: the target device
2563 * @cmd: SCSI command being sent to device.
2564 * @done: SCSI command completion function.
2566 * Interprets and directly executes a select list of SCSI commands
2567 * that can be handled internally.
2569 * LOCKING:
2570 * spin_lock_irqsave(host_set lock)
2573 void ata_scsi_simulate(struct ata_port *ap, struct ata_device *dev,
2574 struct scsi_cmnd *cmd,
2575 void (*done)(struct scsi_cmnd *))
2577 struct ata_scsi_args args;
2578 const u8 *scsicmd = cmd->cmnd;
2580 args.ap = ap;
2581 args.dev = dev;
2582 args.id = dev->id;
2583 args.cmd = cmd;
2584 args.done = done;
2586 switch(scsicmd[0]) {
2587 /* no-op's, complete with success */
2588 case SYNCHRONIZE_CACHE:
2589 case REZERO_UNIT:
2590 case SEEK_6:
2591 case SEEK_10:
2592 case TEST_UNIT_READY:
2593 case FORMAT_UNIT: /* FIXME: correct? */
2594 case SEND_DIAGNOSTIC: /* FIXME: correct? */
2595 ata_scsi_rbuf_fill(&args, ata_scsiop_noop);
2596 break;
2598 case INQUIRY:
2599 if (scsicmd[1] & 2) /* is CmdDt set? */
2600 ata_scsi_invalid_field(cmd, done);
2601 else if ((scsicmd[1] & 1) == 0) /* is EVPD clear? */
2602 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_std);
2603 else if (scsicmd[2] == 0x00)
2604 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_00);
2605 else if (scsicmd[2] == 0x80)
2606 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_80);
2607 else if (scsicmd[2] == 0x83)
2608 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_83);
2609 else
2610 ata_scsi_invalid_field(cmd, done);
2611 break;
2613 case MODE_SENSE:
2614 case MODE_SENSE_10:
2615 ata_scsi_rbuf_fill(&args, ata_scsiop_mode_sense);
2616 break;
2618 case MODE_SELECT: /* unconditionally return */
2619 case MODE_SELECT_10: /* bad-field-in-cdb */
2620 ata_scsi_invalid_field(cmd, done);
2621 break;
2623 case READ_CAPACITY:
2624 ata_scsi_rbuf_fill(&args, ata_scsiop_read_cap);
2625 break;
2627 case SERVICE_ACTION_IN:
2628 if ((scsicmd[1] & 0x1f) == SAI_READ_CAPACITY_16)
2629 ata_scsi_rbuf_fill(&args, ata_scsiop_read_cap);
2630 else
2631 ata_scsi_invalid_field(cmd, done);
2632 break;
2634 case REPORT_LUNS:
2635 ata_scsi_rbuf_fill(&args, ata_scsiop_report_luns);
2636 break;
2638 /* mandatory commands we haven't implemented yet */
2639 case REQUEST_SENSE:
2641 /* all other commands */
2642 default:
2643 ata_scsi_set_sense(cmd, ILLEGAL_REQUEST, 0x20, 0x0);
2644 /* "Invalid command operation code" */
2645 done(cmd);
2646 break;
2650 void ata_scsi_scan_host(struct ata_port *ap)
2652 struct ata_device *dev;
2653 unsigned int i;
2655 if (ap->flags & ATA_FLAG_PORT_DISABLED)
2656 return;
2658 for (i = 0; i < ATA_MAX_DEVICES; i++) {
2659 dev = &ap->device[i];
2661 if (ata_dev_present(dev))
2662 scsi_scan_target(&ap->host->shost_gendev, 0, i, 0, 0);