[PATCH] libata-eh-fw: update SCSI command completion path for new EH
[linux-2.6/kmemtrace.git] / drivers / scsi / libata-scsi.c
blobe61cc357ae4ade99515c49fcbf196b85f142e72d
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 <scsi/scsi_transport.h>
45 #include <linux/libata.h>
46 #include <linux/hdreg.h>
47 #include <asm/uaccess.h>
49 #include "libata.h"
51 #define SECTOR_SIZE 512
53 typedef unsigned int (*ata_xlat_func_t)(struct ata_queued_cmd *qc, const u8 *scsicmd);
54 static struct ata_device *
55 ata_scsi_find_dev(struct ata_port *ap, const struct scsi_device *scsidev);
57 #define RW_RECOVERY_MPAGE 0x1
58 #define RW_RECOVERY_MPAGE_LEN 12
59 #define CACHE_MPAGE 0x8
60 #define CACHE_MPAGE_LEN 20
61 #define CONTROL_MPAGE 0xa
62 #define CONTROL_MPAGE_LEN 12
63 #define ALL_MPAGES 0x3f
64 #define ALL_SUB_MPAGES 0xff
67 static const u8 def_rw_recovery_mpage[] = {
68 RW_RECOVERY_MPAGE,
69 RW_RECOVERY_MPAGE_LEN - 2,
70 (1 << 7) | /* AWRE, sat-r06 say it shall be 0 */
71 (1 << 6), /* ARRE (auto read reallocation) */
72 0, /* read retry count */
73 0, 0, 0, 0,
74 0, /* write retry count */
75 0, 0, 0
78 static const u8 def_cache_mpage[CACHE_MPAGE_LEN] = {
79 CACHE_MPAGE,
80 CACHE_MPAGE_LEN - 2,
81 0, /* contains WCE, needs to be 0 for logic */
82 0, 0, 0, 0, 0, 0, 0, 0, 0,
83 0, /* contains DRA, needs to be 0 for logic */
84 0, 0, 0, 0, 0, 0, 0
87 static const u8 def_control_mpage[CONTROL_MPAGE_LEN] = {
88 CONTROL_MPAGE,
89 CONTROL_MPAGE_LEN - 2,
90 2, /* DSENSE=0, GLTSD=1 */
91 0, /* [QAM+QERR may be 1, see 05-359r1] */
92 0, 0, 0, 0, 0xff, 0xff,
93 0, 30 /* extended self test time, see 05-359r1 */
97 * libata transport template. libata doesn't do real transport stuff.
98 * It just needs the eh_timed_out hook.
100 struct scsi_transport_template ata_scsi_transport_template = {
101 .eh_strategy_handler = ata_scsi_error,
102 .eh_timed_out = ata_scsi_timed_out,
106 static void ata_scsi_invalid_field(struct scsi_cmnd *cmd,
107 void (*done)(struct scsi_cmnd *))
109 ata_scsi_set_sense(cmd, ILLEGAL_REQUEST, 0x24, 0x0);
110 /* "Invalid field in cbd" */
111 done(cmd);
115 * ata_std_bios_param - generic bios head/sector/cylinder calculator used by sd.
116 * @sdev: SCSI device for which BIOS geometry is to be determined
117 * @bdev: block device associated with @sdev
118 * @capacity: capacity of SCSI device
119 * @geom: location to which geometry will be output
121 * Generic bios head/sector/cylinder calculator
122 * used by sd. Most BIOSes nowadays expect a XXX/255/16 (CHS)
123 * mapping. Some situations may arise where the disk is not
124 * bootable if this is not used.
126 * LOCKING:
127 * Defined by the SCSI layer. We don't really care.
129 * RETURNS:
130 * Zero.
132 int ata_std_bios_param(struct scsi_device *sdev, struct block_device *bdev,
133 sector_t capacity, int geom[])
135 geom[0] = 255;
136 geom[1] = 63;
137 sector_div(capacity, 255*63);
138 geom[2] = capacity;
140 return 0;
144 * ata_cmd_ioctl - Handler for HDIO_DRIVE_CMD ioctl
145 * @scsidev: Device to which we are issuing command
146 * @arg: User provided data for issuing command
148 * LOCKING:
149 * Defined by the SCSI layer. We don't really care.
151 * RETURNS:
152 * Zero on success, negative errno on error.
155 int ata_cmd_ioctl(struct scsi_device *scsidev, void __user *arg)
157 int rc = 0;
158 u8 scsi_cmd[MAX_COMMAND_SIZE];
159 u8 args[4], *argbuf = NULL;
160 int argsize = 0;
161 struct scsi_sense_hdr sshdr;
162 enum dma_data_direction data_dir;
164 if (arg == NULL)
165 return -EINVAL;
167 if (copy_from_user(args, arg, sizeof(args)))
168 return -EFAULT;
170 memset(scsi_cmd, 0, sizeof(scsi_cmd));
172 if (args[3]) {
173 argsize = SECTOR_SIZE * args[3];
174 argbuf = kmalloc(argsize, GFP_KERNEL);
175 if (argbuf == NULL) {
176 rc = -ENOMEM;
177 goto error;
180 scsi_cmd[1] = (4 << 1); /* PIO Data-in */
181 scsi_cmd[2] = 0x0e; /* no off.line or cc, read from dev,
182 block count in sector count field */
183 data_dir = DMA_FROM_DEVICE;
184 } else {
185 scsi_cmd[1] = (3 << 1); /* Non-data */
186 /* scsi_cmd[2] is already 0 -- no off.line, cc, or data xfer */
187 data_dir = DMA_NONE;
190 scsi_cmd[0] = ATA_16;
192 scsi_cmd[4] = args[2];
193 if (args[0] == WIN_SMART) { /* hack -- ide driver does this too... */
194 scsi_cmd[6] = args[3];
195 scsi_cmd[8] = args[1];
196 scsi_cmd[10] = 0x4f;
197 scsi_cmd[12] = 0xc2;
198 } else {
199 scsi_cmd[6] = args[1];
201 scsi_cmd[14] = args[0];
203 /* Good values for timeout and retries? Values below
204 from scsi_ioctl_send_command() for default case... */
205 if (scsi_execute_req(scsidev, scsi_cmd, data_dir, argbuf, argsize,
206 &sshdr, (10*HZ), 5)) {
207 rc = -EIO;
208 goto error;
211 /* Need code to retrieve data from check condition? */
213 if ((argbuf)
214 && copy_to_user(arg + sizeof(args), argbuf, argsize))
215 rc = -EFAULT;
216 error:
217 if (argbuf)
218 kfree(argbuf);
220 return rc;
224 * ata_task_ioctl - Handler for HDIO_DRIVE_TASK ioctl
225 * @scsidev: Device to which we are issuing command
226 * @arg: User provided data for issuing command
228 * LOCKING:
229 * Defined by the SCSI layer. We don't really care.
231 * RETURNS:
232 * Zero on success, negative errno on error.
234 int ata_task_ioctl(struct scsi_device *scsidev, void __user *arg)
236 int rc = 0;
237 u8 scsi_cmd[MAX_COMMAND_SIZE];
238 u8 args[7];
239 struct scsi_sense_hdr sshdr;
241 if (arg == NULL)
242 return -EINVAL;
244 if (copy_from_user(args, arg, sizeof(args)))
245 return -EFAULT;
247 memset(scsi_cmd, 0, sizeof(scsi_cmd));
248 scsi_cmd[0] = ATA_16;
249 scsi_cmd[1] = (3 << 1); /* Non-data */
250 /* scsi_cmd[2] is already 0 -- no off.line, cc, or data xfer */
251 scsi_cmd[4] = args[1];
252 scsi_cmd[6] = args[2];
253 scsi_cmd[8] = args[3];
254 scsi_cmd[10] = args[4];
255 scsi_cmd[12] = args[5];
256 scsi_cmd[14] = args[0];
258 /* Good values for timeout and retries? Values below
259 from scsi_ioctl_send_command() for default case... */
260 if (scsi_execute_req(scsidev, scsi_cmd, DMA_NONE, NULL, 0, &sshdr,
261 (10*HZ), 5))
262 rc = -EIO;
264 /* Need code to retrieve data from check condition? */
265 return rc;
268 int ata_scsi_ioctl(struct scsi_device *scsidev, int cmd, void __user *arg)
270 int val = -EINVAL, rc = -EINVAL;
272 switch (cmd) {
273 case ATA_IOC_GET_IO32:
274 val = 0;
275 if (copy_to_user(arg, &val, 1))
276 return -EFAULT;
277 return 0;
279 case ATA_IOC_SET_IO32:
280 val = (unsigned long) arg;
281 if (val != 0)
282 return -EINVAL;
283 return 0;
285 case HDIO_DRIVE_CMD:
286 if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
287 return -EACCES;
288 return ata_cmd_ioctl(scsidev, arg);
290 case HDIO_DRIVE_TASK:
291 if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
292 return -EACCES;
293 return ata_task_ioctl(scsidev, arg);
295 default:
296 rc = -ENOTTY;
297 break;
300 return rc;
304 * ata_scsi_qc_new - acquire new ata_queued_cmd reference
305 * @dev: ATA device to which the new command is attached
306 * @cmd: SCSI command that originated this ATA command
307 * @done: SCSI command completion function
309 * Obtain a reference to an unused ata_queued_cmd structure,
310 * which is the basic libata structure representing a single
311 * ATA command sent to the hardware.
313 * If a command was available, fill in the SCSI-specific
314 * portions of the structure with information on the
315 * current command.
317 * LOCKING:
318 * spin_lock_irqsave(host_set lock)
320 * RETURNS:
321 * Command allocated, or %NULL if none available.
323 struct ata_queued_cmd *ata_scsi_qc_new(struct ata_device *dev,
324 struct scsi_cmnd *cmd,
325 void (*done)(struct scsi_cmnd *))
327 struct ata_queued_cmd *qc;
329 qc = ata_qc_new_init(dev);
330 if (qc) {
331 qc->scsicmd = cmd;
332 qc->scsidone = done;
334 if (cmd->use_sg) {
335 qc->__sg = (struct scatterlist *) cmd->request_buffer;
336 qc->n_elem = cmd->use_sg;
337 } else {
338 qc->__sg = &qc->sgent;
339 qc->n_elem = 1;
341 } else {
342 cmd->result = (DID_OK << 16) | (QUEUE_FULL << 1);
343 done(cmd);
346 return qc;
350 * ata_dump_status - user friendly display of error info
351 * @id: id of the port in question
352 * @tf: ptr to filled out taskfile
354 * Decode and dump the ATA error/status registers for the user so
355 * that they have some idea what really happened at the non
356 * make-believe layer.
358 * LOCKING:
359 * inherited from caller
361 void ata_dump_status(unsigned id, struct ata_taskfile *tf)
363 u8 stat = tf->command, err = tf->feature;
365 printk(KERN_WARNING "ata%u: status=0x%02x { ", id, stat);
366 if (stat & ATA_BUSY) {
367 printk("Busy }\n"); /* Data is not valid in this case */
368 } else {
369 if (stat & 0x40) printk("DriveReady ");
370 if (stat & 0x20) printk("DeviceFault ");
371 if (stat & 0x10) printk("SeekComplete ");
372 if (stat & 0x08) printk("DataRequest ");
373 if (stat & 0x04) printk("CorrectedError ");
374 if (stat & 0x02) printk("Index ");
375 if (stat & 0x01) printk("Error ");
376 printk("}\n");
378 if (err) {
379 printk(KERN_WARNING "ata%u: error=0x%02x { ", id, err);
380 if (err & 0x04) printk("DriveStatusError ");
381 if (err & 0x80) {
382 if (err & 0x04) printk("BadCRC ");
383 else printk("Sector ");
385 if (err & 0x40) printk("UncorrectableError ");
386 if (err & 0x10) printk("SectorIdNotFound ");
387 if (err & 0x02) printk("TrackZeroNotFound ");
388 if (err & 0x01) printk("AddrMarkNotFound ");
389 printk("}\n");
394 int ata_scsi_device_resume(struct scsi_device *sdev)
396 struct ata_port *ap = ata_shost_to_port(sdev->host);
397 struct ata_device *dev = &ap->device[sdev->id];
399 return ata_device_resume(dev);
402 int ata_scsi_device_suspend(struct scsi_device *sdev, pm_message_t state)
404 struct ata_port *ap = ata_shost_to_port(sdev->host);
405 struct ata_device *dev = &ap->device[sdev->id];
407 return ata_device_suspend(dev, state);
411 * ata_to_sense_error - convert ATA error to SCSI error
412 * @id: ATA device number
413 * @drv_stat: value contained in ATA status register
414 * @drv_err: value contained in ATA error register
415 * @sk: the sense key we'll fill out
416 * @asc: the additional sense code we'll fill out
417 * @ascq: the additional sense code qualifier we'll fill out
418 * @verbose: be verbose
420 * Converts an ATA error into a SCSI error. Fill out pointers to
421 * SK, ASC, and ASCQ bytes for later use in fixed or descriptor
422 * format sense blocks.
424 * LOCKING:
425 * spin_lock_irqsave(host_set lock)
427 void ata_to_sense_error(unsigned id, u8 drv_stat, u8 drv_err, u8 *sk, u8 *asc,
428 u8 *ascq, int verbose)
430 int i;
432 /* Based on the 3ware driver translation table */
433 static const unsigned char sense_table[][4] = {
434 /* BBD|ECC|ID|MAR */
435 {0xd1, ABORTED_COMMAND, 0x00, 0x00}, // Device busy Aborted command
436 /* BBD|ECC|ID */
437 {0xd0, ABORTED_COMMAND, 0x00, 0x00}, // Device busy Aborted command
438 /* ECC|MC|MARK */
439 {0x61, HARDWARE_ERROR, 0x00, 0x00}, // Device fault Hardware error
440 /* ICRC|ABRT */ /* NB: ICRC & !ABRT is BBD */
441 {0x84, ABORTED_COMMAND, 0x47, 0x00}, // Data CRC error SCSI parity error
442 /* MC|ID|ABRT|TRK0|MARK */
443 {0x37, NOT_READY, 0x04, 0x00}, // Unit offline Not ready
444 /* MCR|MARK */
445 {0x09, NOT_READY, 0x04, 0x00}, // Unrecovered disk error Not ready
446 /* Bad address mark */
447 {0x01, MEDIUM_ERROR, 0x13, 0x00}, // Address mark not found Address mark not found for data field
448 /* TRK0 */
449 {0x02, HARDWARE_ERROR, 0x00, 0x00}, // Track 0 not found Hardware error
450 /* Abort & !ICRC */
451 {0x04, ABORTED_COMMAND, 0x00, 0x00}, // Aborted command Aborted command
452 /* Media change request */
453 {0x08, NOT_READY, 0x04, 0x00}, // Media change request FIXME: faking offline
454 /* SRV */
455 {0x10, ABORTED_COMMAND, 0x14, 0x00}, // ID not found Recorded entity not found
456 /* Media change */
457 {0x08, NOT_READY, 0x04, 0x00}, // Media change FIXME: faking offline
458 /* ECC */
459 {0x40, MEDIUM_ERROR, 0x11, 0x04}, // Uncorrectable ECC error Unrecovered read error
460 /* BBD - block marked bad */
461 {0x80, MEDIUM_ERROR, 0x11, 0x04}, // Block marked bad Medium error, unrecovered read error
462 {0xFF, 0xFF, 0xFF, 0xFF}, // END mark
464 static const unsigned char stat_table[][4] = {
465 /* Must be first because BUSY means no other bits valid */
466 {0x80, ABORTED_COMMAND, 0x47, 0x00}, // Busy, fake parity for now
467 {0x20, HARDWARE_ERROR, 0x00, 0x00}, // Device fault
468 {0x08, ABORTED_COMMAND, 0x47, 0x00}, // Timed out in xfer, fake parity for now
469 {0x04, RECOVERED_ERROR, 0x11, 0x00}, // Recovered ECC error Medium error, recovered
470 {0xFF, 0xFF, 0xFF, 0xFF}, // END mark
474 * Is this an error we can process/parse
476 if (drv_stat & ATA_BUSY) {
477 drv_err = 0; /* Ignore the err bits, they're invalid */
480 if (drv_err) {
481 /* Look for drv_err */
482 for (i = 0; sense_table[i][0] != 0xFF; i++) {
483 /* Look for best matches first */
484 if ((sense_table[i][0] & drv_err) ==
485 sense_table[i][0]) {
486 *sk = sense_table[i][1];
487 *asc = sense_table[i][2];
488 *ascq = sense_table[i][3];
489 goto translate_done;
492 /* No immediate match */
493 if (verbose)
494 printk(KERN_WARNING "ata%u: no sense translation for "
495 "error 0x%02x\n", id, drv_err);
498 /* Fall back to interpreting status bits */
499 for (i = 0; stat_table[i][0] != 0xFF; i++) {
500 if (stat_table[i][0] & drv_stat) {
501 *sk = stat_table[i][1];
502 *asc = stat_table[i][2];
503 *ascq = stat_table[i][3];
504 goto translate_done;
507 /* No error? Undecoded? */
508 if (verbose)
509 printk(KERN_WARNING "ata%u: no sense translation for "
510 "status: 0x%02x\n", id, drv_stat);
512 /* We need a sensible error return here, which is tricky, and one
513 that won't cause people to do things like return a disk wrongly */
514 *sk = ABORTED_COMMAND;
515 *asc = 0x00;
516 *ascq = 0x00;
518 translate_done:
519 if (verbose)
520 printk(KERN_ERR "ata%u: translated ATA stat/err 0x%02x/%02x "
521 "to SCSI SK/ASC/ASCQ 0x%x/%02x/%02x\n",
522 id, drv_stat, drv_err, *sk, *asc, *ascq);
523 return;
527 * ata_gen_ata_desc_sense - Generate check condition sense block.
528 * @qc: Command that completed.
530 * This function is specific to the ATA descriptor format sense
531 * block specified for the ATA pass through commands. Regardless
532 * of whether the command errored or not, return a sense
533 * block. Copy all controller registers into the sense
534 * block. Clear sense key, ASC & ASCQ if there is no error.
536 * LOCKING:
537 * spin_lock_irqsave(host_set lock)
539 void ata_gen_ata_desc_sense(struct ata_queued_cmd *qc)
541 struct scsi_cmnd *cmd = qc->scsicmd;
542 struct ata_taskfile *tf = &qc->result_tf;
543 unsigned char *sb = cmd->sense_buffer;
544 unsigned char *desc = sb + 8;
545 int verbose = qc->ap->ops->error_handler == NULL;
547 memset(sb, 0, SCSI_SENSE_BUFFERSIZE);
549 cmd->result = (DRIVER_SENSE << 24) | SAM_STAT_CHECK_CONDITION;
552 * Use ata_to_sense_error() to map status register bits
553 * onto sense key, asc & ascq.
555 if (qc->err_mask ||
556 tf->command & (ATA_BUSY | ATA_DF | ATA_ERR | ATA_DRQ)) {
557 ata_to_sense_error(qc->ap->id, tf->command, tf->feature,
558 &sb[1], &sb[2], &sb[3], verbose);
559 sb[1] &= 0x0f;
563 * Sense data is current and format is descriptor.
565 sb[0] = 0x72;
567 desc[0] = 0x09;
570 * Set length of additional sense data.
571 * Since we only populate descriptor 0, the total
572 * length is the same (fixed) length as descriptor 0.
574 desc[1] = sb[7] = 14;
577 * Copy registers into sense buffer.
579 desc[2] = 0x00;
580 desc[3] = tf->feature; /* == error reg */
581 desc[5] = tf->nsect;
582 desc[7] = tf->lbal;
583 desc[9] = tf->lbam;
584 desc[11] = tf->lbah;
585 desc[12] = tf->device;
586 desc[13] = tf->command; /* == status reg */
589 * Fill in Extend bit, and the high order bytes
590 * if applicable.
592 if (tf->flags & ATA_TFLAG_LBA48) {
593 desc[2] |= 0x01;
594 desc[4] = tf->hob_nsect;
595 desc[6] = tf->hob_lbal;
596 desc[8] = tf->hob_lbam;
597 desc[10] = tf->hob_lbah;
602 * ata_gen_fixed_sense - generate a SCSI fixed sense block
603 * @qc: Command that we are erroring out
605 * Leverage ata_to_sense_error() to give us the codes. Fit our
606 * LBA in here if there's room.
608 * LOCKING:
609 * inherited from caller
611 void ata_gen_fixed_sense(struct ata_queued_cmd *qc)
613 struct scsi_cmnd *cmd = qc->scsicmd;
614 struct ata_taskfile *tf = &qc->result_tf;
615 unsigned char *sb = cmd->sense_buffer;
616 int verbose = qc->ap->ops->error_handler == NULL;
618 memset(sb, 0, SCSI_SENSE_BUFFERSIZE);
620 cmd->result = (DRIVER_SENSE << 24) | SAM_STAT_CHECK_CONDITION;
623 * Use ata_to_sense_error() to map status register bits
624 * onto sense key, asc & ascq.
626 if (qc->err_mask ||
627 tf->command & (ATA_BUSY | ATA_DF | ATA_ERR | ATA_DRQ)) {
628 ata_to_sense_error(qc->ap->id, tf->command, tf->feature,
629 &sb[2], &sb[12], &sb[13], verbose);
630 sb[2] &= 0x0f;
633 sb[0] = 0x70;
634 sb[7] = 0x0a;
636 if (tf->flags & ATA_TFLAG_LBA48) {
637 /* TODO: find solution for LBA48 descriptors */
640 else if (tf->flags & ATA_TFLAG_LBA) {
641 /* A small (28b) LBA will fit in the 32b info field */
642 sb[0] |= 0x80; /* set valid bit */
643 sb[3] = tf->device & 0x0f;
644 sb[4] = tf->lbah;
645 sb[5] = tf->lbam;
646 sb[6] = tf->lbal;
649 else {
650 /* TODO: C/H/S */
654 static void ata_scsi_sdev_config(struct scsi_device *sdev)
656 sdev->use_10_for_rw = 1;
657 sdev->use_10_for_ms = 1;
660 static void ata_scsi_dev_config(struct scsi_device *sdev,
661 struct ata_device *dev)
663 unsigned int max_sectors;
665 /* TODO: 2048 is an arbitrary number, not the
666 * hardware maximum. This should be increased to
667 * 65534 when Jens Axboe's patch for dynamically
668 * determining max_sectors is merged.
670 max_sectors = ATA_MAX_SECTORS;
671 if (dev->flags & ATA_DFLAG_LBA48)
672 max_sectors = 2048;
673 if (dev->max_sectors)
674 max_sectors = dev->max_sectors;
676 blk_queue_max_sectors(sdev->request_queue, max_sectors);
679 * SATA DMA transfers must be multiples of 4 byte, so
680 * we need to pad ATAPI transfers using an extra sg.
681 * Decrement max hw segments accordingly.
683 if (dev->class == ATA_DEV_ATAPI) {
684 request_queue_t *q = sdev->request_queue;
685 blk_queue_max_hw_segments(q, q->max_hw_segments - 1);
690 * ata_scsi_slave_config - Set SCSI device attributes
691 * @sdev: SCSI device to examine
693 * This is called before we actually start reading
694 * and writing to the device, to configure certain
695 * SCSI mid-layer behaviors.
697 * LOCKING:
698 * Defined by SCSI layer. We don't really care.
701 int ata_scsi_slave_config(struct scsi_device *sdev)
703 ata_scsi_sdev_config(sdev);
705 blk_queue_max_phys_segments(sdev->request_queue, LIBATA_MAX_PRD);
707 if (sdev->id < ATA_MAX_DEVICES) {
708 struct ata_port *ap;
709 struct ata_device *dev;
711 ap = ata_shost_to_port(sdev->host);
712 dev = &ap->device[sdev->id];
714 ata_scsi_dev_config(sdev, dev);
717 return 0; /* scsi layer doesn't check return value, sigh */
721 * ata_scsi_start_stop_xlat - Translate SCSI START STOP UNIT command
722 * @qc: Storage for translated ATA taskfile
723 * @scsicmd: SCSI command to translate
725 * Sets up an ATA taskfile to issue STANDBY (to stop) or READ VERIFY
726 * (to start). Perhaps these commands should be preceded by
727 * CHECK POWER MODE to see what power mode the device is already in.
728 * [See SAT revision 5 at www.t10.org]
730 * LOCKING:
731 * spin_lock_irqsave(host_set lock)
733 * RETURNS:
734 * Zero on success, non-zero on error.
737 static unsigned int ata_scsi_start_stop_xlat(struct ata_queued_cmd *qc,
738 const u8 *scsicmd)
740 struct ata_taskfile *tf = &qc->tf;
742 tf->flags |= ATA_TFLAG_DEVICE | ATA_TFLAG_ISADDR;
743 tf->protocol = ATA_PROT_NODATA;
744 if (scsicmd[1] & 0x1) {
745 ; /* ignore IMMED bit, violates sat-r05 */
747 if (scsicmd[4] & 0x2)
748 goto invalid_fld; /* LOEJ bit set not supported */
749 if (((scsicmd[4] >> 4) & 0xf) != 0)
750 goto invalid_fld; /* power conditions not supported */
751 if (scsicmd[4] & 0x1) {
752 tf->nsect = 1; /* 1 sector, lba=0 */
754 if (qc->dev->flags & ATA_DFLAG_LBA) {
755 tf->flags |= ATA_TFLAG_LBA;
757 tf->lbah = 0x0;
758 tf->lbam = 0x0;
759 tf->lbal = 0x0;
760 tf->device |= ATA_LBA;
761 } else {
762 /* CHS */
763 tf->lbal = 0x1; /* sect */
764 tf->lbam = 0x0; /* cyl low */
765 tf->lbah = 0x0; /* cyl high */
768 tf->command = ATA_CMD_VERIFY; /* READ VERIFY */
769 } else {
770 tf->nsect = 0; /* time period value (0 implies now) */
771 tf->command = ATA_CMD_STANDBY;
772 /* Consider: ATA STANDBY IMMEDIATE command */
775 * Standby and Idle condition timers could be implemented but that
776 * would require libata to implement the Power condition mode page
777 * and allow the user to change it. Changing mode pages requires
778 * MODE SELECT to be implemented.
781 return 0;
783 invalid_fld:
784 ata_scsi_set_sense(qc->scsicmd, ILLEGAL_REQUEST, 0x24, 0x0);
785 /* "Invalid field in cbd" */
786 return 1;
791 * ata_scsi_flush_xlat - Translate SCSI SYNCHRONIZE CACHE command
792 * @qc: Storage for translated ATA taskfile
793 * @scsicmd: SCSI command to translate (ignored)
795 * Sets up an ATA taskfile to issue FLUSH CACHE or
796 * FLUSH CACHE EXT.
798 * LOCKING:
799 * spin_lock_irqsave(host_set lock)
801 * RETURNS:
802 * Zero on success, non-zero on error.
805 static unsigned int ata_scsi_flush_xlat(struct ata_queued_cmd *qc, const u8 *scsicmd)
807 struct ata_taskfile *tf = &qc->tf;
809 tf->flags |= ATA_TFLAG_DEVICE;
810 tf->protocol = ATA_PROT_NODATA;
812 if ((qc->dev->flags & ATA_DFLAG_LBA48) &&
813 (ata_id_has_flush_ext(qc->dev->id)))
814 tf->command = ATA_CMD_FLUSH_EXT;
815 else
816 tf->command = ATA_CMD_FLUSH;
818 return 0;
822 * scsi_6_lba_len - Get LBA and transfer length
823 * @scsicmd: SCSI command to translate
825 * Calculate LBA and transfer length for 6-byte commands.
827 * RETURNS:
828 * @plba: the LBA
829 * @plen: the transfer length
832 static void scsi_6_lba_len(const u8 *scsicmd, u64 *plba, u32 *plen)
834 u64 lba = 0;
835 u32 len = 0;
837 VPRINTK("six-byte command\n");
839 lba |= ((u64)scsicmd[2]) << 8;
840 lba |= ((u64)scsicmd[3]);
842 len |= ((u32)scsicmd[4]);
844 *plba = lba;
845 *plen = len;
849 * scsi_10_lba_len - Get LBA and transfer length
850 * @scsicmd: SCSI command to translate
852 * Calculate LBA and transfer length for 10-byte commands.
854 * RETURNS:
855 * @plba: the LBA
856 * @plen: the transfer length
859 static void scsi_10_lba_len(const u8 *scsicmd, u64 *plba, u32 *plen)
861 u64 lba = 0;
862 u32 len = 0;
864 VPRINTK("ten-byte command\n");
866 lba |= ((u64)scsicmd[2]) << 24;
867 lba |= ((u64)scsicmd[3]) << 16;
868 lba |= ((u64)scsicmd[4]) << 8;
869 lba |= ((u64)scsicmd[5]);
871 len |= ((u32)scsicmd[7]) << 8;
872 len |= ((u32)scsicmd[8]);
874 *plba = lba;
875 *plen = len;
879 * scsi_16_lba_len - Get LBA and transfer length
880 * @scsicmd: SCSI command to translate
882 * Calculate LBA and transfer length for 16-byte commands.
884 * RETURNS:
885 * @plba: the LBA
886 * @plen: the transfer length
889 static void scsi_16_lba_len(const u8 *scsicmd, u64 *plba, u32 *plen)
891 u64 lba = 0;
892 u32 len = 0;
894 VPRINTK("sixteen-byte command\n");
896 lba |= ((u64)scsicmd[2]) << 56;
897 lba |= ((u64)scsicmd[3]) << 48;
898 lba |= ((u64)scsicmd[4]) << 40;
899 lba |= ((u64)scsicmd[5]) << 32;
900 lba |= ((u64)scsicmd[6]) << 24;
901 lba |= ((u64)scsicmd[7]) << 16;
902 lba |= ((u64)scsicmd[8]) << 8;
903 lba |= ((u64)scsicmd[9]);
905 len |= ((u32)scsicmd[10]) << 24;
906 len |= ((u32)scsicmd[11]) << 16;
907 len |= ((u32)scsicmd[12]) << 8;
908 len |= ((u32)scsicmd[13]);
910 *plba = lba;
911 *plen = len;
915 * ata_scsi_verify_xlat - Translate SCSI VERIFY command into an ATA one
916 * @qc: Storage for translated ATA taskfile
917 * @scsicmd: SCSI command to translate
919 * Converts SCSI VERIFY command to an ATA READ VERIFY command.
921 * LOCKING:
922 * spin_lock_irqsave(host_set lock)
924 * RETURNS:
925 * Zero on success, non-zero on error.
928 static unsigned int ata_scsi_verify_xlat(struct ata_queued_cmd *qc, const u8 *scsicmd)
930 struct ata_taskfile *tf = &qc->tf;
931 struct ata_device *dev = qc->dev;
932 u64 dev_sectors = qc->dev->n_sectors;
933 u64 block;
934 u32 n_block;
936 tf->flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
937 tf->protocol = ATA_PROT_NODATA;
939 if (scsicmd[0] == VERIFY)
940 scsi_10_lba_len(scsicmd, &block, &n_block);
941 else if (scsicmd[0] == VERIFY_16)
942 scsi_16_lba_len(scsicmd, &block, &n_block);
943 else
944 goto invalid_fld;
946 if (!n_block)
947 goto nothing_to_do;
948 if (block >= dev_sectors)
949 goto out_of_range;
950 if ((block + n_block) > dev_sectors)
951 goto out_of_range;
953 if (dev->flags & ATA_DFLAG_LBA) {
954 tf->flags |= ATA_TFLAG_LBA;
956 if (lba_28_ok(block, n_block)) {
957 /* use LBA28 */
958 tf->command = ATA_CMD_VERIFY;
959 tf->device |= (block >> 24) & 0xf;
960 } else if (lba_48_ok(block, n_block)) {
961 if (!(dev->flags & ATA_DFLAG_LBA48))
962 goto out_of_range;
964 /* use LBA48 */
965 tf->flags |= ATA_TFLAG_LBA48;
966 tf->command = ATA_CMD_VERIFY_EXT;
968 tf->hob_nsect = (n_block >> 8) & 0xff;
970 tf->hob_lbah = (block >> 40) & 0xff;
971 tf->hob_lbam = (block >> 32) & 0xff;
972 tf->hob_lbal = (block >> 24) & 0xff;
973 } else
974 /* request too large even for LBA48 */
975 goto out_of_range;
977 tf->nsect = n_block & 0xff;
979 tf->lbah = (block >> 16) & 0xff;
980 tf->lbam = (block >> 8) & 0xff;
981 tf->lbal = block & 0xff;
983 tf->device |= ATA_LBA;
984 } else {
985 /* CHS */
986 u32 sect, head, cyl, track;
988 if (!lba_28_ok(block, n_block))
989 goto out_of_range;
991 /* Convert LBA to CHS */
992 track = (u32)block / dev->sectors;
993 cyl = track / dev->heads;
994 head = track % dev->heads;
995 sect = (u32)block % dev->sectors + 1;
997 DPRINTK("block %u track %u cyl %u head %u sect %u\n",
998 (u32)block, track, cyl, head, sect);
1000 /* Check whether the converted CHS can fit.
1001 Cylinder: 0-65535
1002 Head: 0-15
1003 Sector: 1-255*/
1004 if ((cyl >> 16) || (head >> 4) || (sect >> 8) || (!sect))
1005 goto out_of_range;
1007 tf->command = ATA_CMD_VERIFY;
1008 tf->nsect = n_block & 0xff; /* Sector count 0 means 256 sectors */
1009 tf->lbal = sect;
1010 tf->lbam = cyl;
1011 tf->lbah = cyl >> 8;
1012 tf->device |= head;
1015 return 0;
1017 invalid_fld:
1018 ata_scsi_set_sense(qc->scsicmd, ILLEGAL_REQUEST, 0x24, 0x0);
1019 /* "Invalid field in cbd" */
1020 return 1;
1022 out_of_range:
1023 ata_scsi_set_sense(qc->scsicmd, ILLEGAL_REQUEST, 0x21, 0x0);
1024 /* "Logical Block Address out of range" */
1025 return 1;
1027 nothing_to_do:
1028 qc->scsicmd->result = SAM_STAT_GOOD;
1029 return 1;
1033 * ata_scsi_rw_xlat - Translate SCSI r/w command into an ATA one
1034 * @qc: Storage for translated ATA taskfile
1035 * @scsicmd: SCSI command to translate
1037 * Converts any of six SCSI read/write commands into the
1038 * ATA counterpart, including starting sector (LBA),
1039 * sector count, and taking into account the device's LBA48
1040 * support.
1042 * Commands %READ_6, %READ_10, %READ_16, %WRITE_6, %WRITE_10, and
1043 * %WRITE_16 are currently supported.
1045 * LOCKING:
1046 * spin_lock_irqsave(host_set lock)
1048 * RETURNS:
1049 * Zero on success, non-zero on error.
1052 static unsigned int ata_scsi_rw_xlat(struct ata_queued_cmd *qc, const u8 *scsicmd)
1054 struct ata_taskfile *tf = &qc->tf;
1055 struct ata_device *dev = qc->dev;
1056 u64 block;
1057 u32 n_block;
1059 qc->flags |= ATA_QCFLAG_IO;
1060 tf->flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
1062 if (scsicmd[0] == WRITE_10 || scsicmd[0] == WRITE_6 ||
1063 scsicmd[0] == WRITE_16)
1064 tf->flags |= ATA_TFLAG_WRITE;
1066 /* Calculate the SCSI LBA, transfer length and FUA. */
1067 switch (scsicmd[0]) {
1068 case READ_10:
1069 case WRITE_10:
1070 scsi_10_lba_len(scsicmd, &block, &n_block);
1071 if (unlikely(scsicmd[1] & (1 << 3)))
1072 tf->flags |= ATA_TFLAG_FUA;
1073 break;
1074 case READ_6:
1075 case WRITE_6:
1076 scsi_6_lba_len(scsicmd, &block, &n_block);
1078 /* for 6-byte r/w commands, transfer length 0
1079 * means 256 blocks of data, not 0 block.
1081 if (!n_block)
1082 n_block = 256;
1083 break;
1084 case READ_16:
1085 case WRITE_16:
1086 scsi_16_lba_len(scsicmd, &block, &n_block);
1087 if (unlikely(scsicmd[1] & (1 << 3)))
1088 tf->flags |= ATA_TFLAG_FUA;
1089 break;
1090 default:
1091 DPRINTK("no-byte command\n");
1092 goto invalid_fld;
1095 /* Check and compose ATA command */
1096 if (!n_block)
1097 /* For 10-byte and 16-byte SCSI R/W commands, transfer
1098 * length 0 means transfer 0 block of data.
1099 * However, for ATA R/W commands, sector count 0 means
1100 * 256 or 65536 sectors, not 0 sectors as in SCSI.
1102 * WARNING: one or two older ATA drives treat 0 as 0...
1104 goto nothing_to_do;
1106 if (dev->flags & ATA_DFLAG_LBA) {
1107 tf->flags |= ATA_TFLAG_LBA;
1109 if (lba_28_ok(block, n_block)) {
1110 /* use LBA28 */
1111 tf->device |= (block >> 24) & 0xf;
1112 } else if (lba_48_ok(block, n_block)) {
1113 if (!(dev->flags & ATA_DFLAG_LBA48))
1114 goto out_of_range;
1116 /* use LBA48 */
1117 tf->flags |= ATA_TFLAG_LBA48;
1119 tf->hob_nsect = (n_block >> 8) & 0xff;
1121 tf->hob_lbah = (block >> 40) & 0xff;
1122 tf->hob_lbam = (block >> 32) & 0xff;
1123 tf->hob_lbal = (block >> 24) & 0xff;
1124 } else
1125 /* request too large even for LBA48 */
1126 goto out_of_range;
1128 if (unlikely(ata_rwcmd_protocol(qc) < 0))
1129 goto invalid_fld;
1131 qc->nsect = n_block;
1132 tf->nsect = n_block & 0xff;
1134 tf->lbah = (block >> 16) & 0xff;
1135 tf->lbam = (block >> 8) & 0xff;
1136 tf->lbal = block & 0xff;
1138 tf->device |= ATA_LBA;
1139 } else {
1140 /* CHS */
1141 u32 sect, head, cyl, track;
1143 /* The request -may- be too large for CHS addressing. */
1144 if (!lba_28_ok(block, n_block))
1145 goto out_of_range;
1147 if (unlikely(ata_rwcmd_protocol(qc) < 0))
1148 goto invalid_fld;
1150 /* Convert LBA to CHS */
1151 track = (u32)block / dev->sectors;
1152 cyl = track / dev->heads;
1153 head = track % dev->heads;
1154 sect = (u32)block % dev->sectors + 1;
1156 DPRINTK("block %u track %u cyl %u head %u sect %u\n",
1157 (u32)block, track, cyl, head, sect);
1159 /* Check whether the converted CHS can fit.
1160 Cylinder: 0-65535
1161 Head: 0-15
1162 Sector: 1-255*/
1163 if ((cyl >> 16) || (head >> 4) || (sect >> 8) || (!sect))
1164 goto out_of_range;
1166 qc->nsect = n_block;
1167 tf->nsect = n_block & 0xff; /* Sector count 0 means 256 sectors */
1168 tf->lbal = sect;
1169 tf->lbam = cyl;
1170 tf->lbah = cyl >> 8;
1171 tf->device |= head;
1174 return 0;
1176 invalid_fld:
1177 ata_scsi_set_sense(qc->scsicmd, ILLEGAL_REQUEST, 0x24, 0x0);
1178 /* "Invalid field in cbd" */
1179 return 1;
1181 out_of_range:
1182 ata_scsi_set_sense(qc->scsicmd, ILLEGAL_REQUEST, 0x21, 0x0);
1183 /* "Logical Block Address out of range" */
1184 return 1;
1186 nothing_to_do:
1187 qc->scsicmd->result = SAM_STAT_GOOD;
1188 return 1;
1191 static void ata_scsi_qc_complete(struct ata_queued_cmd *qc)
1193 struct scsi_cmnd *cmd = qc->scsicmd;
1194 u8 *cdb = cmd->cmnd;
1195 int need_sense = (qc->err_mask != 0);
1197 /* For ATA pass thru (SAT) commands, generate a sense block if
1198 * user mandated it or if there's an error. Note that if we
1199 * generate because the user forced us to, a check condition
1200 * is generated and the ATA register values are returned
1201 * whether the command completed successfully or not. If there
1202 * was no error, SK, ASC and ASCQ will all be zero.
1204 if (((cdb[0] == ATA_16) || (cdb[0] == ATA_12)) &&
1205 ((cdb[2] & 0x20) || need_sense)) {
1206 ata_gen_ata_desc_sense(qc);
1207 } else {
1208 if (!need_sense) {
1209 cmd->result = SAM_STAT_GOOD;
1210 } else {
1211 /* TODO: decide which descriptor format to use
1212 * for 48b LBA devices and call that here
1213 * instead of the fixed desc, which is only
1214 * good for smaller LBA (and maybe CHS?)
1215 * devices.
1217 ata_gen_fixed_sense(qc);
1221 if (need_sense && !qc->ap->ops->error_handler)
1222 ata_dump_status(qc->ap->id, &qc->result_tf);
1224 qc->scsidone(cmd);
1226 ata_qc_free(qc);
1230 * ata_scsi_translate - Translate then issue SCSI command to ATA device
1231 * @dev: ATA device to which the command is addressed
1232 * @cmd: SCSI command to execute
1233 * @done: SCSI command completion function
1234 * @xlat_func: Actor which translates @cmd to an ATA taskfile
1236 * Our ->queuecommand() function has decided that the SCSI
1237 * command issued can be directly translated into an ATA
1238 * command, rather than handled internally.
1240 * This function sets up an ata_queued_cmd structure for the
1241 * SCSI command, and sends that ata_queued_cmd to the hardware.
1243 * The xlat_func argument (actor) returns 0 if ready to execute
1244 * ATA command, else 1 to finish translation. If 1 is returned
1245 * then cmd->result (and possibly cmd->sense_buffer) are assumed
1246 * to be set reflecting an error condition or clean (early)
1247 * termination.
1249 * LOCKING:
1250 * spin_lock_irqsave(host_set lock)
1253 static void ata_scsi_translate(struct ata_device *dev, struct scsi_cmnd *cmd,
1254 void (*done)(struct scsi_cmnd *),
1255 ata_xlat_func_t xlat_func)
1257 struct ata_queued_cmd *qc;
1258 u8 *scsicmd = cmd->cmnd;
1260 VPRINTK("ENTER\n");
1262 qc = ata_scsi_qc_new(dev, cmd, done);
1263 if (!qc)
1264 goto err_mem;
1266 /* data is present; dma-map it */
1267 if (cmd->sc_data_direction == DMA_FROM_DEVICE ||
1268 cmd->sc_data_direction == DMA_TO_DEVICE) {
1269 if (unlikely(cmd->request_bufflen < 1)) {
1270 ata_dev_printk(dev, KERN_WARNING,
1271 "WARNING: zero len r/w req\n");
1272 goto err_did;
1275 if (cmd->use_sg)
1276 ata_sg_init(qc, cmd->request_buffer, cmd->use_sg);
1277 else
1278 ata_sg_init_one(qc, cmd->request_buffer,
1279 cmd->request_bufflen);
1281 qc->dma_dir = cmd->sc_data_direction;
1284 qc->complete_fn = ata_scsi_qc_complete;
1286 if (xlat_func(qc, scsicmd))
1287 goto early_finish;
1289 /* select device, send command to hardware */
1290 ata_qc_issue(qc);
1292 VPRINTK("EXIT\n");
1293 return;
1295 early_finish:
1296 ata_qc_free(qc);
1297 done(cmd);
1298 DPRINTK("EXIT - early finish (good or error)\n");
1299 return;
1301 err_did:
1302 ata_qc_free(qc);
1303 err_mem:
1304 cmd->result = (DID_ERROR << 16);
1305 done(cmd);
1306 DPRINTK("EXIT - internal\n");
1307 return;
1311 * ata_scsi_rbuf_get - Map response buffer.
1312 * @cmd: SCSI command containing buffer to be mapped.
1313 * @buf_out: Pointer to mapped area.
1315 * Maps buffer contained within SCSI command @cmd.
1317 * LOCKING:
1318 * spin_lock_irqsave(host_set lock)
1320 * RETURNS:
1321 * Length of response buffer.
1324 static unsigned int ata_scsi_rbuf_get(struct scsi_cmnd *cmd, u8 **buf_out)
1326 u8 *buf;
1327 unsigned int buflen;
1329 if (cmd->use_sg) {
1330 struct scatterlist *sg;
1332 sg = (struct scatterlist *) cmd->request_buffer;
1333 buf = kmap_atomic(sg->page, KM_USER0) + sg->offset;
1334 buflen = sg->length;
1335 } else {
1336 buf = cmd->request_buffer;
1337 buflen = cmd->request_bufflen;
1340 *buf_out = buf;
1341 return buflen;
1345 * ata_scsi_rbuf_put - Unmap response buffer.
1346 * @cmd: SCSI command containing buffer to be unmapped.
1347 * @buf: buffer to unmap
1349 * Unmaps response buffer contained within @cmd.
1351 * LOCKING:
1352 * spin_lock_irqsave(host_set lock)
1355 static inline void ata_scsi_rbuf_put(struct scsi_cmnd *cmd, u8 *buf)
1357 if (cmd->use_sg) {
1358 struct scatterlist *sg;
1360 sg = (struct scatterlist *) cmd->request_buffer;
1361 kunmap_atomic(buf - sg->offset, KM_USER0);
1366 * ata_scsi_rbuf_fill - wrapper for SCSI command simulators
1367 * @args: device IDENTIFY data / SCSI command of interest.
1368 * @actor: Callback hook for desired SCSI command simulator
1370 * Takes care of the hard work of simulating a SCSI command...
1371 * Mapping the response buffer, calling the command's handler,
1372 * and handling the handler's return value. This return value
1373 * indicates whether the handler wishes the SCSI command to be
1374 * completed successfully (0), or not (in which case cmd->result
1375 * and sense buffer are assumed to be set).
1377 * LOCKING:
1378 * spin_lock_irqsave(host_set lock)
1381 void ata_scsi_rbuf_fill(struct ata_scsi_args *args,
1382 unsigned int (*actor) (struct ata_scsi_args *args,
1383 u8 *rbuf, unsigned int buflen))
1385 u8 *rbuf;
1386 unsigned int buflen, rc;
1387 struct scsi_cmnd *cmd = args->cmd;
1389 buflen = ata_scsi_rbuf_get(cmd, &rbuf);
1390 memset(rbuf, 0, buflen);
1391 rc = actor(args, rbuf, buflen);
1392 ata_scsi_rbuf_put(cmd, rbuf);
1394 if (rc == 0)
1395 cmd->result = SAM_STAT_GOOD;
1396 args->done(cmd);
1400 * ata_scsiop_inq_std - Simulate INQUIRY command
1401 * @args: device IDENTIFY data / SCSI command of interest.
1402 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1403 * @buflen: Response buffer length.
1405 * Returns standard device identification data associated
1406 * with non-VPD INQUIRY command output.
1408 * LOCKING:
1409 * spin_lock_irqsave(host_set lock)
1412 unsigned int ata_scsiop_inq_std(struct ata_scsi_args *args, u8 *rbuf,
1413 unsigned int buflen)
1415 u8 hdr[] = {
1416 TYPE_DISK,
1418 0x5, /* claim SPC-3 version compatibility */
1420 95 - 4
1423 /* set scsi removeable (RMB) bit per ata bit */
1424 if (ata_id_removeable(args->id))
1425 hdr[1] |= (1 << 7);
1427 VPRINTK("ENTER\n");
1429 memcpy(rbuf, hdr, sizeof(hdr));
1431 if (buflen > 35) {
1432 memcpy(&rbuf[8], "ATA ", 8);
1433 ata_id_string(args->id, &rbuf[16], ATA_ID_PROD_OFS, 16);
1434 ata_id_string(args->id, &rbuf[32], ATA_ID_FW_REV_OFS, 4);
1435 if (rbuf[32] == 0 || rbuf[32] == ' ')
1436 memcpy(&rbuf[32], "n/a ", 4);
1439 if (buflen > 63) {
1440 const u8 versions[] = {
1441 0x60, /* SAM-3 (no version claimed) */
1443 0x03,
1444 0x20, /* SBC-2 (no version claimed) */
1446 0x02,
1447 0x60 /* SPC-3 (no version claimed) */
1450 memcpy(rbuf + 59, versions, sizeof(versions));
1453 return 0;
1457 * ata_scsiop_inq_00 - Simulate INQUIRY VPD page 0, list of pages
1458 * @args: device IDENTIFY data / SCSI command of interest.
1459 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1460 * @buflen: Response buffer length.
1462 * Returns list of inquiry VPD pages available.
1464 * LOCKING:
1465 * spin_lock_irqsave(host_set lock)
1468 unsigned int ata_scsiop_inq_00(struct ata_scsi_args *args, u8 *rbuf,
1469 unsigned int buflen)
1471 const u8 pages[] = {
1472 0x00, /* page 0x00, this page */
1473 0x80, /* page 0x80, unit serial no page */
1474 0x83 /* page 0x83, device ident page */
1476 rbuf[3] = sizeof(pages); /* number of supported VPD pages */
1478 if (buflen > 6)
1479 memcpy(rbuf + 4, pages, sizeof(pages));
1481 return 0;
1485 * ata_scsiop_inq_80 - Simulate INQUIRY VPD page 80, device serial number
1486 * @args: device IDENTIFY data / SCSI command of interest.
1487 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1488 * @buflen: Response buffer length.
1490 * Returns ATA device serial number.
1492 * LOCKING:
1493 * spin_lock_irqsave(host_set lock)
1496 unsigned int ata_scsiop_inq_80(struct ata_scsi_args *args, u8 *rbuf,
1497 unsigned int buflen)
1499 const u8 hdr[] = {
1501 0x80, /* this page code */
1503 ATA_SERNO_LEN, /* page len */
1505 memcpy(rbuf, hdr, sizeof(hdr));
1507 if (buflen > (ATA_SERNO_LEN + 4 - 1))
1508 ata_id_string(args->id, (unsigned char *) &rbuf[4],
1509 ATA_ID_SERNO_OFS, ATA_SERNO_LEN);
1511 return 0;
1515 * ata_scsiop_inq_83 - Simulate INQUIRY VPD page 83, device identity
1516 * @args: device IDENTIFY data / SCSI command of interest.
1517 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1518 * @buflen: Response buffer length.
1520 * Yields two logical unit device identification designators:
1521 * - vendor specific ASCII containing the ATA serial number
1522 * - SAT defined "t10 vendor id based" containing ASCII vendor
1523 * name ("ATA "), model and serial numbers.
1525 * LOCKING:
1526 * spin_lock_irqsave(host_set lock)
1529 unsigned int ata_scsiop_inq_83(struct ata_scsi_args *args, u8 *rbuf,
1530 unsigned int buflen)
1532 int num;
1533 const int sat_model_serial_desc_len = 68;
1534 const int ata_model_byte_len = 40;
1536 rbuf[1] = 0x83; /* this page code */
1537 num = 4;
1539 if (buflen > (ATA_SERNO_LEN + num + 3)) {
1540 /* piv=0, assoc=lu, code_set=ACSII, designator=vendor */
1541 rbuf[num + 0] = 2;
1542 rbuf[num + 3] = ATA_SERNO_LEN;
1543 num += 4;
1544 ata_id_string(args->id, (unsigned char *) rbuf + num,
1545 ATA_ID_SERNO_OFS, ATA_SERNO_LEN);
1546 num += ATA_SERNO_LEN;
1548 if (buflen > (sat_model_serial_desc_len + num + 3)) {
1549 /* SAT defined lu model and serial numbers descriptor */
1550 /* piv=0, assoc=lu, code_set=ACSII, designator=t10 vendor id */
1551 rbuf[num + 0] = 2;
1552 rbuf[num + 1] = 1;
1553 rbuf[num + 3] = sat_model_serial_desc_len;
1554 num += 4;
1555 memcpy(rbuf + num, "ATA ", 8);
1556 num += 8;
1557 ata_id_string(args->id, (unsigned char *) rbuf + num,
1558 ATA_ID_PROD_OFS, ata_model_byte_len);
1559 num += ata_model_byte_len;
1560 ata_id_string(args->id, (unsigned char *) rbuf + num,
1561 ATA_ID_SERNO_OFS, ATA_SERNO_LEN);
1562 num += ATA_SERNO_LEN;
1564 rbuf[3] = num - 4; /* page len (assume less than 256 bytes) */
1565 return 0;
1569 * ata_scsiop_noop - Command handler that simply returns success.
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 * No operation. Simply returns success to caller, to indicate
1575 * that the caller should successfully complete this SCSI command.
1577 * LOCKING:
1578 * spin_lock_irqsave(host_set lock)
1581 unsigned int ata_scsiop_noop(struct ata_scsi_args *args, u8 *rbuf,
1582 unsigned int buflen)
1584 VPRINTK("ENTER\n");
1585 return 0;
1589 * ata_msense_push - Push data onto MODE SENSE data output buffer
1590 * @ptr_io: (input/output) Location to store more output data
1591 * @last: End of output data buffer
1592 * @buf: Pointer to BLOB being added to output buffer
1593 * @buflen: Length of BLOB
1595 * Store MODE SENSE data on an output buffer.
1597 * LOCKING:
1598 * None.
1601 static void ata_msense_push(u8 **ptr_io, const u8 *last,
1602 const u8 *buf, unsigned int buflen)
1604 u8 *ptr = *ptr_io;
1606 if ((ptr + buflen - 1) > last)
1607 return;
1609 memcpy(ptr, buf, buflen);
1611 ptr += buflen;
1613 *ptr_io = ptr;
1617 * ata_msense_caching - Simulate MODE SENSE caching info page
1618 * @id: device IDENTIFY data
1619 * @ptr_io: (input/output) Location to store more output data
1620 * @last: End of output data buffer
1622 * Generate a caching info page, which conditionally indicates
1623 * write caching to the SCSI layer, depending on device
1624 * capabilities.
1626 * LOCKING:
1627 * None.
1630 static unsigned int ata_msense_caching(u16 *id, u8 **ptr_io,
1631 const u8 *last)
1633 u8 page[CACHE_MPAGE_LEN];
1635 memcpy(page, def_cache_mpage, sizeof(page));
1636 if (ata_id_wcache_enabled(id))
1637 page[2] |= (1 << 2); /* write cache enable */
1638 if (!ata_id_rahead_enabled(id))
1639 page[12] |= (1 << 5); /* disable read ahead */
1641 ata_msense_push(ptr_io, last, page, sizeof(page));
1642 return sizeof(page);
1646 * ata_msense_ctl_mode - Simulate MODE SENSE control mode page
1647 * @dev: Device associated with this MODE SENSE command
1648 * @ptr_io: (input/output) Location to store more output data
1649 * @last: End of output data buffer
1651 * Generate a generic MODE SENSE control mode page.
1653 * LOCKING:
1654 * None.
1657 static unsigned int ata_msense_ctl_mode(u8 **ptr_io, const u8 *last)
1659 ata_msense_push(ptr_io, last, def_control_mpage,
1660 sizeof(def_control_mpage));
1661 return sizeof(def_control_mpage);
1665 * ata_msense_rw_recovery - Simulate MODE SENSE r/w error recovery page
1666 * @dev: Device associated with this MODE SENSE command
1667 * @ptr_io: (input/output) Location to store more output data
1668 * @last: End of output data buffer
1670 * Generate a generic MODE SENSE r/w error recovery page.
1672 * LOCKING:
1673 * None.
1676 static unsigned int ata_msense_rw_recovery(u8 **ptr_io, const u8 *last)
1679 ata_msense_push(ptr_io, last, def_rw_recovery_mpage,
1680 sizeof(def_rw_recovery_mpage));
1681 return sizeof(def_rw_recovery_mpage);
1685 * We can turn this into a real blacklist if it's needed, for now just
1686 * blacklist any Maxtor BANC1G10 revision firmware
1688 static int ata_dev_supports_fua(u16 *id)
1690 unsigned char model[41], fw[9];
1692 if (!libata_fua)
1693 return 0;
1694 if (!ata_id_has_fua(id))
1695 return 0;
1697 ata_id_c_string(id, model, ATA_ID_PROD_OFS, sizeof(model));
1698 ata_id_c_string(id, fw, ATA_ID_FW_REV_OFS, sizeof(fw));
1700 if (strcmp(model, "Maxtor"))
1701 return 1;
1702 if (strcmp(fw, "BANC1G10"))
1703 return 1;
1705 return 0; /* blacklisted */
1709 * ata_scsiop_mode_sense - Simulate MODE SENSE 6, 10 commands
1710 * @args: device IDENTIFY data / SCSI command of interest.
1711 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1712 * @buflen: Response buffer length.
1714 * Simulate MODE SENSE commands. Assume this is invoked for direct
1715 * access devices (e.g. disks) only. There should be no block
1716 * descriptor for other device types.
1718 * LOCKING:
1719 * spin_lock_irqsave(host_set lock)
1722 unsigned int ata_scsiop_mode_sense(struct ata_scsi_args *args, u8 *rbuf,
1723 unsigned int buflen)
1725 struct ata_device *dev = args->dev;
1726 u8 *scsicmd = args->cmd->cmnd, *p, *last;
1727 const u8 sat_blk_desc[] = {
1728 0, 0, 0, 0, /* number of blocks: sat unspecified */
1730 0, 0x2, 0x0 /* block length: 512 bytes */
1732 u8 pg, spg;
1733 unsigned int ebd, page_control, six_byte, output_len, alloc_len, minlen;
1734 u8 dpofua;
1736 VPRINTK("ENTER\n");
1738 six_byte = (scsicmd[0] == MODE_SENSE);
1739 ebd = !(scsicmd[1] & 0x8); /* dbd bit inverted == edb */
1741 * LLBA bit in msense(10) ignored (compliant)
1744 page_control = scsicmd[2] >> 6;
1745 switch (page_control) {
1746 case 0: /* current */
1747 break; /* supported */
1748 case 3: /* saved */
1749 goto saving_not_supp;
1750 case 1: /* changeable */
1751 case 2: /* defaults */
1752 default:
1753 goto invalid_fld;
1756 if (six_byte) {
1757 output_len = 4 + (ebd ? 8 : 0);
1758 alloc_len = scsicmd[4];
1759 } else {
1760 output_len = 8 + (ebd ? 8 : 0);
1761 alloc_len = (scsicmd[7] << 8) + scsicmd[8];
1763 minlen = (alloc_len < buflen) ? alloc_len : buflen;
1765 p = rbuf + output_len;
1766 last = rbuf + minlen - 1;
1768 pg = scsicmd[2] & 0x3f;
1769 spg = scsicmd[3];
1771 * No mode subpages supported (yet) but asking for _all_
1772 * subpages may be valid
1774 if (spg && (spg != ALL_SUB_MPAGES))
1775 goto invalid_fld;
1777 switch(pg) {
1778 case RW_RECOVERY_MPAGE:
1779 output_len += ata_msense_rw_recovery(&p, last);
1780 break;
1782 case CACHE_MPAGE:
1783 output_len += ata_msense_caching(args->id, &p, last);
1784 break;
1786 case CONTROL_MPAGE: {
1787 output_len += ata_msense_ctl_mode(&p, last);
1788 break;
1791 case ALL_MPAGES:
1792 output_len += ata_msense_rw_recovery(&p, last);
1793 output_len += ata_msense_caching(args->id, &p, last);
1794 output_len += ata_msense_ctl_mode(&p, last);
1795 break;
1797 default: /* invalid page code */
1798 goto invalid_fld;
1801 if (minlen < 1)
1802 return 0;
1804 dpofua = 0;
1805 if (ata_dev_supports_fua(args->id) && dev->flags & ATA_DFLAG_LBA48 &&
1806 (!(dev->flags & ATA_DFLAG_PIO) || dev->multi_count))
1807 dpofua = 1 << 4;
1809 if (six_byte) {
1810 output_len--;
1811 rbuf[0] = output_len;
1812 if (minlen > 2)
1813 rbuf[2] |= dpofua;
1814 if (ebd) {
1815 if (minlen > 3)
1816 rbuf[3] = sizeof(sat_blk_desc);
1817 if (minlen > 11)
1818 memcpy(rbuf + 4, sat_blk_desc,
1819 sizeof(sat_blk_desc));
1821 } else {
1822 output_len -= 2;
1823 rbuf[0] = output_len >> 8;
1824 if (minlen > 1)
1825 rbuf[1] = output_len;
1826 if (minlen > 3)
1827 rbuf[3] |= dpofua;
1828 if (ebd) {
1829 if (minlen > 7)
1830 rbuf[7] = sizeof(sat_blk_desc);
1831 if (minlen > 15)
1832 memcpy(rbuf + 8, sat_blk_desc,
1833 sizeof(sat_blk_desc));
1836 return 0;
1838 invalid_fld:
1839 ata_scsi_set_sense(args->cmd, ILLEGAL_REQUEST, 0x24, 0x0);
1840 /* "Invalid field in cbd" */
1841 return 1;
1843 saving_not_supp:
1844 ata_scsi_set_sense(args->cmd, ILLEGAL_REQUEST, 0x39, 0x0);
1845 /* "Saving parameters not supported" */
1846 return 1;
1850 * ata_scsiop_read_cap - Simulate READ CAPACITY[ 16] commands
1851 * @args: device IDENTIFY data / SCSI command of interest.
1852 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1853 * @buflen: Response buffer length.
1855 * Simulate READ CAPACITY commands.
1857 * LOCKING:
1858 * spin_lock_irqsave(host_set lock)
1861 unsigned int ata_scsiop_read_cap(struct ata_scsi_args *args, u8 *rbuf,
1862 unsigned int buflen)
1864 u64 n_sectors;
1865 u32 tmp;
1867 VPRINTK("ENTER\n");
1869 if (ata_id_has_lba(args->id)) {
1870 if (ata_id_has_lba48(args->id))
1871 n_sectors = ata_id_u64(args->id, 100);
1872 else
1873 n_sectors = ata_id_u32(args->id, 60);
1874 } else {
1875 /* CHS default translation */
1876 n_sectors = args->id[1] * args->id[3] * args->id[6];
1878 if (ata_id_current_chs_valid(args->id))
1879 /* CHS current translation */
1880 n_sectors = ata_id_u32(args->id, 57);
1883 n_sectors--; /* ATA TotalUserSectors - 1 */
1885 if (args->cmd->cmnd[0] == READ_CAPACITY) {
1886 if( n_sectors >= 0xffffffffULL )
1887 tmp = 0xffffffff ; /* Return max count on overflow */
1888 else
1889 tmp = n_sectors ;
1891 /* sector count, 32-bit */
1892 rbuf[0] = tmp >> (8 * 3);
1893 rbuf[1] = tmp >> (8 * 2);
1894 rbuf[2] = tmp >> (8 * 1);
1895 rbuf[3] = tmp;
1897 /* sector size */
1898 tmp = ATA_SECT_SIZE;
1899 rbuf[6] = tmp >> 8;
1900 rbuf[7] = tmp;
1902 } else {
1903 /* sector count, 64-bit */
1904 tmp = n_sectors >> (8 * 4);
1905 rbuf[2] = tmp >> (8 * 3);
1906 rbuf[3] = tmp >> (8 * 2);
1907 rbuf[4] = tmp >> (8 * 1);
1908 rbuf[5] = tmp;
1909 tmp = n_sectors;
1910 rbuf[6] = tmp >> (8 * 3);
1911 rbuf[7] = tmp >> (8 * 2);
1912 rbuf[8] = tmp >> (8 * 1);
1913 rbuf[9] = tmp;
1915 /* sector size */
1916 tmp = ATA_SECT_SIZE;
1917 rbuf[12] = tmp >> 8;
1918 rbuf[13] = tmp;
1921 return 0;
1925 * ata_scsiop_report_luns - Simulate REPORT LUNS command
1926 * @args: device IDENTIFY data / SCSI command of interest.
1927 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1928 * @buflen: Response buffer length.
1930 * Simulate REPORT LUNS command.
1932 * LOCKING:
1933 * spin_lock_irqsave(host_set lock)
1936 unsigned int ata_scsiop_report_luns(struct ata_scsi_args *args, u8 *rbuf,
1937 unsigned int buflen)
1939 VPRINTK("ENTER\n");
1940 rbuf[3] = 8; /* just one lun, LUN 0, size 8 bytes */
1942 return 0;
1946 * ata_scsi_set_sense - Set SCSI sense data and status
1947 * @cmd: SCSI request to be handled
1948 * @sk: SCSI-defined sense key
1949 * @asc: SCSI-defined additional sense code
1950 * @ascq: SCSI-defined additional sense code qualifier
1952 * Helper function that builds a valid fixed format, current
1953 * response code and the given sense key (sk), additional sense
1954 * code (asc) and additional sense code qualifier (ascq) with
1955 * a SCSI command status of %SAM_STAT_CHECK_CONDITION and
1956 * DRIVER_SENSE set in the upper bits of scsi_cmnd::result .
1958 * LOCKING:
1959 * Not required
1962 void ata_scsi_set_sense(struct scsi_cmnd *cmd, u8 sk, u8 asc, u8 ascq)
1964 cmd->result = (DRIVER_SENSE << 24) | SAM_STAT_CHECK_CONDITION;
1966 cmd->sense_buffer[0] = 0x70; /* fixed format, current */
1967 cmd->sense_buffer[2] = sk;
1968 cmd->sense_buffer[7] = 18 - 8; /* additional sense length */
1969 cmd->sense_buffer[12] = asc;
1970 cmd->sense_buffer[13] = ascq;
1974 * ata_scsi_badcmd - End a SCSI request with an error
1975 * @cmd: SCSI request to be handled
1976 * @done: SCSI command completion function
1977 * @asc: SCSI-defined additional sense code
1978 * @ascq: SCSI-defined additional sense code qualifier
1980 * Helper function that completes a SCSI command with
1981 * %SAM_STAT_CHECK_CONDITION, with a sense key %ILLEGAL_REQUEST
1982 * and the specified additional sense codes.
1984 * LOCKING:
1985 * spin_lock_irqsave(host_set lock)
1988 void ata_scsi_badcmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *), u8 asc, u8 ascq)
1990 DPRINTK("ENTER\n");
1991 ata_scsi_set_sense(cmd, ILLEGAL_REQUEST, asc, ascq);
1993 done(cmd);
1996 static void atapi_sense_complete(struct ata_queued_cmd *qc)
1998 if (qc->err_mask && ((qc->err_mask & AC_ERR_DEV) == 0)) {
1999 /* FIXME: not quite right; we don't want the
2000 * translation of taskfile registers into
2001 * a sense descriptors, since that's only
2002 * correct for ATA, not ATAPI
2004 ata_gen_ata_desc_sense(qc);
2007 qc->scsidone(qc->scsicmd);
2008 ata_qc_free(qc);
2011 /* is it pointless to prefer PIO for "safety reasons"? */
2012 static inline int ata_pio_use_silly(struct ata_port *ap)
2014 return (ap->flags & ATA_FLAG_PIO_DMA);
2017 static void atapi_request_sense(struct ata_queued_cmd *qc)
2019 struct ata_port *ap = qc->ap;
2020 struct scsi_cmnd *cmd = qc->scsicmd;
2022 DPRINTK("ATAPI request sense\n");
2024 /* FIXME: is this needed? */
2025 memset(cmd->sense_buffer, 0, sizeof(cmd->sense_buffer));
2027 ap->ops->tf_read(ap, &qc->tf);
2029 /* fill these in, for the case where they are -not- overwritten */
2030 cmd->sense_buffer[0] = 0x70;
2031 cmd->sense_buffer[2] = qc->tf.feature >> 4;
2033 ata_qc_reinit(qc);
2035 ata_sg_init_one(qc, cmd->sense_buffer, sizeof(cmd->sense_buffer));
2036 qc->dma_dir = DMA_FROM_DEVICE;
2038 memset(&qc->cdb, 0, qc->dev->cdb_len);
2039 qc->cdb[0] = REQUEST_SENSE;
2040 qc->cdb[4] = SCSI_SENSE_BUFFERSIZE;
2042 qc->tf.flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
2043 qc->tf.command = ATA_CMD_PACKET;
2045 if (ata_pio_use_silly(ap)) {
2046 qc->tf.protocol = ATA_PROT_ATAPI_DMA;
2047 qc->tf.feature |= ATAPI_PKT_DMA;
2048 } else {
2049 qc->tf.protocol = ATA_PROT_ATAPI;
2050 qc->tf.lbam = (8 * 1024) & 0xff;
2051 qc->tf.lbah = (8 * 1024) >> 8;
2053 qc->nbytes = SCSI_SENSE_BUFFERSIZE;
2055 qc->complete_fn = atapi_sense_complete;
2057 ata_qc_issue(qc);
2059 DPRINTK("EXIT\n");
2062 static void atapi_qc_complete(struct ata_queued_cmd *qc)
2064 struct scsi_cmnd *cmd = qc->scsicmd;
2065 unsigned int err_mask = qc->err_mask;
2067 VPRINTK("ENTER, err_mask 0x%X\n", err_mask);
2069 /* handle completion from new EH */
2070 if (unlikely(qc->ap->ops->error_handler &&
2071 (err_mask || qc->flags & ATA_QCFLAG_SENSE_VALID))) {
2073 if (!(qc->flags & ATA_QCFLAG_SENSE_VALID)) {
2074 /* FIXME: not quite right; we don't want the
2075 * translation of taskfile registers into a
2076 * sense descriptors, since that's only
2077 * correct for ATA, not ATAPI
2079 ata_gen_ata_desc_sense(qc);
2082 qc->scsicmd->result = SAM_STAT_CHECK_CONDITION;
2083 qc->scsidone(cmd);
2084 ata_qc_free(qc);
2085 return;
2088 /* successful completion or old EH failure path */
2089 if (unlikely(err_mask & AC_ERR_DEV)) {
2090 cmd->result = SAM_STAT_CHECK_CONDITION;
2091 atapi_request_sense(qc);
2092 return;
2093 } else if (unlikely(err_mask)) {
2094 /* FIXME: not quite right; we don't want the
2095 * translation of taskfile registers into
2096 * a sense descriptors, since that's only
2097 * correct for ATA, not ATAPI
2099 ata_gen_ata_desc_sense(qc);
2100 } else {
2101 u8 *scsicmd = cmd->cmnd;
2103 if ((scsicmd[0] == INQUIRY) && ((scsicmd[1] & 0x03) == 0)) {
2104 u8 *buf = NULL;
2105 unsigned int buflen;
2107 buflen = ata_scsi_rbuf_get(cmd, &buf);
2109 /* ATAPI devices typically report zero for their SCSI version,
2110 * and sometimes deviate from the spec WRT response data
2111 * format. If SCSI version is reported as zero like normal,
2112 * then we make the following fixups: 1) Fake MMC-5 version,
2113 * to indicate to the Linux scsi midlayer this is a modern
2114 * device. 2) Ensure response data format / ATAPI information
2115 * are always correct.
2117 if (buf[2] == 0) {
2118 buf[2] = 0x5;
2119 buf[3] = 0x32;
2122 ata_scsi_rbuf_put(cmd, buf);
2125 cmd->result = SAM_STAT_GOOD;
2128 qc->scsidone(cmd);
2129 ata_qc_free(qc);
2132 * atapi_xlat - Initialize PACKET taskfile
2133 * @qc: command structure to be initialized
2134 * @scsicmd: SCSI CDB associated with this PACKET command
2136 * LOCKING:
2137 * spin_lock_irqsave(host_set lock)
2139 * RETURNS:
2140 * Zero on success, non-zero on failure.
2143 static unsigned int atapi_xlat(struct ata_queued_cmd *qc, const u8 *scsicmd)
2145 struct scsi_cmnd *cmd = qc->scsicmd;
2146 struct ata_device *dev = qc->dev;
2147 int using_pio = (dev->flags & ATA_DFLAG_PIO);
2148 int nodata = (cmd->sc_data_direction == DMA_NONE);
2150 if (!using_pio)
2151 /* Check whether ATAPI DMA is safe */
2152 if (ata_check_atapi_dma(qc))
2153 using_pio = 1;
2155 memcpy(&qc->cdb, scsicmd, dev->cdb_len);
2157 qc->complete_fn = atapi_qc_complete;
2159 qc->tf.flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
2160 if (cmd->sc_data_direction == DMA_TO_DEVICE) {
2161 qc->tf.flags |= ATA_TFLAG_WRITE;
2162 DPRINTK("direction: write\n");
2165 qc->tf.command = ATA_CMD_PACKET;
2167 /* no data, or PIO data xfer */
2168 if (using_pio || nodata) {
2169 if (nodata)
2170 qc->tf.protocol = ATA_PROT_ATAPI_NODATA;
2171 else
2172 qc->tf.protocol = ATA_PROT_ATAPI;
2173 qc->tf.lbam = (8 * 1024) & 0xff;
2174 qc->tf.lbah = (8 * 1024) >> 8;
2177 /* DMA data xfer */
2178 else {
2179 qc->tf.protocol = ATA_PROT_ATAPI_DMA;
2180 qc->tf.feature |= ATAPI_PKT_DMA;
2182 if (atapi_dmadir && (cmd->sc_data_direction != DMA_TO_DEVICE))
2183 /* some SATA bridges need us to indicate data xfer direction */
2184 qc->tf.feature |= ATAPI_DMADIR;
2187 qc->nbytes = cmd->bufflen;
2189 return 0;
2193 * ata_scsi_find_dev - lookup ata_device from scsi_cmnd
2194 * @ap: ATA port to which the device is attached
2195 * @scsidev: SCSI device from which we derive the ATA device
2197 * Given various information provided in struct scsi_cmnd,
2198 * map that onto an ATA bus, and using that mapping
2199 * determine which ata_device is associated with the
2200 * SCSI command to be sent.
2202 * LOCKING:
2203 * spin_lock_irqsave(host_set lock)
2205 * RETURNS:
2206 * Associated ATA device, or %NULL if not found.
2209 static struct ata_device *
2210 ata_scsi_find_dev(struct ata_port *ap, const struct scsi_device *scsidev)
2212 struct ata_device *dev;
2214 /* skip commands not addressed to targets we simulate */
2215 if (likely(scsidev->id < ATA_MAX_DEVICES))
2216 dev = &ap->device[scsidev->id];
2217 else
2218 return NULL;
2220 if (unlikely((scsidev->channel != 0) ||
2221 (scsidev->lun != 0)))
2222 return NULL;
2224 if (unlikely(!ata_dev_enabled(dev)))
2225 return NULL;
2227 if (!atapi_enabled || (ap->flags & ATA_FLAG_NO_ATAPI)) {
2228 if (unlikely(dev->class == ATA_DEV_ATAPI)) {
2229 ata_dev_printk(dev, KERN_WARNING,
2230 "WARNING: ATAPI is %s, device ignored.\n",
2231 atapi_enabled ? "not supported with this driver" : "disabled");
2232 return NULL;
2236 return dev;
2240 * ata_scsi_map_proto - Map pass-thru protocol value to taskfile value.
2241 * @byte1: Byte 1 from pass-thru CDB.
2243 * RETURNS:
2244 * ATA_PROT_UNKNOWN if mapping failed/unimplemented, protocol otherwise.
2246 static u8
2247 ata_scsi_map_proto(u8 byte1)
2249 switch((byte1 & 0x1e) >> 1) {
2250 case 3: /* Non-data */
2251 return ATA_PROT_NODATA;
2253 case 6: /* DMA */
2254 return ATA_PROT_DMA;
2256 case 4: /* PIO Data-in */
2257 case 5: /* PIO Data-out */
2258 return ATA_PROT_PIO;
2260 case 10: /* Device Reset */
2261 case 0: /* Hard Reset */
2262 case 1: /* SRST */
2263 case 2: /* Bus Idle */
2264 case 7: /* Packet */
2265 case 8: /* DMA Queued */
2266 case 9: /* Device Diagnostic */
2267 case 11: /* UDMA Data-in */
2268 case 12: /* UDMA Data-Out */
2269 case 13: /* FPDMA */
2270 default: /* Reserved */
2271 break;
2274 return ATA_PROT_UNKNOWN;
2278 * ata_scsi_pass_thru - convert ATA pass-thru CDB to taskfile
2279 * @qc: command structure to be initialized
2280 * @scsicmd: SCSI command to convert
2282 * Handles either 12 or 16-byte versions of the CDB.
2284 * RETURNS:
2285 * Zero on success, non-zero on failure.
2287 static unsigned int
2288 ata_scsi_pass_thru(struct ata_queued_cmd *qc, const u8 *scsicmd)
2290 struct ata_taskfile *tf = &(qc->tf);
2291 struct scsi_cmnd *cmd = qc->scsicmd;
2293 if ((tf->protocol = ata_scsi_map_proto(scsicmd[1])) == ATA_PROT_UNKNOWN)
2294 goto invalid_fld;
2296 if (scsicmd[1] & 0xe0)
2297 /* PIO multi not supported yet */
2298 goto invalid_fld;
2301 * 12 and 16 byte CDBs use different offsets to
2302 * provide the various register values.
2304 if (scsicmd[0] == ATA_16) {
2306 * 16-byte CDB - may contain extended commands.
2308 * If that is the case, copy the upper byte register values.
2310 if (scsicmd[1] & 0x01) {
2311 tf->hob_feature = scsicmd[3];
2312 tf->hob_nsect = scsicmd[5];
2313 tf->hob_lbal = scsicmd[7];
2314 tf->hob_lbam = scsicmd[9];
2315 tf->hob_lbah = scsicmd[11];
2316 tf->flags |= ATA_TFLAG_LBA48;
2317 } else
2318 tf->flags &= ~ATA_TFLAG_LBA48;
2321 * Always copy low byte, device and command registers.
2323 tf->feature = scsicmd[4];
2324 tf->nsect = scsicmd[6];
2325 tf->lbal = scsicmd[8];
2326 tf->lbam = scsicmd[10];
2327 tf->lbah = scsicmd[12];
2328 tf->device = scsicmd[13];
2329 tf->command = scsicmd[14];
2330 } else {
2332 * 12-byte CDB - incapable of extended commands.
2334 tf->flags &= ~ATA_TFLAG_LBA48;
2336 tf->feature = scsicmd[3];
2337 tf->nsect = scsicmd[4];
2338 tf->lbal = scsicmd[5];
2339 tf->lbam = scsicmd[6];
2340 tf->lbah = scsicmd[7];
2341 tf->device = scsicmd[8];
2342 tf->command = scsicmd[9];
2345 * If slave is possible, enforce correct master/slave bit
2347 if (qc->ap->flags & ATA_FLAG_SLAVE_POSS)
2348 tf->device = qc->dev->devno ?
2349 tf->device | ATA_DEV1 : tf->device & ~ATA_DEV1;
2352 * Filter SET_FEATURES - XFER MODE command -- otherwise,
2353 * SET_FEATURES - XFER MODE must be preceded/succeeded
2354 * by an update to hardware-specific registers for each
2355 * controller (i.e. the reason for ->set_piomode(),
2356 * ->set_dmamode(), and ->post_set_mode() hooks).
2358 if ((tf->command == ATA_CMD_SET_FEATURES)
2359 && (tf->feature == SETFEATURES_XFER))
2360 goto invalid_fld;
2363 * Set flags so that all registers will be written,
2364 * and pass on write indication (used for PIO/DMA
2365 * setup.)
2367 tf->flags |= (ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE);
2369 if (cmd->sc_data_direction == DMA_TO_DEVICE)
2370 tf->flags |= ATA_TFLAG_WRITE;
2373 * Set transfer length.
2375 * TODO: find out if we need to do more here to
2376 * cover scatter/gather case.
2378 qc->nsect = cmd->bufflen / ATA_SECT_SIZE;
2380 /* request result TF */
2381 qc->flags |= ATA_QCFLAG_RESULT_TF;
2383 return 0;
2385 invalid_fld:
2386 ata_scsi_set_sense(qc->scsicmd, ILLEGAL_REQUEST, 0x24, 0x00);
2387 /* "Invalid field in cdb" */
2388 return 1;
2392 * ata_get_xlat_func - check if SCSI to ATA translation is possible
2393 * @dev: ATA device
2394 * @cmd: SCSI command opcode to consider
2396 * Look up the SCSI command given, and determine whether the
2397 * SCSI command is to be translated or simulated.
2399 * RETURNS:
2400 * Pointer to translation function if possible, %NULL if not.
2403 static inline ata_xlat_func_t ata_get_xlat_func(struct ata_device *dev, u8 cmd)
2405 switch (cmd) {
2406 case READ_6:
2407 case READ_10:
2408 case READ_16:
2410 case WRITE_6:
2411 case WRITE_10:
2412 case WRITE_16:
2413 return ata_scsi_rw_xlat;
2415 case SYNCHRONIZE_CACHE:
2416 if (ata_try_flush_cache(dev))
2417 return ata_scsi_flush_xlat;
2418 break;
2420 case VERIFY:
2421 case VERIFY_16:
2422 return ata_scsi_verify_xlat;
2424 case ATA_12:
2425 case ATA_16:
2426 return ata_scsi_pass_thru;
2428 case START_STOP:
2429 return ata_scsi_start_stop_xlat;
2432 return NULL;
2436 * ata_scsi_dump_cdb - dump SCSI command contents to dmesg
2437 * @ap: ATA port to which the command was being sent
2438 * @cmd: SCSI command to dump
2440 * Prints the contents of a SCSI command via printk().
2443 static inline void ata_scsi_dump_cdb(struct ata_port *ap,
2444 struct scsi_cmnd *cmd)
2446 #ifdef ATA_DEBUG
2447 struct scsi_device *scsidev = cmd->device;
2448 u8 *scsicmd = cmd->cmnd;
2450 DPRINTK("CDB (%u:%d,%d,%d) %02x %02x %02x %02x %02x %02x %02x %02x %02x\n",
2451 ap->id,
2452 scsidev->channel, scsidev->id, scsidev->lun,
2453 scsicmd[0], scsicmd[1], scsicmd[2], scsicmd[3],
2454 scsicmd[4], scsicmd[5], scsicmd[6], scsicmd[7],
2455 scsicmd[8]);
2456 #endif
2459 static inline void __ata_scsi_queuecmd(struct scsi_cmnd *cmd,
2460 void (*done)(struct scsi_cmnd *),
2461 struct ata_device *dev)
2463 if (dev->class == ATA_DEV_ATA) {
2464 ata_xlat_func_t xlat_func = ata_get_xlat_func(dev,
2465 cmd->cmnd[0]);
2467 if (xlat_func)
2468 ata_scsi_translate(dev, cmd, done, xlat_func);
2469 else
2470 ata_scsi_simulate(dev, cmd, done);
2471 } else
2472 ata_scsi_translate(dev, cmd, done, atapi_xlat);
2476 * ata_scsi_queuecmd - Issue SCSI cdb to libata-managed device
2477 * @cmd: SCSI command to be sent
2478 * @done: Completion function, called when command is complete
2480 * In some cases, this function translates SCSI commands into
2481 * ATA taskfiles, and queues the taskfiles to be sent to
2482 * hardware. In other cases, this function simulates a
2483 * SCSI device by evaluating and responding to certain
2484 * SCSI commands. This creates the overall effect of
2485 * ATA and ATAPI devices appearing as SCSI devices.
2487 * LOCKING:
2488 * Releases scsi-layer-held lock, and obtains host_set lock.
2490 * RETURNS:
2491 * Zero.
2494 int ata_scsi_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *))
2496 struct ata_port *ap;
2497 struct ata_device *dev;
2498 struct scsi_device *scsidev = cmd->device;
2499 struct Scsi_Host *shost = scsidev->host;
2501 ap = ata_shost_to_port(shost);
2503 spin_unlock(shost->host_lock);
2504 spin_lock(&ap->host_set->lock);
2506 ata_scsi_dump_cdb(ap, cmd);
2508 dev = ata_scsi_find_dev(ap, scsidev);
2509 if (likely(dev))
2510 __ata_scsi_queuecmd(cmd, done, dev);
2511 else {
2512 cmd->result = (DID_BAD_TARGET << 16);
2513 done(cmd);
2516 spin_unlock(&ap->host_set->lock);
2517 spin_lock(shost->host_lock);
2518 return 0;
2522 * ata_scsi_simulate - simulate SCSI command on ATA device
2523 * @dev: the target device
2524 * @cmd: SCSI command being sent to device.
2525 * @done: SCSI command completion function.
2527 * Interprets and directly executes a select list of SCSI commands
2528 * that can be handled internally.
2530 * LOCKING:
2531 * spin_lock_irqsave(host_set lock)
2534 void ata_scsi_simulate(struct ata_device *dev, struct scsi_cmnd *cmd,
2535 void (*done)(struct scsi_cmnd *))
2537 struct ata_scsi_args args;
2538 const u8 *scsicmd = cmd->cmnd;
2540 args.dev = dev;
2541 args.id = dev->id;
2542 args.cmd = cmd;
2543 args.done = done;
2545 switch(scsicmd[0]) {
2546 /* no-op's, complete with success */
2547 case SYNCHRONIZE_CACHE:
2548 case REZERO_UNIT:
2549 case SEEK_6:
2550 case SEEK_10:
2551 case TEST_UNIT_READY:
2552 case FORMAT_UNIT: /* FIXME: correct? */
2553 case SEND_DIAGNOSTIC: /* FIXME: correct? */
2554 ata_scsi_rbuf_fill(&args, ata_scsiop_noop);
2555 break;
2557 case INQUIRY:
2558 if (scsicmd[1] & 2) /* is CmdDt set? */
2559 ata_scsi_invalid_field(cmd, done);
2560 else if ((scsicmd[1] & 1) == 0) /* is EVPD clear? */
2561 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_std);
2562 else if (scsicmd[2] == 0x00)
2563 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_00);
2564 else if (scsicmd[2] == 0x80)
2565 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_80);
2566 else if (scsicmd[2] == 0x83)
2567 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_83);
2568 else
2569 ata_scsi_invalid_field(cmd, done);
2570 break;
2572 case MODE_SENSE:
2573 case MODE_SENSE_10:
2574 ata_scsi_rbuf_fill(&args, ata_scsiop_mode_sense);
2575 break;
2577 case MODE_SELECT: /* unconditionally return */
2578 case MODE_SELECT_10: /* bad-field-in-cdb */
2579 ata_scsi_invalid_field(cmd, done);
2580 break;
2582 case READ_CAPACITY:
2583 ata_scsi_rbuf_fill(&args, ata_scsiop_read_cap);
2584 break;
2586 case SERVICE_ACTION_IN:
2587 if ((scsicmd[1] & 0x1f) == SAI_READ_CAPACITY_16)
2588 ata_scsi_rbuf_fill(&args, ata_scsiop_read_cap);
2589 else
2590 ata_scsi_invalid_field(cmd, done);
2591 break;
2593 case REPORT_LUNS:
2594 ata_scsi_rbuf_fill(&args, ata_scsiop_report_luns);
2595 break;
2597 /* mandatory commands we haven't implemented yet */
2598 case REQUEST_SENSE:
2600 /* all other commands */
2601 default:
2602 ata_scsi_set_sense(cmd, ILLEGAL_REQUEST, 0x20, 0x0);
2603 /* "Invalid command operation code" */
2604 done(cmd);
2605 break;
2609 void ata_scsi_scan_host(struct ata_port *ap)
2611 struct ata_device *dev;
2612 unsigned int i;
2614 if (ap->flags & ATA_FLAG_DISABLED)
2615 return;
2617 for (i = 0; i < ATA_MAX_DEVICES; i++) {
2618 dev = &ap->device[i];
2620 if (ata_dev_enabled(dev))
2621 scsi_scan_target(&ap->host->shost_gendev, 0, i, 0, 0);
2626 * ata_schedule_scsi_eh - schedule EH for SCSI host
2627 * @shost: SCSI host to invoke error handling on.
2629 * Schedule SCSI EH without scmd. This is a hack.
2631 * LOCKING:
2632 * spin_lock_irqsave(host_set lock)
2634 void ata_schedule_scsi_eh(struct Scsi_Host *shost)
2636 unsigned long flags;
2638 spin_lock_irqsave(shost->host_lock, flags);
2640 if (scsi_host_set_state(shost, SHOST_RECOVERY) == 0 ||
2641 scsi_host_set_state(shost, SHOST_CANCEL_RECOVERY) == 0) {
2642 shost->host_eh_scheduled++;
2643 scsi_eh_wakeup(shost);
2646 spin_unlock_irqrestore(shost->host_lock, flags);