[PATCH] zlib_inflate: Upgrade library code to a recent version
[linux-2.6/linux-2.6-openrd.git] / drivers / scsi / libata-scsi.c
blobf1e129b7c9721373b2e65b5f3d0b1dc12278fc1d
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_cmnd.h>
42 #include <scsi/scsi_eh.h>
43 #include <scsi/scsi_device.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);
56 static void ata_scsi_error(struct Scsi_Host *host);
57 enum scsi_eh_timer_return ata_scsi_timed_out(struct scsi_cmnd *cmd);
59 #define RW_RECOVERY_MPAGE 0x1
60 #define RW_RECOVERY_MPAGE_LEN 12
61 #define CACHE_MPAGE 0x8
62 #define CACHE_MPAGE_LEN 20
63 #define CONTROL_MPAGE 0xa
64 #define CONTROL_MPAGE_LEN 12
65 #define ALL_MPAGES 0x3f
66 #define ALL_SUB_MPAGES 0xff
69 static const u8 def_rw_recovery_mpage[] = {
70 RW_RECOVERY_MPAGE,
71 RW_RECOVERY_MPAGE_LEN - 2,
72 (1 << 7) | /* AWRE, sat-r06 say it shall be 0 */
73 (1 << 6), /* ARRE (auto read reallocation) */
74 0, /* read retry count */
75 0, 0, 0, 0,
76 0, /* write retry count */
77 0, 0, 0
80 static const u8 def_cache_mpage[CACHE_MPAGE_LEN] = {
81 CACHE_MPAGE,
82 CACHE_MPAGE_LEN - 2,
83 0, /* contains WCE, needs to be 0 for logic */
84 0, 0, 0, 0, 0, 0, 0, 0, 0,
85 0, /* contains DRA, needs to be 0 for logic */
86 0, 0, 0, 0, 0, 0, 0
89 static const u8 def_control_mpage[CONTROL_MPAGE_LEN] = {
90 CONTROL_MPAGE,
91 CONTROL_MPAGE_LEN - 2,
92 2, /* DSENSE=0, GLTSD=1 */
93 0, /* [QAM+QERR may be 1, see 05-359r1] */
94 0, 0, 0, 0, 0xff, 0xff,
95 0, 30 /* extended self test time, see 05-359r1 */
99 * libata transport template. libata doesn't do real transport stuff.
100 * It just needs the eh_timed_out hook.
102 struct scsi_transport_template ata_scsi_transport_template = {
103 .eh_strategy_handler = ata_scsi_error,
104 .eh_timed_out = ata_scsi_timed_out,
108 static void ata_scsi_invalid_field(struct scsi_cmnd *cmd,
109 void (*done)(struct scsi_cmnd *))
111 ata_scsi_set_sense(cmd, ILLEGAL_REQUEST, 0x24, 0x0);
112 /* "Invalid field in cbd" */
113 done(cmd);
117 * ata_std_bios_param - generic bios head/sector/cylinder calculator used by sd.
118 * @sdev: SCSI device for which BIOS geometry is to be determined
119 * @bdev: block device associated with @sdev
120 * @capacity: capacity of SCSI device
121 * @geom: location to which geometry will be output
123 * Generic bios head/sector/cylinder calculator
124 * used by sd. Most BIOSes nowadays expect a XXX/255/16 (CHS)
125 * mapping. Some situations may arise where the disk is not
126 * bootable if this is not used.
128 * LOCKING:
129 * Defined by the SCSI layer. We don't really care.
131 * RETURNS:
132 * Zero.
134 int ata_std_bios_param(struct scsi_device *sdev, struct block_device *bdev,
135 sector_t capacity, int geom[])
137 geom[0] = 255;
138 geom[1] = 63;
139 sector_div(capacity, 255*63);
140 geom[2] = capacity;
142 return 0;
146 * ata_cmd_ioctl - Handler for HDIO_DRIVE_CMD ioctl
147 * @scsidev: Device to which we are issuing command
148 * @arg: User provided data for issuing command
150 * LOCKING:
151 * Defined by the SCSI layer. We don't really care.
153 * RETURNS:
154 * Zero on success, negative errno on error.
157 int ata_cmd_ioctl(struct scsi_device *scsidev, void __user *arg)
159 int rc = 0;
160 u8 scsi_cmd[MAX_COMMAND_SIZE];
161 u8 args[4], *argbuf = NULL;
162 int argsize = 0;
163 struct scsi_sense_hdr sshdr;
164 enum dma_data_direction data_dir;
166 if (arg == NULL)
167 return -EINVAL;
169 if (copy_from_user(args, arg, sizeof(args)))
170 return -EFAULT;
172 memset(scsi_cmd, 0, sizeof(scsi_cmd));
174 if (args[3]) {
175 argsize = SECTOR_SIZE * args[3];
176 argbuf = kmalloc(argsize, GFP_KERNEL);
177 if (argbuf == NULL) {
178 rc = -ENOMEM;
179 goto error;
182 scsi_cmd[1] = (4 << 1); /* PIO Data-in */
183 scsi_cmd[2] = 0x0e; /* no off.line or cc, read from dev,
184 block count in sector count field */
185 data_dir = DMA_FROM_DEVICE;
186 } else {
187 scsi_cmd[1] = (3 << 1); /* Non-data */
188 /* scsi_cmd[2] is already 0 -- no off.line, cc, or data xfer */
189 data_dir = DMA_NONE;
192 scsi_cmd[0] = ATA_16;
194 scsi_cmd[4] = args[2];
195 if (args[0] == WIN_SMART) { /* hack -- ide driver does this too... */
196 scsi_cmd[6] = args[3];
197 scsi_cmd[8] = args[1];
198 scsi_cmd[10] = 0x4f;
199 scsi_cmd[12] = 0xc2;
200 } else {
201 scsi_cmd[6] = args[1];
203 scsi_cmd[14] = args[0];
205 /* Good values for timeout and retries? Values below
206 from scsi_ioctl_send_command() for default case... */
207 if (scsi_execute_req(scsidev, scsi_cmd, data_dir, argbuf, argsize,
208 &sshdr, (10*HZ), 5)) {
209 rc = -EIO;
210 goto error;
213 /* Need code to retrieve data from check condition? */
215 if ((argbuf)
216 && copy_to_user(arg + sizeof(args), argbuf, argsize))
217 rc = -EFAULT;
218 error:
219 if (argbuf)
220 kfree(argbuf);
222 return rc;
226 * ata_task_ioctl - Handler for HDIO_DRIVE_TASK ioctl
227 * @scsidev: Device to which we are issuing command
228 * @arg: User provided data for issuing command
230 * LOCKING:
231 * Defined by the SCSI layer. We don't really care.
233 * RETURNS:
234 * Zero on success, negative errno on error.
236 int ata_task_ioctl(struct scsi_device *scsidev, void __user *arg)
238 int rc = 0;
239 u8 scsi_cmd[MAX_COMMAND_SIZE];
240 u8 args[7];
241 struct scsi_sense_hdr sshdr;
243 if (arg == NULL)
244 return -EINVAL;
246 if (copy_from_user(args, arg, sizeof(args)))
247 return -EFAULT;
249 memset(scsi_cmd, 0, sizeof(scsi_cmd));
250 scsi_cmd[0] = ATA_16;
251 scsi_cmd[1] = (3 << 1); /* Non-data */
252 /* scsi_cmd[2] is already 0 -- no off.line, cc, or data xfer */
253 scsi_cmd[4] = args[1];
254 scsi_cmd[6] = args[2];
255 scsi_cmd[8] = args[3];
256 scsi_cmd[10] = args[4];
257 scsi_cmd[12] = args[5];
258 scsi_cmd[14] = args[0];
260 /* Good values for timeout and retries? Values below
261 from scsi_ioctl_send_command() for default case... */
262 if (scsi_execute_req(scsidev, scsi_cmd, DMA_NONE, NULL, 0, &sshdr,
263 (10*HZ), 5))
264 rc = -EIO;
266 /* Need code to retrieve data from check condition? */
267 return rc;
270 int ata_scsi_ioctl(struct scsi_device *scsidev, int cmd, void __user *arg)
272 int val = -EINVAL, rc = -EINVAL;
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 return rc;
306 * ata_scsi_qc_new - acquire new ata_queued_cmd reference
307 * @ap: ATA port to which the new command is attached
308 * @dev: ATA device to which the new command is attached
309 * @cmd: SCSI command that originated this ATA command
310 * @done: SCSI command completion function
312 * Obtain a reference to an unused ata_queued_cmd structure,
313 * which is the basic libata structure representing a single
314 * ATA command sent to the hardware.
316 * If a command was available, fill in the SCSI-specific
317 * portions of the structure with information on the
318 * current command.
320 * LOCKING:
321 * spin_lock_irqsave(host_set lock)
323 * RETURNS:
324 * Command allocated, or %NULL if none available.
326 struct ata_queued_cmd *ata_scsi_qc_new(struct ata_port *ap,
327 struct ata_device *dev,
328 struct scsi_cmnd *cmd,
329 void (*done)(struct scsi_cmnd *))
331 struct ata_queued_cmd *qc;
333 qc = ata_qc_new_init(ap, dev);
334 if (qc) {
335 qc->scsicmd = cmd;
336 qc->scsidone = done;
338 if (cmd->use_sg) {
339 qc->__sg = (struct scatterlist *) cmd->request_buffer;
340 qc->n_elem = cmd->use_sg;
341 } else {
342 qc->__sg = &qc->sgent;
343 qc->n_elem = 1;
345 } else {
346 cmd->result = (DID_OK << 16) | (QUEUE_FULL << 1);
347 done(cmd);
350 return qc;
354 * ata_dump_status - user friendly display of error info
355 * @id: id of the port in question
356 * @tf: ptr to filled out taskfile
358 * Decode and dump the ATA error/status registers for the user so
359 * that they have some idea what really happened at the non
360 * make-believe layer.
362 * LOCKING:
363 * inherited from caller
365 void ata_dump_status(unsigned id, struct ata_taskfile *tf)
367 u8 stat = tf->command, err = tf->feature;
369 printk(KERN_WARNING "ata%u: status=0x%02x { ", id, stat);
370 if (stat & ATA_BUSY) {
371 printk("Busy }\n"); /* Data is not valid in this case */
372 } else {
373 if (stat & 0x40) printk("DriveReady ");
374 if (stat & 0x20) printk("DeviceFault ");
375 if (stat & 0x10) printk("SeekComplete ");
376 if (stat & 0x08) printk("DataRequest ");
377 if (stat & 0x04) printk("CorrectedError ");
378 if (stat & 0x02) printk("Index ");
379 if (stat & 0x01) printk("Error ");
380 printk("}\n");
382 if (err) {
383 printk(KERN_WARNING "ata%u: error=0x%02x { ", id, err);
384 if (err & 0x04) printk("DriveStatusError ");
385 if (err & 0x80) {
386 if (err & 0x04) printk("BadCRC ");
387 else printk("Sector ");
389 if (err & 0x40) printk("UncorrectableError ");
390 if (err & 0x10) printk("SectorIdNotFound ");
391 if (err & 0x02) printk("TrackZeroNotFound ");
392 if (err & 0x01) printk("AddrMarkNotFound ");
393 printk("}\n");
398 int ata_scsi_device_resume(struct scsi_device *sdev)
400 struct ata_port *ap = (struct ata_port *) &sdev->host->hostdata[0];
401 struct ata_device *dev = &ap->device[sdev->id];
403 return ata_device_resume(ap, dev);
406 int ata_scsi_device_suspend(struct scsi_device *sdev, pm_message_t state)
408 struct ata_port *ap = (struct ata_port *) &sdev->host->hostdata[0];
409 struct ata_device *dev = &ap->device[sdev->id];
411 return ata_device_suspend(ap, dev, state);
415 * ata_to_sense_error - convert ATA error to SCSI error
416 * @id: ATA device number
417 * @drv_stat: value contained in ATA status register
418 * @drv_err: value contained in ATA error register
419 * @sk: the sense key we'll fill out
420 * @asc: the additional sense code we'll fill out
421 * @ascq: the additional sense code qualifier we'll fill out
423 * Converts an ATA error into a SCSI error. Fill out pointers to
424 * SK, ASC, and ASCQ bytes for later use in fixed or descriptor
425 * format sense blocks.
427 * LOCKING:
428 * spin_lock_irqsave(host_set lock)
430 void ata_to_sense_error(unsigned id, u8 drv_stat, u8 drv_err, u8 *sk, u8 *asc,
431 u8 *ascq)
433 int i;
435 /* Based on the 3ware driver translation table */
436 static const unsigned char sense_table[][4] = {
437 /* BBD|ECC|ID|MAR */
438 {0xd1, ABORTED_COMMAND, 0x00, 0x00}, // Device busy Aborted command
439 /* BBD|ECC|ID */
440 {0xd0, ABORTED_COMMAND, 0x00, 0x00}, // Device busy Aborted command
441 /* ECC|MC|MARK */
442 {0x61, HARDWARE_ERROR, 0x00, 0x00}, // Device fault Hardware error
443 /* ICRC|ABRT */ /* NB: ICRC & !ABRT is BBD */
444 {0x84, ABORTED_COMMAND, 0x47, 0x00}, // Data CRC error SCSI parity error
445 /* MC|ID|ABRT|TRK0|MARK */
446 {0x37, NOT_READY, 0x04, 0x00}, // Unit offline Not ready
447 /* MCR|MARK */
448 {0x09, NOT_READY, 0x04, 0x00}, // Unrecovered disk error Not ready
449 /* Bad address mark */
450 {0x01, MEDIUM_ERROR, 0x13, 0x00}, // Address mark not found Address mark not found for data field
451 /* TRK0 */
452 {0x02, HARDWARE_ERROR, 0x00, 0x00}, // Track 0 not found Hardware error
453 /* Abort & !ICRC */
454 {0x04, ABORTED_COMMAND, 0x00, 0x00}, // Aborted command Aborted command
455 /* Media change request */
456 {0x08, NOT_READY, 0x04, 0x00}, // Media change request FIXME: faking offline
457 /* SRV */
458 {0x10, ABORTED_COMMAND, 0x14, 0x00}, // ID not found Recorded entity not found
459 /* Media change */
460 {0x08, NOT_READY, 0x04, 0x00}, // Media change FIXME: faking offline
461 /* ECC */
462 {0x40, MEDIUM_ERROR, 0x11, 0x04}, // Uncorrectable ECC error Unrecovered read error
463 /* BBD - block marked bad */
464 {0x80, MEDIUM_ERROR, 0x11, 0x04}, // Block marked bad Medium error, unrecovered read error
465 {0xFF, 0xFF, 0xFF, 0xFF}, // END mark
467 static const unsigned char stat_table[][4] = {
468 /* Must be first because BUSY means no other bits valid */
469 {0x80, ABORTED_COMMAND, 0x47, 0x00}, // Busy, fake parity for now
470 {0x20, HARDWARE_ERROR, 0x00, 0x00}, // Device fault
471 {0x08, ABORTED_COMMAND, 0x47, 0x00}, // Timed out in xfer, fake parity for now
472 {0x04, RECOVERED_ERROR, 0x11, 0x00}, // Recovered ECC error Medium error, recovered
473 {0xFF, 0xFF, 0xFF, 0xFF}, // END mark
477 * Is this an error we can process/parse
479 if (drv_stat & ATA_BUSY) {
480 drv_err = 0; /* Ignore the err bits, they're invalid */
483 if (drv_err) {
484 /* Look for drv_err */
485 for (i = 0; sense_table[i][0] != 0xFF; i++) {
486 /* Look for best matches first */
487 if ((sense_table[i][0] & drv_err) ==
488 sense_table[i][0]) {
489 *sk = sense_table[i][1];
490 *asc = sense_table[i][2];
491 *ascq = sense_table[i][3];
492 goto translate_done;
495 /* No immediate match */
496 printk(KERN_WARNING "ata%u: no sense translation for "
497 "error 0x%02x\n", id, drv_err);
500 /* Fall back to interpreting status bits */
501 for (i = 0; stat_table[i][0] != 0xFF; i++) {
502 if (stat_table[i][0] & drv_stat) {
503 *sk = stat_table[i][1];
504 *asc = stat_table[i][2];
505 *ascq = stat_table[i][3];
506 goto translate_done;
509 /* No error? Undecoded? */
510 printk(KERN_WARNING "ata%u: no sense translation for status: 0x%02x\n",
511 id, drv_stat);
513 /* We need a sensible error return here, which is tricky, and one
514 that won't cause people to do things like return a disk wrongly */
515 *sk = ABORTED_COMMAND;
516 *asc = 0x00;
517 *ascq = 0x00;
519 translate_done:
520 printk(KERN_ERR "ata%u: translated ATA stat/err 0x%02x/%02x to "
521 "SCSI SK/ASC/ASCQ 0x%x/%02x/%02x\n", id, drv_stat, drv_err,
522 *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->tf;
543 unsigned char *sb = cmd->sense_buffer;
544 unsigned char *desc = sb + 8;
546 memset(sb, 0, SCSI_SENSE_BUFFERSIZE);
548 cmd->result = (DRIVER_SENSE << 24) | SAM_STAT_CHECK_CONDITION;
551 * Read the controller registers.
553 WARN_ON(qc->ap->ops->tf_read == NULL);
554 qc->ap->ops->tf_read(qc->ap, tf);
557 * Use ata_to_sense_error() to map status register bits
558 * onto sense key, asc & ascq.
560 if (tf->command & (ATA_BUSY | ATA_DF | ATA_ERR | ATA_DRQ)) {
561 ata_to_sense_error(qc->ap->id, tf->command, tf->feature,
562 &sb[1], &sb[2], &sb[3]);
563 sb[1] &= 0x0f;
567 * Sense data is current and format is descriptor.
569 sb[0] = 0x72;
571 desc[0] = 0x09;
574 * Set length of additional sense data.
575 * Since we only populate descriptor 0, the total
576 * length is the same (fixed) length as descriptor 0.
578 desc[1] = sb[7] = 14;
581 * Copy registers into sense buffer.
583 desc[2] = 0x00;
584 desc[3] = tf->feature; /* == error reg */
585 desc[5] = tf->nsect;
586 desc[7] = tf->lbal;
587 desc[9] = tf->lbam;
588 desc[11] = tf->lbah;
589 desc[12] = tf->device;
590 desc[13] = tf->command; /* == status reg */
593 * Fill in Extend bit, and the high order bytes
594 * if applicable.
596 if (tf->flags & ATA_TFLAG_LBA48) {
597 desc[2] |= 0x01;
598 desc[4] = tf->hob_nsect;
599 desc[6] = tf->hob_lbal;
600 desc[8] = tf->hob_lbam;
601 desc[10] = tf->hob_lbah;
606 * ata_gen_fixed_sense - generate a SCSI fixed sense block
607 * @qc: Command that we are erroring out
609 * Leverage ata_to_sense_error() to give us the codes. Fit our
610 * LBA in here if there's room.
612 * LOCKING:
613 * inherited from caller
615 void ata_gen_fixed_sense(struct ata_queued_cmd *qc)
617 struct scsi_cmnd *cmd = qc->scsicmd;
618 struct ata_taskfile *tf = &qc->tf;
619 unsigned char *sb = cmd->sense_buffer;
621 memset(sb, 0, SCSI_SENSE_BUFFERSIZE);
623 cmd->result = (DRIVER_SENSE << 24) | SAM_STAT_CHECK_CONDITION;
626 * Read the controller registers.
628 WARN_ON(qc->ap->ops->tf_read == NULL);
629 qc->ap->ops->tf_read(qc->ap, tf);
632 * Use ata_to_sense_error() to map status register bits
633 * onto sense key, asc & ascq.
635 if (tf->command & (ATA_BUSY | ATA_DF | ATA_ERR | ATA_DRQ)) {
636 ata_to_sense_error(qc->ap->id, tf->command, tf->feature,
637 &sb[2], &sb[12], &sb[13]);
638 sb[2] &= 0x0f;
641 sb[0] = 0x70;
642 sb[7] = 0x0a;
644 if (tf->flags & ATA_TFLAG_LBA48) {
645 /* TODO: find solution for LBA48 descriptors */
648 else if (tf->flags & ATA_TFLAG_LBA) {
649 /* A small (28b) LBA will fit in the 32b info field */
650 sb[0] |= 0x80; /* set valid bit */
651 sb[3] = tf->device & 0x0f;
652 sb[4] = tf->lbah;
653 sb[5] = tf->lbam;
654 sb[6] = tf->lbal;
657 else {
658 /* TODO: C/H/S */
662 static void ata_scsi_sdev_config(struct scsi_device *sdev)
664 sdev->use_10_for_rw = 1;
665 sdev->use_10_for_ms = 1;
668 static void ata_scsi_dev_config(struct scsi_device *sdev,
669 struct ata_device *dev)
671 unsigned int max_sectors;
673 /* TODO: 2048 is an arbitrary number, not the
674 * hardware maximum. This should be increased to
675 * 65534 when Jens Axboe's patch for dynamically
676 * determining max_sectors is merged.
678 max_sectors = ATA_MAX_SECTORS;
679 if (dev->flags & ATA_DFLAG_LBA48)
680 max_sectors = 2048;
681 if (dev->max_sectors)
682 max_sectors = dev->max_sectors;
684 blk_queue_max_sectors(sdev->request_queue, max_sectors);
687 * SATA DMA transfers must be multiples of 4 byte, so
688 * we need to pad ATAPI transfers using an extra sg.
689 * Decrement max hw segments accordingly.
691 if (dev->class == ATA_DEV_ATAPI) {
692 request_queue_t *q = sdev->request_queue;
693 blk_queue_max_hw_segments(q, q->max_hw_segments - 1);
698 * ata_scsi_slave_config - Set SCSI device attributes
699 * @sdev: SCSI device to examine
701 * This is called before we actually start reading
702 * and writing to the device, to configure certain
703 * SCSI mid-layer behaviors.
705 * LOCKING:
706 * Defined by SCSI layer. We don't really care.
709 int ata_scsi_slave_config(struct scsi_device *sdev)
711 ata_scsi_sdev_config(sdev);
713 blk_queue_max_phys_segments(sdev->request_queue, LIBATA_MAX_PRD);
715 if (sdev->id < ATA_MAX_DEVICES) {
716 struct ata_port *ap;
717 struct ata_device *dev;
719 ap = (struct ata_port *) &sdev->host->hostdata[0];
720 dev = &ap->device[sdev->id];
722 ata_scsi_dev_config(sdev, dev);
725 return 0; /* scsi layer doesn't check return value, sigh */
729 * ata_scsi_timed_out - SCSI layer time out callback
730 * @cmd: timed out SCSI command
732 * Handles SCSI layer timeout. We race with normal completion of
733 * the qc for @cmd. If the qc is already gone, we lose and let
734 * the scsi command finish (EH_HANDLED). Otherwise, the qc has
735 * timed out and EH should be invoked. Prevent ata_qc_complete()
736 * from finishing it by setting EH_SCHEDULED and return
737 * EH_NOT_HANDLED.
739 * LOCKING:
740 * Called from timer context
742 * RETURNS:
743 * EH_HANDLED or EH_NOT_HANDLED
745 enum scsi_eh_timer_return ata_scsi_timed_out(struct scsi_cmnd *cmd)
747 struct Scsi_Host *host = cmd->device->host;
748 struct ata_port *ap = (struct ata_port *) &host->hostdata[0];
749 unsigned long flags;
750 struct ata_queued_cmd *qc;
751 enum scsi_eh_timer_return ret = EH_HANDLED;
753 DPRINTK("ENTER\n");
755 spin_lock_irqsave(&ap->host_set->lock, flags);
756 qc = ata_qc_from_tag(ap, ap->active_tag);
757 if (qc) {
758 WARN_ON(qc->scsicmd != cmd);
759 qc->flags |= ATA_QCFLAG_EH_SCHEDULED;
760 qc->err_mask |= AC_ERR_TIMEOUT;
761 ret = EH_NOT_HANDLED;
763 spin_unlock_irqrestore(&ap->host_set->lock, flags);
765 DPRINTK("EXIT, ret=%d\n", ret);
766 return ret;
770 * ata_scsi_error - SCSI layer error handler callback
771 * @host: SCSI host on which error occurred
773 * Handles SCSI-layer-thrown error events.
775 * LOCKING:
776 * Inherited from SCSI layer (none, can sleep)
779 static void ata_scsi_error(struct Scsi_Host *host)
781 struct ata_port *ap;
782 unsigned long flags;
784 DPRINTK("ENTER\n");
786 ap = (struct ata_port *) &host->hostdata[0];
788 spin_lock_irqsave(&ap->host_set->lock, flags);
789 WARN_ON(ap->flags & ATA_FLAG_IN_EH);
790 ap->flags |= ATA_FLAG_IN_EH;
791 WARN_ON(ata_qc_from_tag(ap, ap->active_tag) == NULL);
792 spin_unlock_irqrestore(&ap->host_set->lock, flags);
794 ata_port_flush_task(ap);
796 ap->ops->eng_timeout(ap);
798 WARN_ON(host->host_failed || !list_empty(&host->eh_cmd_q));
800 scsi_eh_flush_done_q(&ap->eh_done_q);
802 spin_lock_irqsave(&ap->host_set->lock, flags);
803 ap->flags &= ~ATA_FLAG_IN_EH;
804 spin_unlock_irqrestore(&ap->host_set->lock, flags);
806 DPRINTK("EXIT\n");
809 static void ata_eh_scsidone(struct scsi_cmnd *scmd)
811 /* nada */
814 static void __ata_eh_qc_complete(struct ata_queued_cmd *qc)
816 struct ata_port *ap = qc->ap;
817 struct scsi_cmnd *scmd = qc->scsicmd;
818 unsigned long flags;
820 spin_lock_irqsave(&ap->host_set->lock, flags);
821 qc->scsidone = ata_eh_scsidone;
822 __ata_qc_complete(qc);
823 WARN_ON(ata_tag_valid(qc->tag));
824 spin_unlock_irqrestore(&ap->host_set->lock, flags);
826 scsi_eh_finish_cmd(scmd, &ap->eh_done_q);
830 * ata_eh_qc_complete - Complete an active ATA command from EH
831 * @qc: Command to complete
833 * Indicate to the mid and upper layers that an ATA command has
834 * completed. To be used from EH.
836 void ata_eh_qc_complete(struct ata_queued_cmd *qc)
838 struct scsi_cmnd *scmd = qc->scsicmd;
839 scmd->retries = scmd->allowed;
840 __ata_eh_qc_complete(qc);
844 * ata_eh_qc_retry - Tell midlayer to retry an ATA command after EH
845 * @qc: Command to retry
847 * Indicate to the mid and upper layers that an ATA command
848 * should be retried. To be used from EH.
850 * SCSI midlayer limits the number of retries to scmd->allowed.
851 * This function might need to adjust scmd->retries for commands
852 * which get retried due to unrelated NCQ failures.
854 void ata_eh_qc_retry(struct ata_queued_cmd *qc)
856 __ata_eh_qc_complete(qc);
860 * ata_scsi_start_stop_xlat - Translate SCSI START STOP UNIT command
861 * @qc: Storage for translated ATA taskfile
862 * @scsicmd: SCSI command to translate
864 * Sets up an ATA taskfile to issue STANDBY (to stop) or READ VERIFY
865 * (to start). Perhaps these commands should be preceded by
866 * CHECK POWER MODE to see what power mode the device is already in.
867 * [See SAT revision 5 at www.t10.org]
869 * LOCKING:
870 * spin_lock_irqsave(host_set lock)
872 * RETURNS:
873 * Zero on success, non-zero on error.
876 static unsigned int ata_scsi_start_stop_xlat(struct ata_queued_cmd *qc,
877 const u8 *scsicmd)
879 struct ata_taskfile *tf = &qc->tf;
881 tf->flags |= ATA_TFLAG_DEVICE | ATA_TFLAG_ISADDR;
882 tf->protocol = ATA_PROT_NODATA;
883 if (scsicmd[1] & 0x1) {
884 ; /* ignore IMMED bit, violates sat-r05 */
886 if (scsicmd[4] & 0x2)
887 goto invalid_fld; /* LOEJ bit set not supported */
888 if (((scsicmd[4] >> 4) & 0xf) != 0)
889 goto invalid_fld; /* power conditions not supported */
890 if (scsicmd[4] & 0x1) {
891 tf->nsect = 1; /* 1 sector, lba=0 */
893 if (qc->dev->flags & ATA_DFLAG_LBA) {
894 qc->tf.flags |= ATA_TFLAG_LBA;
896 tf->lbah = 0x0;
897 tf->lbam = 0x0;
898 tf->lbal = 0x0;
899 tf->device |= ATA_LBA;
900 } else {
901 /* CHS */
902 tf->lbal = 0x1; /* sect */
903 tf->lbam = 0x0; /* cyl low */
904 tf->lbah = 0x0; /* cyl high */
907 tf->command = ATA_CMD_VERIFY; /* READ VERIFY */
908 } else {
909 tf->nsect = 0; /* time period value (0 implies now) */
910 tf->command = ATA_CMD_STANDBY;
911 /* Consider: ATA STANDBY IMMEDIATE command */
914 * Standby and Idle condition timers could be implemented but that
915 * would require libata to implement the Power condition mode page
916 * and allow the user to change it. Changing mode pages requires
917 * MODE SELECT to be implemented.
920 return 0;
922 invalid_fld:
923 ata_scsi_set_sense(qc->scsicmd, ILLEGAL_REQUEST, 0x24, 0x0);
924 /* "Invalid field in cbd" */
925 return 1;
930 * ata_scsi_flush_xlat - Translate SCSI SYNCHRONIZE CACHE command
931 * @qc: Storage for translated ATA taskfile
932 * @scsicmd: SCSI command to translate (ignored)
934 * Sets up an ATA taskfile to issue FLUSH CACHE or
935 * FLUSH CACHE EXT.
937 * LOCKING:
938 * spin_lock_irqsave(host_set lock)
940 * RETURNS:
941 * Zero on success, non-zero on error.
944 static unsigned int ata_scsi_flush_xlat(struct ata_queued_cmd *qc, const u8 *scsicmd)
946 struct ata_taskfile *tf = &qc->tf;
948 tf->flags |= ATA_TFLAG_DEVICE;
949 tf->protocol = ATA_PROT_NODATA;
951 if ((qc->dev->flags & ATA_DFLAG_LBA48) &&
952 (ata_id_has_flush_ext(qc->dev->id)))
953 tf->command = ATA_CMD_FLUSH_EXT;
954 else
955 tf->command = ATA_CMD_FLUSH;
957 return 0;
961 * scsi_6_lba_len - Get LBA and transfer length
962 * @scsicmd: SCSI command to translate
964 * Calculate LBA and transfer length for 6-byte commands.
966 * RETURNS:
967 * @plba: the LBA
968 * @plen: the transfer length
971 static void scsi_6_lba_len(const u8 *scsicmd, u64 *plba, u32 *plen)
973 u64 lba = 0;
974 u32 len = 0;
976 VPRINTK("six-byte command\n");
978 lba |= ((u64)scsicmd[2]) << 8;
979 lba |= ((u64)scsicmd[3]);
981 len |= ((u32)scsicmd[4]);
983 *plba = lba;
984 *plen = len;
988 * scsi_10_lba_len - Get LBA and transfer length
989 * @scsicmd: SCSI command to translate
991 * Calculate LBA and transfer length for 10-byte commands.
993 * RETURNS:
994 * @plba: the LBA
995 * @plen: the transfer length
998 static void scsi_10_lba_len(const u8 *scsicmd, u64 *plba, u32 *plen)
1000 u64 lba = 0;
1001 u32 len = 0;
1003 VPRINTK("ten-byte command\n");
1005 lba |= ((u64)scsicmd[2]) << 24;
1006 lba |= ((u64)scsicmd[3]) << 16;
1007 lba |= ((u64)scsicmd[4]) << 8;
1008 lba |= ((u64)scsicmd[5]);
1010 len |= ((u32)scsicmd[7]) << 8;
1011 len |= ((u32)scsicmd[8]);
1013 *plba = lba;
1014 *plen = len;
1018 * scsi_16_lba_len - Get LBA and transfer length
1019 * @scsicmd: SCSI command to translate
1021 * Calculate LBA and transfer length for 16-byte commands.
1023 * RETURNS:
1024 * @plba: the LBA
1025 * @plen: the transfer length
1028 static void scsi_16_lba_len(const u8 *scsicmd, u64 *plba, u32 *plen)
1030 u64 lba = 0;
1031 u32 len = 0;
1033 VPRINTK("sixteen-byte command\n");
1035 lba |= ((u64)scsicmd[2]) << 56;
1036 lba |= ((u64)scsicmd[3]) << 48;
1037 lba |= ((u64)scsicmd[4]) << 40;
1038 lba |= ((u64)scsicmd[5]) << 32;
1039 lba |= ((u64)scsicmd[6]) << 24;
1040 lba |= ((u64)scsicmd[7]) << 16;
1041 lba |= ((u64)scsicmd[8]) << 8;
1042 lba |= ((u64)scsicmd[9]);
1044 len |= ((u32)scsicmd[10]) << 24;
1045 len |= ((u32)scsicmd[11]) << 16;
1046 len |= ((u32)scsicmd[12]) << 8;
1047 len |= ((u32)scsicmd[13]);
1049 *plba = lba;
1050 *plen = len;
1054 * ata_scsi_verify_xlat - Translate SCSI VERIFY command into an ATA one
1055 * @qc: Storage for translated ATA taskfile
1056 * @scsicmd: SCSI command to translate
1058 * Converts SCSI VERIFY command to an ATA READ VERIFY command.
1060 * LOCKING:
1061 * spin_lock_irqsave(host_set lock)
1063 * RETURNS:
1064 * Zero on success, non-zero on error.
1067 static unsigned int ata_scsi_verify_xlat(struct ata_queued_cmd *qc, const u8 *scsicmd)
1069 struct ata_taskfile *tf = &qc->tf;
1070 struct ata_device *dev = qc->dev;
1071 u64 dev_sectors = qc->dev->n_sectors;
1072 u64 block;
1073 u32 n_block;
1075 tf->flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
1076 tf->protocol = ATA_PROT_NODATA;
1078 if (scsicmd[0] == VERIFY)
1079 scsi_10_lba_len(scsicmd, &block, &n_block);
1080 else if (scsicmd[0] == VERIFY_16)
1081 scsi_16_lba_len(scsicmd, &block, &n_block);
1082 else
1083 goto invalid_fld;
1085 if (!n_block)
1086 goto nothing_to_do;
1087 if (block >= dev_sectors)
1088 goto out_of_range;
1089 if ((block + n_block) > dev_sectors)
1090 goto out_of_range;
1092 if (dev->flags & ATA_DFLAG_LBA) {
1093 tf->flags |= ATA_TFLAG_LBA;
1095 if (lba_28_ok(block, n_block)) {
1096 /* use LBA28 */
1097 tf->command = ATA_CMD_VERIFY;
1098 tf->device |= (block >> 24) & 0xf;
1099 } else if (lba_48_ok(block, n_block)) {
1100 if (!(dev->flags & ATA_DFLAG_LBA48))
1101 goto out_of_range;
1103 /* use LBA48 */
1104 tf->flags |= ATA_TFLAG_LBA48;
1105 tf->command = ATA_CMD_VERIFY_EXT;
1107 tf->hob_nsect = (n_block >> 8) & 0xff;
1109 tf->hob_lbah = (block >> 40) & 0xff;
1110 tf->hob_lbam = (block >> 32) & 0xff;
1111 tf->hob_lbal = (block >> 24) & 0xff;
1112 } else
1113 /* request too large even for LBA48 */
1114 goto out_of_range;
1116 tf->nsect = n_block & 0xff;
1118 tf->lbah = (block >> 16) & 0xff;
1119 tf->lbam = (block >> 8) & 0xff;
1120 tf->lbal = block & 0xff;
1122 tf->device |= ATA_LBA;
1123 } else {
1124 /* CHS */
1125 u32 sect, head, cyl, track;
1127 if (!lba_28_ok(block, n_block))
1128 goto out_of_range;
1130 /* Convert LBA to CHS */
1131 track = (u32)block / dev->sectors;
1132 cyl = track / dev->heads;
1133 head = track % dev->heads;
1134 sect = (u32)block % dev->sectors + 1;
1136 DPRINTK("block %u track %u cyl %u head %u sect %u\n",
1137 (u32)block, track, cyl, head, sect);
1139 /* Check whether the converted CHS can fit.
1140 Cylinder: 0-65535
1141 Head: 0-15
1142 Sector: 1-255*/
1143 if ((cyl >> 16) || (head >> 4) || (sect >> 8) || (!sect))
1144 goto out_of_range;
1146 tf->command = ATA_CMD_VERIFY;
1147 tf->nsect = n_block & 0xff; /* Sector count 0 means 256 sectors */
1148 tf->lbal = sect;
1149 tf->lbam = cyl;
1150 tf->lbah = cyl >> 8;
1151 tf->device |= head;
1154 return 0;
1156 invalid_fld:
1157 ata_scsi_set_sense(qc->scsicmd, ILLEGAL_REQUEST, 0x24, 0x0);
1158 /* "Invalid field in cbd" */
1159 return 1;
1161 out_of_range:
1162 ata_scsi_set_sense(qc->scsicmd, ILLEGAL_REQUEST, 0x21, 0x0);
1163 /* "Logical Block Address out of range" */
1164 return 1;
1166 nothing_to_do:
1167 qc->scsicmd->result = SAM_STAT_GOOD;
1168 return 1;
1172 * ata_scsi_rw_xlat - Translate SCSI r/w command into an ATA one
1173 * @qc: Storage for translated ATA taskfile
1174 * @scsicmd: SCSI command to translate
1176 * Converts any of six SCSI read/write commands into the
1177 * ATA counterpart, including starting sector (LBA),
1178 * sector count, and taking into account the device's LBA48
1179 * support.
1181 * Commands %READ_6, %READ_10, %READ_16, %WRITE_6, %WRITE_10, and
1182 * %WRITE_16 are currently supported.
1184 * LOCKING:
1185 * spin_lock_irqsave(host_set lock)
1187 * RETURNS:
1188 * Zero on success, non-zero on error.
1191 static unsigned int ata_scsi_rw_xlat(struct ata_queued_cmd *qc, const u8 *scsicmd)
1193 struct ata_taskfile *tf = &qc->tf;
1194 struct ata_device *dev = qc->dev;
1195 u64 block;
1196 u32 n_block;
1198 tf->flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
1200 if (scsicmd[0] == WRITE_10 || scsicmd[0] == WRITE_6 ||
1201 scsicmd[0] == WRITE_16)
1202 tf->flags |= ATA_TFLAG_WRITE;
1204 /* Calculate the SCSI LBA, transfer length and FUA. */
1205 switch (scsicmd[0]) {
1206 case READ_10:
1207 case WRITE_10:
1208 scsi_10_lba_len(scsicmd, &block, &n_block);
1209 if (unlikely(scsicmd[1] & (1 << 3)))
1210 tf->flags |= ATA_TFLAG_FUA;
1211 break;
1212 case READ_6:
1213 case WRITE_6:
1214 scsi_6_lba_len(scsicmd, &block, &n_block);
1216 /* for 6-byte r/w commands, transfer length 0
1217 * means 256 blocks of data, not 0 block.
1219 if (!n_block)
1220 n_block = 256;
1221 break;
1222 case READ_16:
1223 case WRITE_16:
1224 scsi_16_lba_len(scsicmd, &block, &n_block);
1225 if (unlikely(scsicmd[1] & (1 << 3)))
1226 tf->flags |= ATA_TFLAG_FUA;
1227 break;
1228 default:
1229 DPRINTK("no-byte command\n");
1230 goto invalid_fld;
1233 /* Check and compose ATA command */
1234 if (!n_block)
1235 /* For 10-byte and 16-byte SCSI R/W commands, transfer
1236 * length 0 means transfer 0 block of data.
1237 * However, for ATA R/W commands, sector count 0 means
1238 * 256 or 65536 sectors, not 0 sectors as in SCSI.
1240 * WARNING: one or two older ATA drives treat 0 as 0...
1242 goto nothing_to_do;
1244 if (dev->flags & ATA_DFLAG_LBA) {
1245 tf->flags |= ATA_TFLAG_LBA;
1247 if (lba_28_ok(block, n_block)) {
1248 /* use LBA28 */
1249 tf->device |= (block >> 24) & 0xf;
1250 } else if (lba_48_ok(block, n_block)) {
1251 if (!(dev->flags & ATA_DFLAG_LBA48))
1252 goto out_of_range;
1254 /* use LBA48 */
1255 tf->flags |= ATA_TFLAG_LBA48;
1257 tf->hob_nsect = (n_block >> 8) & 0xff;
1259 tf->hob_lbah = (block >> 40) & 0xff;
1260 tf->hob_lbam = (block >> 32) & 0xff;
1261 tf->hob_lbal = (block >> 24) & 0xff;
1262 } else
1263 /* request too large even for LBA48 */
1264 goto out_of_range;
1266 if (unlikely(ata_rwcmd_protocol(qc) < 0))
1267 goto invalid_fld;
1269 qc->nsect = n_block;
1270 tf->nsect = n_block & 0xff;
1272 tf->lbah = (block >> 16) & 0xff;
1273 tf->lbam = (block >> 8) & 0xff;
1274 tf->lbal = block & 0xff;
1276 tf->device |= ATA_LBA;
1277 } else {
1278 /* CHS */
1279 u32 sect, head, cyl, track;
1281 /* The request -may- be too large for CHS addressing. */
1282 if (!lba_28_ok(block, n_block))
1283 goto out_of_range;
1285 if (unlikely(ata_rwcmd_protocol(qc) < 0))
1286 goto invalid_fld;
1288 /* Convert LBA to CHS */
1289 track = (u32)block / dev->sectors;
1290 cyl = track / dev->heads;
1291 head = track % dev->heads;
1292 sect = (u32)block % dev->sectors + 1;
1294 DPRINTK("block %u track %u cyl %u head %u sect %u\n",
1295 (u32)block, track, cyl, head, sect);
1297 /* Check whether the converted CHS can fit.
1298 Cylinder: 0-65535
1299 Head: 0-15
1300 Sector: 1-255*/
1301 if ((cyl >> 16) || (head >> 4) || (sect >> 8) || (!sect))
1302 goto out_of_range;
1304 qc->nsect = n_block;
1305 tf->nsect = n_block & 0xff; /* Sector count 0 means 256 sectors */
1306 tf->lbal = sect;
1307 tf->lbam = cyl;
1308 tf->lbah = cyl >> 8;
1309 tf->device |= head;
1312 return 0;
1314 invalid_fld:
1315 ata_scsi_set_sense(qc->scsicmd, ILLEGAL_REQUEST, 0x24, 0x0);
1316 /* "Invalid field in cbd" */
1317 return 1;
1319 out_of_range:
1320 ata_scsi_set_sense(qc->scsicmd, ILLEGAL_REQUEST, 0x21, 0x0);
1321 /* "Logical Block Address out of range" */
1322 return 1;
1324 nothing_to_do:
1325 qc->scsicmd->result = SAM_STAT_GOOD;
1326 return 1;
1329 static void ata_scsi_qc_complete(struct ata_queued_cmd *qc)
1331 struct scsi_cmnd *cmd = qc->scsicmd;
1332 u8 *cdb = cmd->cmnd;
1333 int need_sense = (qc->err_mask != 0);
1335 /* For ATA pass thru (SAT) commands, generate a sense block if
1336 * user mandated it or if there's an error. Note that if we
1337 * generate because the user forced us to, a check condition
1338 * is generated and the ATA register values are returned
1339 * whether the command completed successfully or not. If there
1340 * was no error, SK, ASC and ASCQ will all be zero.
1342 if (((cdb[0] == ATA_16) || (cdb[0] == ATA_12)) &&
1343 ((cdb[2] & 0x20) || need_sense)) {
1344 ata_gen_ata_desc_sense(qc);
1345 } else {
1346 if (!need_sense) {
1347 cmd->result = SAM_STAT_GOOD;
1348 } else {
1349 /* TODO: decide which descriptor format to use
1350 * for 48b LBA devices and call that here
1351 * instead of the fixed desc, which is only
1352 * good for smaller LBA (and maybe CHS?)
1353 * devices.
1355 ata_gen_fixed_sense(qc);
1359 if (need_sense) {
1360 /* The ata_gen_..._sense routines fill in tf */
1361 ata_dump_status(qc->ap->id, &qc->tf);
1364 qc->scsidone(cmd);
1366 ata_qc_free(qc);
1370 * ata_scsi_translate - Translate then issue SCSI command to ATA device
1371 * @ap: ATA port to which the command is addressed
1372 * @dev: ATA device to which the command is addressed
1373 * @cmd: SCSI command to execute
1374 * @done: SCSI command completion function
1375 * @xlat_func: Actor which translates @cmd to an ATA taskfile
1377 * Our ->queuecommand() function has decided that the SCSI
1378 * command issued can be directly translated into an ATA
1379 * command, rather than handled internally.
1381 * This function sets up an ata_queued_cmd structure for the
1382 * SCSI command, and sends that ata_queued_cmd to the hardware.
1384 * The xlat_func argument (actor) returns 0 if ready to execute
1385 * ATA command, else 1 to finish translation. If 1 is returned
1386 * then cmd->result (and possibly cmd->sense_buffer) are assumed
1387 * to be set reflecting an error condition or clean (early)
1388 * termination.
1390 * LOCKING:
1391 * spin_lock_irqsave(host_set lock)
1394 static void ata_scsi_translate(struct ata_port *ap, struct ata_device *dev,
1395 struct scsi_cmnd *cmd,
1396 void (*done)(struct scsi_cmnd *),
1397 ata_xlat_func_t xlat_func)
1399 struct ata_queued_cmd *qc;
1400 u8 *scsicmd = cmd->cmnd;
1402 VPRINTK("ENTER\n");
1404 qc = ata_scsi_qc_new(ap, dev, cmd, done);
1405 if (!qc)
1406 goto err_mem;
1408 /* data is present; dma-map it */
1409 if (cmd->sc_data_direction == DMA_FROM_DEVICE ||
1410 cmd->sc_data_direction == DMA_TO_DEVICE) {
1411 if (unlikely(cmd->request_bufflen < 1)) {
1412 printk(KERN_WARNING "ata%u(%u): WARNING: zero len r/w req\n",
1413 ap->id, dev->devno);
1414 goto err_did;
1417 if (cmd->use_sg)
1418 ata_sg_init(qc, cmd->request_buffer, cmd->use_sg);
1419 else
1420 ata_sg_init_one(qc, cmd->request_buffer,
1421 cmd->request_bufflen);
1423 qc->dma_dir = cmd->sc_data_direction;
1426 qc->complete_fn = ata_scsi_qc_complete;
1428 if (xlat_func(qc, scsicmd))
1429 goto early_finish;
1431 /* select device, send command to hardware */
1432 ata_qc_issue(qc);
1434 VPRINTK("EXIT\n");
1435 return;
1437 early_finish:
1438 ata_qc_free(qc);
1439 done(cmd);
1440 DPRINTK("EXIT - early finish (good or error)\n");
1441 return;
1443 err_did:
1444 ata_qc_free(qc);
1445 err_mem:
1446 cmd->result = (DID_ERROR << 16);
1447 done(cmd);
1448 DPRINTK("EXIT - internal\n");
1449 return;
1453 * ata_scsi_rbuf_get - Map response buffer.
1454 * @cmd: SCSI command containing buffer to be mapped.
1455 * @buf_out: Pointer to mapped area.
1457 * Maps buffer contained within SCSI command @cmd.
1459 * LOCKING:
1460 * spin_lock_irqsave(host_set lock)
1462 * RETURNS:
1463 * Length of response buffer.
1466 static unsigned int ata_scsi_rbuf_get(struct scsi_cmnd *cmd, u8 **buf_out)
1468 u8 *buf;
1469 unsigned int buflen;
1471 if (cmd->use_sg) {
1472 struct scatterlist *sg;
1474 sg = (struct scatterlist *) cmd->request_buffer;
1475 buf = kmap_atomic(sg->page, KM_USER0) + sg->offset;
1476 buflen = sg->length;
1477 } else {
1478 buf = cmd->request_buffer;
1479 buflen = cmd->request_bufflen;
1482 *buf_out = buf;
1483 return buflen;
1487 * ata_scsi_rbuf_put - Unmap response buffer.
1488 * @cmd: SCSI command containing buffer to be unmapped.
1489 * @buf: buffer to unmap
1491 * Unmaps response buffer contained within @cmd.
1493 * LOCKING:
1494 * spin_lock_irqsave(host_set lock)
1497 static inline void ata_scsi_rbuf_put(struct scsi_cmnd *cmd, u8 *buf)
1499 if (cmd->use_sg) {
1500 struct scatterlist *sg;
1502 sg = (struct scatterlist *) cmd->request_buffer;
1503 kunmap_atomic(buf - sg->offset, KM_USER0);
1508 * ata_scsi_rbuf_fill - wrapper for SCSI command simulators
1509 * @args: device IDENTIFY data / SCSI command of interest.
1510 * @actor: Callback hook for desired SCSI command simulator
1512 * Takes care of the hard work of simulating a SCSI command...
1513 * Mapping the response buffer, calling the command's handler,
1514 * and handling the handler's return value. This return value
1515 * indicates whether the handler wishes the SCSI command to be
1516 * completed successfully (0), or not (in which case cmd->result
1517 * and sense buffer are assumed to be set).
1519 * LOCKING:
1520 * spin_lock_irqsave(host_set lock)
1523 void ata_scsi_rbuf_fill(struct ata_scsi_args *args,
1524 unsigned int (*actor) (struct ata_scsi_args *args,
1525 u8 *rbuf, unsigned int buflen))
1527 u8 *rbuf;
1528 unsigned int buflen, rc;
1529 struct scsi_cmnd *cmd = args->cmd;
1531 buflen = ata_scsi_rbuf_get(cmd, &rbuf);
1532 memset(rbuf, 0, buflen);
1533 rc = actor(args, rbuf, buflen);
1534 ata_scsi_rbuf_put(cmd, rbuf);
1536 if (rc == 0)
1537 cmd->result = SAM_STAT_GOOD;
1538 args->done(cmd);
1542 * ata_scsiop_inq_std - Simulate INQUIRY command
1543 * @args: device IDENTIFY data / SCSI command of interest.
1544 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1545 * @buflen: Response buffer length.
1547 * Returns standard device identification data associated
1548 * with non-VPD INQUIRY command output.
1550 * LOCKING:
1551 * spin_lock_irqsave(host_set lock)
1554 unsigned int ata_scsiop_inq_std(struct ata_scsi_args *args, u8 *rbuf,
1555 unsigned int buflen)
1557 u8 hdr[] = {
1558 TYPE_DISK,
1560 0x5, /* claim SPC-3 version compatibility */
1562 95 - 4
1565 /* set scsi removeable (RMB) bit per ata bit */
1566 if (ata_id_removeable(args->id))
1567 hdr[1] |= (1 << 7);
1569 VPRINTK("ENTER\n");
1571 memcpy(rbuf, hdr, sizeof(hdr));
1573 if (buflen > 35) {
1574 memcpy(&rbuf[8], "ATA ", 8);
1575 ata_id_string(args->id, &rbuf[16], ATA_ID_PROD_OFS, 16);
1576 ata_id_string(args->id, &rbuf[32], ATA_ID_FW_REV_OFS, 4);
1577 if (rbuf[32] == 0 || rbuf[32] == ' ')
1578 memcpy(&rbuf[32], "n/a ", 4);
1581 if (buflen > 63) {
1582 const u8 versions[] = {
1583 0x60, /* SAM-3 (no version claimed) */
1585 0x03,
1586 0x20, /* SBC-2 (no version claimed) */
1588 0x02,
1589 0x60 /* SPC-3 (no version claimed) */
1592 memcpy(rbuf + 59, versions, sizeof(versions));
1595 return 0;
1599 * ata_scsiop_inq_00 - Simulate INQUIRY VPD page 0, list of pages
1600 * @args: device IDENTIFY data / SCSI command of interest.
1601 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1602 * @buflen: Response buffer length.
1604 * Returns list of inquiry VPD pages available.
1606 * LOCKING:
1607 * spin_lock_irqsave(host_set lock)
1610 unsigned int ata_scsiop_inq_00(struct ata_scsi_args *args, u8 *rbuf,
1611 unsigned int buflen)
1613 const u8 pages[] = {
1614 0x00, /* page 0x00, this page */
1615 0x80, /* page 0x80, unit serial no page */
1616 0x83 /* page 0x83, device ident page */
1618 rbuf[3] = sizeof(pages); /* number of supported VPD pages */
1620 if (buflen > 6)
1621 memcpy(rbuf + 4, pages, sizeof(pages));
1623 return 0;
1627 * ata_scsiop_inq_80 - Simulate INQUIRY VPD page 80, device serial number
1628 * @args: device IDENTIFY data / SCSI command of interest.
1629 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1630 * @buflen: Response buffer length.
1632 * Returns ATA device serial number.
1634 * LOCKING:
1635 * spin_lock_irqsave(host_set lock)
1638 unsigned int ata_scsiop_inq_80(struct ata_scsi_args *args, u8 *rbuf,
1639 unsigned int buflen)
1641 const u8 hdr[] = {
1643 0x80, /* this page code */
1645 ATA_SERNO_LEN, /* page len */
1647 memcpy(rbuf, hdr, sizeof(hdr));
1649 if (buflen > (ATA_SERNO_LEN + 4 - 1))
1650 ata_id_string(args->id, (unsigned char *) &rbuf[4],
1651 ATA_ID_SERNO_OFS, ATA_SERNO_LEN);
1653 return 0;
1657 * ata_scsiop_inq_83 - Simulate INQUIRY VPD page 83, device identity
1658 * @args: device IDENTIFY data / SCSI command of interest.
1659 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1660 * @buflen: Response buffer length.
1662 * Yields two logical unit device identification designators:
1663 * - vendor specific ASCII containing the ATA serial number
1664 * - SAT defined "t10 vendor id based" containing ASCII vendor
1665 * name ("ATA "), model and serial numbers.
1667 * LOCKING:
1668 * spin_lock_irqsave(host_set lock)
1671 unsigned int ata_scsiop_inq_83(struct ata_scsi_args *args, u8 *rbuf,
1672 unsigned int buflen)
1674 int num;
1675 const int sat_model_serial_desc_len = 68;
1676 const int ata_model_byte_len = 40;
1678 rbuf[1] = 0x83; /* this page code */
1679 num = 4;
1681 if (buflen > (ATA_SERNO_LEN + num + 3)) {
1682 /* piv=0, assoc=lu, code_set=ACSII, designator=vendor */
1683 rbuf[num + 0] = 2;
1684 rbuf[num + 3] = ATA_SERNO_LEN;
1685 num += 4;
1686 ata_id_string(args->id, (unsigned char *) rbuf + num,
1687 ATA_ID_SERNO_OFS, ATA_SERNO_LEN);
1688 num += ATA_SERNO_LEN;
1690 if (buflen > (sat_model_serial_desc_len + num + 3)) {
1691 /* SAT defined lu model and serial numbers descriptor */
1692 /* piv=0, assoc=lu, code_set=ACSII, designator=t10 vendor id */
1693 rbuf[num + 0] = 2;
1694 rbuf[num + 1] = 1;
1695 rbuf[num + 3] = sat_model_serial_desc_len;
1696 num += 4;
1697 memcpy(rbuf + num, "ATA ", 8);
1698 num += 8;
1699 ata_id_string(args->id, (unsigned char *) rbuf + num,
1700 ATA_ID_PROD_OFS, ata_model_byte_len);
1701 num += ata_model_byte_len;
1702 ata_id_string(args->id, (unsigned char *) rbuf + num,
1703 ATA_ID_SERNO_OFS, ATA_SERNO_LEN);
1704 num += ATA_SERNO_LEN;
1706 rbuf[3] = num - 4; /* page len (assume less than 256 bytes) */
1707 return 0;
1711 * ata_scsiop_noop - Command handler that simply returns success.
1712 * @args: device IDENTIFY data / SCSI command of interest.
1713 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1714 * @buflen: Response buffer length.
1716 * No operation. Simply returns success to caller, to indicate
1717 * that the caller should successfully complete this SCSI command.
1719 * LOCKING:
1720 * spin_lock_irqsave(host_set lock)
1723 unsigned int ata_scsiop_noop(struct ata_scsi_args *args, u8 *rbuf,
1724 unsigned int buflen)
1726 VPRINTK("ENTER\n");
1727 return 0;
1731 * ata_msense_push - Push data onto MODE SENSE data output buffer
1732 * @ptr_io: (input/output) Location to store more output data
1733 * @last: End of output data buffer
1734 * @buf: Pointer to BLOB being added to output buffer
1735 * @buflen: Length of BLOB
1737 * Store MODE SENSE data on an output buffer.
1739 * LOCKING:
1740 * None.
1743 static void ata_msense_push(u8 **ptr_io, const u8 *last,
1744 const u8 *buf, unsigned int buflen)
1746 u8 *ptr = *ptr_io;
1748 if ((ptr + buflen - 1) > last)
1749 return;
1751 memcpy(ptr, buf, buflen);
1753 ptr += buflen;
1755 *ptr_io = ptr;
1759 * ata_msense_caching - Simulate MODE SENSE caching info page
1760 * @id: device IDENTIFY data
1761 * @ptr_io: (input/output) Location to store more output data
1762 * @last: End of output data buffer
1764 * Generate a caching info page, which conditionally indicates
1765 * write caching to the SCSI layer, depending on device
1766 * capabilities.
1768 * LOCKING:
1769 * None.
1772 static unsigned int ata_msense_caching(u16 *id, u8 **ptr_io,
1773 const u8 *last)
1775 u8 page[CACHE_MPAGE_LEN];
1777 memcpy(page, def_cache_mpage, sizeof(page));
1778 if (ata_id_wcache_enabled(id))
1779 page[2] |= (1 << 2); /* write cache enable */
1780 if (!ata_id_rahead_enabled(id))
1781 page[12] |= (1 << 5); /* disable read ahead */
1783 ata_msense_push(ptr_io, last, page, sizeof(page));
1784 return sizeof(page);
1788 * ata_msense_ctl_mode - Simulate MODE SENSE control mode page
1789 * @dev: Device associated with this MODE SENSE command
1790 * @ptr_io: (input/output) Location to store more output data
1791 * @last: End of output data buffer
1793 * Generate a generic MODE SENSE control mode page.
1795 * LOCKING:
1796 * None.
1799 static unsigned int ata_msense_ctl_mode(u8 **ptr_io, const u8 *last)
1801 ata_msense_push(ptr_io, last, def_control_mpage,
1802 sizeof(def_control_mpage));
1803 return sizeof(def_control_mpage);
1807 * ata_msense_rw_recovery - Simulate MODE SENSE r/w error recovery page
1808 * @dev: Device associated with this MODE SENSE command
1809 * @ptr_io: (input/output) Location to store more output data
1810 * @last: End of output data buffer
1812 * Generate a generic MODE SENSE r/w error recovery page.
1814 * LOCKING:
1815 * None.
1818 static unsigned int ata_msense_rw_recovery(u8 **ptr_io, const u8 *last)
1821 ata_msense_push(ptr_io, last, def_rw_recovery_mpage,
1822 sizeof(def_rw_recovery_mpage));
1823 return sizeof(def_rw_recovery_mpage);
1827 * We can turn this into a real blacklist if it's needed, for now just
1828 * blacklist any Maxtor BANC1G10 revision firmware
1830 static int ata_dev_supports_fua(u16 *id)
1832 unsigned char model[41], fw[9];
1834 if (!libata_fua)
1835 return 0;
1836 if (!ata_id_has_fua(id))
1837 return 0;
1839 ata_id_c_string(id, model, ATA_ID_PROD_OFS, sizeof(model));
1840 ata_id_c_string(id, fw, ATA_ID_FW_REV_OFS, sizeof(fw));
1842 if (strcmp(model, "Maxtor"))
1843 return 1;
1844 if (strcmp(fw, "BANC1G10"))
1845 return 1;
1847 return 0; /* blacklisted */
1851 * ata_scsiop_mode_sense - Simulate MODE SENSE 6, 10 commands
1852 * @args: device IDENTIFY data / SCSI command of interest.
1853 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1854 * @buflen: Response buffer length.
1856 * Simulate MODE SENSE commands. Assume this is invoked for direct
1857 * access devices (e.g. disks) only. There should be no block
1858 * descriptor for other device types.
1860 * LOCKING:
1861 * spin_lock_irqsave(host_set lock)
1864 unsigned int ata_scsiop_mode_sense(struct ata_scsi_args *args, u8 *rbuf,
1865 unsigned int buflen)
1867 struct ata_device *dev = args->dev;
1868 u8 *scsicmd = args->cmd->cmnd, *p, *last;
1869 const u8 sat_blk_desc[] = {
1870 0, 0, 0, 0, /* number of blocks: sat unspecified */
1872 0, 0x2, 0x0 /* block length: 512 bytes */
1874 u8 pg, spg;
1875 unsigned int ebd, page_control, six_byte, output_len, alloc_len, minlen;
1876 u8 dpofua;
1878 VPRINTK("ENTER\n");
1880 six_byte = (scsicmd[0] == MODE_SENSE);
1881 ebd = !(scsicmd[1] & 0x8); /* dbd bit inverted == edb */
1883 * LLBA bit in msense(10) ignored (compliant)
1886 page_control = scsicmd[2] >> 6;
1887 switch (page_control) {
1888 case 0: /* current */
1889 break; /* supported */
1890 case 3: /* saved */
1891 goto saving_not_supp;
1892 case 1: /* changeable */
1893 case 2: /* defaults */
1894 default:
1895 goto invalid_fld;
1898 if (six_byte) {
1899 output_len = 4 + (ebd ? 8 : 0);
1900 alloc_len = scsicmd[4];
1901 } else {
1902 output_len = 8 + (ebd ? 8 : 0);
1903 alloc_len = (scsicmd[7] << 8) + scsicmd[8];
1905 minlen = (alloc_len < buflen) ? alloc_len : buflen;
1907 p = rbuf + output_len;
1908 last = rbuf + minlen - 1;
1910 pg = scsicmd[2] & 0x3f;
1911 spg = scsicmd[3];
1913 * No mode subpages supported (yet) but asking for _all_
1914 * subpages may be valid
1916 if (spg && (spg != ALL_SUB_MPAGES))
1917 goto invalid_fld;
1919 switch(pg) {
1920 case RW_RECOVERY_MPAGE:
1921 output_len += ata_msense_rw_recovery(&p, last);
1922 break;
1924 case CACHE_MPAGE:
1925 output_len += ata_msense_caching(args->id, &p, last);
1926 break;
1928 case CONTROL_MPAGE: {
1929 output_len += ata_msense_ctl_mode(&p, last);
1930 break;
1933 case ALL_MPAGES:
1934 output_len += ata_msense_rw_recovery(&p, last);
1935 output_len += ata_msense_caching(args->id, &p, last);
1936 output_len += ata_msense_ctl_mode(&p, last);
1937 break;
1939 default: /* invalid page code */
1940 goto invalid_fld;
1943 if (minlen < 1)
1944 return 0;
1946 dpofua = 0;
1947 if (ata_dev_supports_fua(args->id) && dev->flags & ATA_DFLAG_LBA48 &&
1948 (!(dev->flags & ATA_DFLAG_PIO) || dev->multi_count))
1949 dpofua = 1 << 4;
1951 if (six_byte) {
1952 output_len--;
1953 rbuf[0] = output_len;
1954 if (minlen > 2)
1955 rbuf[2] |= dpofua;
1956 if (ebd) {
1957 if (minlen > 3)
1958 rbuf[3] = sizeof(sat_blk_desc);
1959 if (minlen > 11)
1960 memcpy(rbuf + 4, sat_blk_desc,
1961 sizeof(sat_blk_desc));
1963 } else {
1964 output_len -= 2;
1965 rbuf[0] = output_len >> 8;
1966 if (minlen > 1)
1967 rbuf[1] = output_len;
1968 if (minlen > 3)
1969 rbuf[3] |= dpofua;
1970 if (ebd) {
1971 if (minlen > 7)
1972 rbuf[7] = sizeof(sat_blk_desc);
1973 if (minlen > 15)
1974 memcpy(rbuf + 8, sat_blk_desc,
1975 sizeof(sat_blk_desc));
1978 return 0;
1980 invalid_fld:
1981 ata_scsi_set_sense(args->cmd, ILLEGAL_REQUEST, 0x24, 0x0);
1982 /* "Invalid field in cbd" */
1983 return 1;
1985 saving_not_supp:
1986 ata_scsi_set_sense(args->cmd, ILLEGAL_REQUEST, 0x39, 0x0);
1987 /* "Saving parameters not supported" */
1988 return 1;
1992 * ata_scsiop_read_cap - Simulate READ CAPACITY[ 16] commands
1993 * @args: device IDENTIFY data / SCSI command of interest.
1994 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1995 * @buflen: Response buffer length.
1997 * Simulate READ CAPACITY commands.
1999 * LOCKING:
2000 * spin_lock_irqsave(host_set lock)
2003 unsigned int ata_scsiop_read_cap(struct ata_scsi_args *args, u8 *rbuf,
2004 unsigned int buflen)
2006 u64 n_sectors;
2007 u32 tmp;
2009 VPRINTK("ENTER\n");
2011 if (ata_id_has_lba(args->id)) {
2012 if (ata_id_has_lba48(args->id))
2013 n_sectors = ata_id_u64(args->id, 100);
2014 else
2015 n_sectors = ata_id_u32(args->id, 60);
2016 } else {
2017 /* CHS default translation */
2018 n_sectors = args->id[1] * args->id[3] * args->id[6];
2020 if (ata_id_current_chs_valid(args->id))
2021 /* CHS current translation */
2022 n_sectors = ata_id_u32(args->id, 57);
2025 n_sectors--; /* ATA TotalUserSectors - 1 */
2027 if (args->cmd->cmnd[0] == READ_CAPACITY) {
2028 if( n_sectors >= 0xffffffffULL )
2029 tmp = 0xffffffff ; /* Return max count on overflow */
2030 else
2031 tmp = n_sectors ;
2033 /* sector count, 32-bit */
2034 rbuf[0] = tmp >> (8 * 3);
2035 rbuf[1] = tmp >> (8 * 2);
2036 rbuf[2] = tmp >> (8 * 1);
2037 rbuf[3] = tmp;
2039 /* sector size */
2040 tmp = ATA_SECT_SIZE;
2041 rbuf[6] = tmp >> 8;
2042 rbuf[7] = tmp;
2044 } else {
2045 /* sector count, 64-bit */
2046 tmp = n_sectors >> (8 * 4);
2047 rbuf[2] = tmp >> (8 * 3);
2048 rbuf[3] = tmp >> (8 * 2);
2049 rbuf[4] = tmp >> (8 * 1);
2050 rbuf[5] = tmp;
2051 tmp = n_sectors;
2052 rbuf[6] = tmp >> (8 * 3);
2053 rbuf[7] = tmp >> (8 * 2);
2054 rbuf[8] = tmp >> (8 * 1);
2055 rbuf[9] = tmp;
2057 /* sector size */
2058 tmp = ATA_SECT_SIZE;
2059 rbuf[12] = tmp >> 8;
2060 rbuf[13] = tmp;
2063 return 0;
2067 * ata_scsiop_report_luns - Simulate REPORT LUNS command
2068 * @args: device IDENTIFY data / SCSI command of interest.
2069 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2070 * @buflen: Response buffer length.
2072 * Simulate REPORT LUNS command.
2074 * LOCKING:
2075 * spin_lock_irqsave(host_set lock)
2078 unsigned int ata_scsiop_report_luns(struct ata_scsi_args *args, u8 *rbuf,
2079 unsigned int buflen)
2081 VPRINTK("ENTER\n");
2082 rbuf[3] = 8; /* just one lun, LUN 0, size 8 bytes */
2084 return 0;
2088 * ata_scsi_set_sense - Set SCSI sense data and status
2089 * @cmd: SCSI request to be handled
2090 * @sk: SCSI-defined sense key
2091 * @asc: SCSI-defined additional sense code
2092 * @ascq: SCSI-defined additional sense code qualifier
2094 * Helper function that builds a valid fixed format, current
2095 * response code and the given sense key (sk), additional sense
2096 * code (asc) and additional sense code qualifier (ascq) with
2097 * a SCSI command status of %SAM_STAT_CHECK_CONDITION and
2098 * DRIVER_SENSE set in the upper bits of scsi_cmnd::result .
2100 * LOCKING:
2101 * Not required
2104 void ata_scsi_set_sense(struct scsi_cmnd *cmd, u8 sk, u8 asc, u8 ascq)
2106 cmd->result = (DRIVER_SENSE << 24) | SAM_STAT_CHECK_CONDITION;
2108 cmd->sense_buffer[0] = 0x70; /* fixed format, current */
2109 cmd->sense_buffer[2] = sk;
2110 cmd->sense_buffer[7] = 18 - 8; /* additional sense length */
2111 cmd->sense_buffer[12] = asc;
2112 cmd->sense_buffer[13] = ascq;
2116 * ata_scsi_badcmd - End a SCSI request with an error
2117 * @cmd: SCSI request to be handled
2118 * @done: SCSI command completion function
2119 * @asc: SCSI-defined additional sense code
2120 * @ascq: SCSI-defined additional sense code qualifier
2122 * Helper function that completes a SCSI command with
2123 * %SAM_STAT_CHECK_CONDITION, with a sense key %ILLEGAL_REQUEST
2124 * and the specified additional sense codes.
2126 * LOCKING:
2127 * spin_lock_irqsave(host_set lock)
2130 void ata_scsi_badcmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *), u8 asc, u8 ascq)
2132 DPRINTK("ENTER\n");
2133 ata_scsi_set_sense(cmd, ILLEGAL_REQUEST, asc, ascq);
2135 done(cmd);
2138 static void atapi_sense_complete(struct ata_queued_cmd *qc)
2140 if (qc->err_mask && ((qc->err_mask & AC_ERR_DEV) == 0))
2141 /* FIXME: not quite right; we don't want the
2142 * translation of taskfile registers into
2143 * a sense descriptors, since that's only
2144 * correct for ATA, not ATAPI
2146 ata_gen_ata_desc_sense(qc);
2148 qc->scsidone(qc->scsicmd);
2149 ata_qc_free(qc);
2152 /* is it pointless to prefer PIO for "safety reasons"? */
2153 static inline int ata_pio_use_silly(struct ata_port *ap)
2155 return (ap->flags & ATA_FLAG_PIO_DMA);
2158 static void atapi_request_sense(struct ata_queued_cmd *qc)
2160 struct ata_port *ap = qc->ap;
2161 struct scsi_cmnd *cmd = qc->scsicmd;
2163 DPRINTK("ATAPI request sense\n");
2165 /* FIXME: is this needed? */
2166 memset(cmd->sense_buffer, 0, sizeof(cmd->sense_buffer));
2168 ap->ops->tf_read(ap, &qc->tf);
2170 /* fill these in, for the case where they are -not- overwritten */
2171 cmd->sense_buffer[0] = 0x70;
2172 cmd->sense_buffer[2] = qc->tf.feature >> 4;
2174 ata_qc_reinit(qc);
2176 ata_sg_init_one(qc, cmd->sense_buffer, sizeof(cmd->sense_buffer));
2177 qc->dma_dir = DMA_FROM_DEVICE;
2179 memset(&qc->cdb, 0, qc->dev->cdb_len);
2180 qc->cdb[0] = REQUEST_SENSE;
2181 qc->cdb[4] = SCSI_SENSE_BUFFERSIZE;
2183 qc->tf.flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
2184 qc->tf.command = ATA_CMD_PACKET;
2186 if (ata_pio_use_silly(ap)) {
2187 qc->tf.protocol = ATA_PROT_ATAPI_DMA;
2188 qc->tf.feature |= ATAPI_PKT_DMA;
2189 } else {
2190 qc->tf.protocol = ATA_PROT_ATAPI;
2191 qc->tf.lbam = (8 * 1024) & 0xff;
2192 qc->tf.lbah = (8 * 1024) >> 8;
2194 qc->nbytes = SCSI_SENSE_BUFFERSIZE;
2196 qc->complete_fn = atapi_sense_complete;
2198 ata_qc_issue(qc);
2200 DPRINTK("EXIT\n");
2203 static void atapi_qc_complete(struct ata_queued_cmd *qc)
2205 struct scsi_cmnd *cmd = qc->scsicmd;
2206 unsigned int err_mask = qc->err_mask;
2208 VPRINTK("ENTER, err_mask 0x%X\n", err_mask);
2210 if (unlikely(err_mask & AC_ERR_DEV)) {
2211 cmd->result = SAM_STAT_CHECK_CONDITION;
2212 atapi_request_sense(qc);
2213 return;
2216 else if (unlikely(err_mask))
2217 /* FIXME: not quite right; we don't want the
2218 * translation of taskfile registers into
2219 * a sense descriptors, since that's only
2220 * correct for ATA, not ATAPI
2222 ata_gen_ata_desc_sense(qc);
2224 else {
2225 u8 *scsicmd = cmd->cmnd;
2227 if ((scsicmd[0] == INQUIRY) && ((scsicmd[1] & 0x03) == 0)) {
2228 u8 *buf = NULL;
2229 unsigned int buflen;
2231 buflen = ata_scsi_rbuf_get(cmd, &buf);
2233 /* ATAPI devices typically report zero for their SCSI version,
2234 * and sometimes deviate from the spec WRT response data
2235 * format. If SCSI version is reported as zero like normal,
2236 * then we make the following fixups: 1) Fake MMC-5 version,
2237 * to indicate to the Linux scsi midlayer this is a modern
2238 * device. 2) Ensure response data format / ATAPI information
2239 * are always correct.
2241 if (buf[2] == 0) {
2242 buf[2] = 0x5;
2243 buf[3] = 0x32;
2246 ata_scsi_rbuf_put(cmd, buf);
2249 cmd->result = SAM_STAT_GOOD;
2252 qc->scsidone(cmd);
2253 ata_qc_free(qc);
2256 * atapi_xlat - Initialize PACKET taskfile
2257 * @qc: command structure to be initialized
2258 * @scsicmd: SCSI CDB associated with this PACKET command
2260 * LOCKING:
2261 * spin_lock_irqsave(host_set lock)
2263 * RETURNS:
2264 * Zero on success, non-zero on failure.
2267 static unsigned int atapi_xlat(struct ata_queued_cmd *qc, const u8 *scsicmd)
2269 struct scsi_cmnd *cmd = qc->scsicmd;
2270 struct ata_device *dev = qc->dev;
2271 int using_pio = (dev->flags & ATA_DFLAG_PIO);
2272 int nodata = (cmd->sc_data_direction == DMA_NONE);
2274 if (!using_pio)
2275 /* Check whether ATAPI DMA is safe */
2276 if (ata_check_atapi_dma(qc))
2277 using_pio = 1;
2279 memcpy(&qc->cdb, scsicmd, dev->cdb_len);
2281 qc->complete_fn = atapi_qc_complete;
2283 qc->tf.flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
2284 if (cmd->sc_data_direction == DMA_TO_DEVICE) {
2285 qc->tf.flags |= ATA_TFLAG_WRITE;
2286 DPRINTK("direction: write\n");
2289 qc->tf.command = ATA_CMD_PACKET;
2291 /* no data, or PIO data xfer */
2292 if (using_pio || nodata) {
2293 if (nodata)
2294 qc->tf.protocol = ATA_PROT_ATAPI_NODATA;
2295 else
2296 qc->tf.protocol = ATA_PROT_ATAPI;
2297 qc->tf.lbam = (8 * 1024) & 0xff;
2298 qc->tf.lbah = (8 * 1024) >> 8;
2301 /* DMA data xfer */
2302 else {
2303 qc->tf.protocol = ATA_PROT_ATAPI_DMA;
2304 qc->tf.feature |= ATAPI_PKT_DMA;
2306 #ifdef ATAPI_ENABLE_DMADIR
2307 /* some SATA bridges need us to indicate data xfer direction */
2308 if (cmd->sc_data_direction != DMA_TO_DEVICE)
2309 qc->tf.feature |= ATAPI_DMADIR;
2310 #endif
2313 qc->nbytes = cmd->request_bufflen;
2315 return 0;
2319 * ata_scsi_find_dev - lookup ata_device from scsi_cmnd
2320 * @ap: ATA port to which the device is attached
2321 * @scsidev: SCSI device from which we derive the ATA device
2323 * Given various information provided in struct scsi_cmnd,
2324 * map that onto an ATA bus, and using that mapping
2325 * determine which ata_device is associated with the
2326 * SCSI command to be sent.
2328 * LOCKING:
2329 * spin_lock_irqsave(host_set lock)
2331 * RETURNS:
2332 * Associated ATA device, or %NULL if not found.
2335 static struct ata_device *
2336 ata_scsi_find_dev(struct ata_port *ap, const struct scsi_device *scsidev)
2338 struct ata_device *dev;
2340 /* skip commands not addressed to targets we simulate */
2341 if (likely(scsidev->id < ATA_MAX_DEVICES))
2342 dev = &ap->device[scsidev->id];
2343 else
2344 return NULL;
2346 if (unlikely((scsidev->channel != 0) ||
2347 (scsidev->lun != 0)))
2348 return NULL;
2350 if (unlikely(!ata_dev_present(dev)))
2351 return NULL;
2353 if (!atapi_enabled || (ap->flags & ATA_FLAG_NO_ATAPI)) {
2354 if (unlikely(dev->class == ATA_DEV_ATAPI)) {
2355 printk(KERN_WARNING "ata%u(%u): WARNING: ATAPI is %s, device ignored.\n",
2356 ap->id, dev->devno, atapi_enabled ? "not supported with this driver" : "disabled");
2357 return NULL;
2361 return dev;
2365 * ata_scsi_map_proto - Map pass-thru protocol value to taskfile value.
2366 * @byte1: Byte 1 from pass-thru CDB.
2368 * RETURNS:
2369 * ATA_PROT_UNKNOWN if mapping failed/unimplemented, protocol otherwise.
2371 static u8
2372 ata_scsi_map_proto(u8 byte1)
2374 switch((byte1 & 0x1e) >> 1) {
2375 case 3: /* Non-data */
2376 return ATA_PROT_NODATA;
2378 case 6: /* DMA */
2379 return ATA_PROT_DMA;
2381 case 4: /* PIO Data-in */
2382 case 5: /* PIO Data-out */
2383 return ATA_PROT_PIO;
2385 case 10: /* Device Reset */
2386 case 0: /* Hard Reset */
2387 case 1: /* SRST */
2388 case 2: /* Bus Idle */
2389 case 7: /* Packet */
2390 case 8: /* DMA Queued */
2391 case 9: /* Device Diagnostic */
2392 case 11: /* UDMA Data-in */
2393 case 12: /* UDMA Data-Out */
2394 case 13: /* FPDMA */
2395 default: /* Reserved */
2396 break;
2399 return ATA_PROT_UNKNOWN;
2403 * ata_scsi_pass_thru - convert ATA pass-thru CDB to taskfile
2404 * @qc: command structure to be initialized
2405 * @scsicmd: SCSI command to convert
2407 * Handles either 12 or 16-byte versions of the CDB.
2409 * RETURNS:
2410 * Zero on success, non-zero on failure.
2412 static unsigned int
2413 ata_scsi_pass_thru(struct ata_queued_cmd *qc, const u8 *scsicmd)
2415 struct ata_taskfile *tf = &(qc->tf);
2416 struct scsi_cmnd *cmd = qc->scsicmd;
2418 if ((tf->protocol = ata_scsi_map_proto(scsicmd[1])) == ATA_PROT_UNKNOWN)
2419 goto invalid_fld;
2421 if (scsicmd[1] & 0xe0)
2422 /* PIO multi not supported yet */
2423 goto invalid_fld;
2426 * 12 and 16 byte CDBs use different offsets to
2427 * provide the various register values.
2429 if (scsicmd[0] == ATA_16) {
2431 * 16-byte CDB - may contain extended commands.
2433 * If that is the case, copy the upper byte register values.
2435 if (scsicmd[1] & 0x01) {
2436 tf->hob_feature = scsicmd[3];
2437 tf->hob_nsect = scsicmd[5];
2438 tf->hob_lbal = scsicmd[7];
2439 tf->hob_lbam = scsicmd[9];
2440 tf->hob_lbah = scsicmd[11];
2441 tf->flags |= ATA_TFLAG_LBA48;
2442 } else
2443 tf->flags &= ~ATA_TFLAG_LBA48;
2446 * Always copy low byte, device and command registers.
2448 tf->feature = scsicmd[4];
2449 tf->nsect = scsicmd[6];
2450 tf->lbal = scsicmd[8];
2451 tf->lbam = scsicmd[10];
2452 tf->lbah = scsicmd[12];
2453 tf->device = scsicmd[13];
2454 tf->command = scsicmd[14];
2455 } else {
2457 * 12-byte CDB - incapable of extended commands.
2459 tf->flags &= ~ATA_TFLAG_LBA48;
2461 tf->feature = scsicmd[3];
2462 tf->nsect = scsicmd[4];
2463 tf->lbal = scsicmd[5];
2464 tf->lbam = scsicmd[6];
2465 tf->lbah = scsicmd[7];
2466 tf->device = scsicmd[8];
2467 tf->command = scsicmd[9];
2470 * If slave is possible, enforce correct master/slave bit
2472 if (qc->ap->flags & ATA_FLAG_SLAVE_POSS)
2473 tf->device = qc->dev->devno ?
2474 tf->device | ATA_DEV1 : tf->device & ~ATA_DEV1;
2477 * Filter SET_FEATURES - XFER MODE command -- otherwise,
2478 * SET_FEATURES - XFER MODE must be preceded/succeeded
2479 * by an update to hardware-specific registers for each
2480 * controller (i.e. the reason for ->set_piomode(),
2481 * ->set_dmamode(), and ->post_set_mode() hooks).
2483 if ((tf->command == ATA_CMD_SET_FEATURES)
2484 && (tf->feature == SETFEATURES_XFER))
2485 goto invalid_fld;
2488 * Set flags so that all registers will be written,
2489 * and pass on write indication (used for PIO/DMA
2490 * setup.)
2492 tf->flags |= (ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE);
2494 if (cmd->sc_data_direction == DMA_TO_DEVICE)
2495 tf->flags |= ATA_TFLAG_WRITE;
2498 * Set transfer length.
2500 * TODO: find out if we need to do more here to
2501 * cover scatter/gather case.
2503 qc->nsect = cmd->request_bufflen / ATA_SECT_SIZE;
2505 return 0;
2507 invalid_fld:
2508 ata_scsi_set_sense(qc->scsicmd, ILLEGAL_REQUEST, 0x24, 0x00);
2509 /* "Invalid field in cdb" */
2510 return 1;
2514 * ata_get_xlat_func - check if SCSI to ATA translation is possible
2515 * @dev: ATA device
2516 * @cmd: SCSI command opcode to consider
2518 * Look up the SCSI command given, and determine whether the
2519 * SCSI command is to be translated or simulated.
2521 * RETURNS:
2522 * Pointer to translation function if possible, %NULL if not.
2525 static inline ata_xlat_func_t ata_get_xlat_func(struct ata_device *dev, u8 cmd)
2527 switch (cmd) {
2528 case READ_6:
2529 case READ_10:
2530 case READ_16:
2532 case WRITE_6:
2533 case WRITE_10:
2534 case WRITE_16:
2535 return ata_scsi_rw_xlat;
2537 case SYNCHRONIZE_CACHE:
2538 if (ata_try_flush_cache(dev))
2539 return ata_scsi_flush_xlat;
2540 break;
2542 case VERIFY:
2543 case VERIFY_16:
2544 return ata_scsi_verify_xlat;
2546 case ATA_12:
2547 case ATA_16:
2548 return ata_scsi_pass_thru;
2550 case START_STOP:
2551 return ata_scsi_start_stop_xlat;
2554 return NULL;
2558 * ata_scsi_dump_cdb - dump SCSI command contents to dmesg
2559 * @ap: ATA port to which the command was being sent
2560 * @cmd: SCSI command to dump
2562 * Prints the contents of a SCSI command via printk().
2565 static inline void ata_scsi_dump_cdb(struct ata_port *ap,
2566 struct scsi_cmnd *cmd)
2568 #ifdef ATA_DEBUG
2569 struct scsi_device *scsidev = cmd->device;
2570 u8 *scsicmd = cmd->cmnd;
2572 DPRINTK("CDB (%u:%d,%d,%d) %02x %02x %02x %02x %02x %02x %02x %02x %02x\n",
2573 ap->id,
2574 scsidev->channel, scsidev->id, scsidev->lun,
2575 scsicmd[0], scsicmd[1], scsicmd[2], scsicmd[3],
2576 scsicmd[4], scsicmd[5], scsicmd[6], scsicmd[7],
2577 scsicmd[8]);
2578 #endif
2581 static inline void __ata_scsi_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *),
2582 struct ata_port *ap, struct ata_device *dev)
2584 if (dev->class == ATA_DEV_ATA) {
2585 ata_xlat_func_t xlat_func = ata_get_xlat_func(dev,
2586 cmd->cmnd[0]);
2588 if (xlat_func)
2589 ata_scsi_translate(ap, dev, cmd, done, xlat_func);
2590 else
2591 ata_scsi_simulate(ap, dev, cmd, done);
2592 } else
2593 ata_scsi_translate(ap, dev, cmd, done, atapi_xlat);
2597 * ata_scsi_queuecmd - Issue SCSI cdb to libata-managed device
2598 * @cmd: SCSI command to be sent
2599 * @done: Completion function, called when command is complete
2601 * In some cases, this function translates SCSI commands into
2602 * ATA taskfiles, and queues the taskfiles to be sent to
2603 * hardware. In other cases, this function simulates a
2604 * SCSI device by evaluating and responding to certain
2605 * SCSI commands. This creates the overall effect of
2606 * ATA and ATAPI devices appearing as SCSI devices.
2608 * LOCKING:
2609 * Releases scsi-layer-held lock, and obtains host_set lock.
2611 * RETURNS:
2612 * Zero.
2615 int ata_scsi_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *))
2617 struct ata_port *ap;
2618 struct ata_device *dev;
2619 struct scsi_device *scsidev = cmd->device;
2620 struct Scsi_Host *shost = scsidev->host;
2622 ap = (struct ata_port *) &shost->hostdata[0];
2624 spin_unlock(shost->host_lock);
2625 spin_lock(&ap->host_set->lock);
2627 ata_scsi_dump_cdb(ap, cmd);
2629 dev = ata_scsi_find_dev(ap, scsidev);
2630 if (likely(dev))
2631 __ata_scsi_queuecmd(cmd, done, ap, dev);
2632 else {
2633 cmd->result = (DID_BAD_TARGET << 16);
2634 done(cmd);
2637 spin_unlock(&ap->host_set->lock);
2638 spin_lock(shost->host_lock);
2639 return 0;
2643 * ata_scsi_simulate - simulate SCSI command on ATA device
2644 * @ap: port the device is connected to
2645 * @dev: the target device
2646 * @cmd: SCSI command being sent to device.
2647 * @done: SCSI command completion function.
2649 * Interprets and directly executes a select list of SCSI commands
2650 * that can be handled internally.
2652 * LOCKING:
2653 * spin_lock_irqsave(host_set lock)
2656 void ata_scsi_simulate(struct ata_port *ap, struct ata_device *dev,
2657 struct scsi_cmnd *cmd,
2658 void (*done)(struct scsi_cmnd *))
2660 struct ata_scsi_args args;
2661 const u8 *scsicmd = cmd->cmnd;
2663 args.ap = ap;
2664 args.dev = dev;
2665 args.id = dev->id;
2666 args.cmd = cmd;
2667 args.done = done;
2669 switch(scsicmd[0]) {
2670 /* no-op's, complete with success */
2671 case SYNCHRONIZE_CACHE:
2672 case REZERO_UNIT:
2673 case SEEK_6:
2674 case SEEK_10:
2675 case TEST_UNIT_READY:
2676 case FORMAT_UNIT: /* FIXME: correct? */
2677 case SEND_DIAGNOSTIC: /* FIXME: correct? */
2678 ata_scsi_rbuf_fill(&args, ata_scsiop_noop);
2679 break;
2681 case INQUIRY:
2682 if (scsicmd[1] & 2) /* is CmdDt set? */
2683 ata_scsi_invalid_field(cmd, done);
2684 else if ((scsicmd[1] & 1) == 0) /* is EVPD clear? */
2685 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_std);
2686 else if (scsicmd[2] == 0x00)
2687 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_00);
2688 else if (scsicmd[2] == 0x80)
2689 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_80);
2690 else if (scsicmd[2] == 0x83)
2691 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_83);
2692 else
2693 ata_scsi_invalid_field(cmd, done);
2694 break;
2696 case MODE_SENSE:
2697 case MODE_SENSE_10:
2698 ata_scsi_rbuf_fill(&args, ata_scsiop_mode_sense);
2699 break;
2701 case MODE_SELECT: /* unconditionally return */
2702 case MODE_SELECT_10: /* bad-field-in-cdb */
2703 ata_scsi_invalid_field(cmd, done);
2704 break;
2706 case READ_CAPACITY:
2707 ata_scsi_rbuf_fill(&args, ata_scsiop_read_cap);
2708 break;
2710 case SERVICE_ACTION_IN:
2711 if ((scsicmd[1] & 0x1f) == SAI_READ_CAPACITY_16)
2712 ata_scsi_rbuf_fill(&args, ata_scsiop_read_cap);
2713 else
2714 ata_scsi_invalid_field(cmd, done);
2715 break;
2717 case REPORT_LUNS:
2718 ata_scsi_rbuf_fill(&args, ata_scsiop_report_luns);
2719 break;
2721 /* mandatory commands we haven't implemented yet */
2722 case REQUEST_SENSE:
2724 /* all other commands */
2725 default:
2726 ata_scsi_set_sense(cmd, ILLEGAL_REQUEST, 0x20, 0x0);
2727 /* "Invalid command operation code" */
2728 done(cmd);
2729 break;
2733 void ata_scsi_scan_host(struct ata_port *ap)
2735 struct ata_device *dev;
2736 unsigned int i;
2738 if (ap->flags & ATA_FLAG_PORT_DISABLED)
2739 return;
2741 for (i = 0; i < ATA_MAX_DEVICES; i++) {
2742 dev = &ap->device[i];
2744 if (ata_dev_present(dev))
2745 scsi_scan_target(&ap->host->shost_gendev, 0, i, 0, 0);