[libata] SCSI: simulator version, not device version, belongs in VPD
[linux-2.6/zen-sources.git] / drivers / ata / libata-scsi.c
blob468d791a303c58cb1203c03bd51815e69918197c
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_tcq.h>
45 #include <scsi/scsi_transport.h>
46 #include <linux/libata.h>
47 #include <linux/hdreg.h>
48 #include <asm/uaccess.h>
50 #include "libata.h"
52 #define SECTOR_SIZE 512
54 typedef unsigned int (*ata_xlat_func_t)(struct ata_queued_cmd *qc);
56 static struct ata_device * __ata_scsi_find_dev(struct ata_port *ap,
57 const struct scsi_device *scsidev);
58 static struct ata_device * ata_scsi_find_dev(struct ata_port *ap,
59 const struct scsi_device *scsidev);
60 static int ata_scsi_user_scan(struct Scsi_Host *shost, unsigned int channel,
61 unsigned int id, unsigned int lun);
64 #define RW_RECOVERY_MPAGE 0x1
65 #define RW_RECOVERY_MPAGE_LEN 12
66 #define CACHE_MPAGE 0x8
67 #define CACHE_MPAGE_LEN 20
68 #define CONTROL_MPAGE 0xa
69 #define CONTROL_MPAGE_LEN 12
70 #define ALL_MPAGES 0x3f
71 #define ALL_SUB_MPAGES 0xff
74 static const u8 def_rw_recovery_mpage[RW_RECOVERY_MPAGE_LEN] = {
75 RW_RECOVERY_MPAGE,
76 RW_RECOVERY_MPAGE_LEN - 2,
77 (1 << 7), /* AWRE */
78 0, /* read retry count */
79 0, 0, 0, 0,
80 0, /* write retry count */
81 0, 0, 0
84 static const u8 def_cache_mpage[CACHE_MPAGE_LEN] = {
85 CACHE_MPAGE,
86 CACHE_MPAGE_LEN - 2,
87 0, /* contains WCE, needs to be 0 for logic */
88 0, 0, 0, 0, 0, 0, 0, 0, 0,
89 0, /* contains DRA, needs to be 0 for logic */
90 0, 0, 0, 0, 0, 0, 0
93 static const u8 def_control_mpage[CONTROL_MPAGE_LEN] = {
94 CONTROL_MPAGE,
95 CONTROL_MPAGE_LEN - 2,
96 2, /* DSENSE=0, GLTSD=1 */
97 0, /* [QAM+QERR may be 1, see 05-359r1] */
98 0, 0, 0, 0, 0xff, 0xff,
99 0, 30 /* extended self test time, see 05-359r1 */
103 * libata transport template. libata doesn't do real transport stuff.
104 * It just needs the eh_timed_out hook.
106 static struct scsi_transport_template ata_scsi_transport_template = {
107 .eh_strategy_handler = ata_scsi_error,
108 .eh_timed_out = ata_scsi_timed_out,
109 .user_scan = ata_scsi_user_scan,
113 static void ata_scsi_invalid_field(struct scsi_cmnd *cmd,
114 void (*done)(struct scsi_cmnd *))
116 ata_scsi_set_sense(cmd, ILLEGAL_REQUEST, 0x24, 0x0);
117 /* "Invalid field in cbd" */
118 done(cmd);
122 * ata_std_bios_param - generic bios head/sector/cylinder calculator used by sd.
123 * @sdev: SCSI device for which BIOS geometry is to be determined
124 * @bdev: block device associated with @sdev
125 * @capacity: capacity of SCSI device
126 * @geom: location to which geometry will be output
128 * Generic bios head/sector/cylinder calculator
129 * used by sd. Most BIOSes nowadays expect a XXX/255/16 (CHS)
130 * mapping. Some situations may arise where the disk is not
131 * bootable if this is not used.
133 * LOCKING:
134 * Defined by the SCSI layer. We don't really care.
136 * RETURNS:
137 * Zero.
139 int ata_std_bios_param(struct scsi_device *sdev, struct block_device *bdev,
140 sector_t capacity, int geom[])
142 geom[0] = 255;
143 geom[1] = 63;
144 sector_div(capacity, 255*63);
145 geom[2] = capacity;
147 return 0;
151 * ata_get_identity - Handler for HDIO_GET_IDENTITY ioctl
152 * @sdev: SCSI device to get identify data for
153 * @arg: User buffer area for identify data
155 * LOCKING:
156 * Defined by the SCSI layer. We don't really care.
158 * RETURNS:
159 * Zero on success, negative errno on error.
161 static int ata_get_identity(struct scsi_device *sdev, void __user *arg)
163 struct ata_port *ap = ata_shost_to_port(sdev->host);
164 struct ata_device *dev = ata_scsi_find_dev(ap, sdev);
165 u16 __user *dst = arg;
166 char buf[40];
168 if (!dev)
169 return -ENOMSG;
171 if (copy_to_user(dst, dev->id, ATA_ID_WORDS * sizeof(u16)))
172 return -EFAULT;
174 ata_id_string(dev->id, buf, ATA_ID_PROD, ATA_ID_PROD_LEN);
175 if (copy_to_user(dst + ATA_ID_PROD, buf, ATA_ID_PROD_LEN))
176 return -EFAULT;
178 ata_id_string(dev->id, buf, ATA_ID_FW_REV, ATA_ID_FW_REV_LEN);
179 if (copy_to_user(dst + ATA_ID_FW_REV, buf, ATA_ID_FW_REV_LEN))
180 return -EFAULT;
182 ata_id_string(dev->id, buf, ATA_ID_SERNO, ATA_ID_SERNO_LEN);
183 if (copy_to_user(dst + ATA_ID_SERNO, buf, ATA_ID_SERNO_LEN))
184 return -EFAULT;
186 return 0;
190 * ata_cmd_ioctl - Handler for HDIO_DRIVE_CMD ioctl
191 * @scsidev: Device to which we are issuing command
192 * @arg: User provided data for issuing command
194 * LOCKING:
195 * Defined by the SCSI layer. We don't really care.
197 * RETURNS:
198 * Zero on success, negative errno on error.
200 int ata_cmd_ioctl(struct scsi_device *scsidev, void __user *arg)
202 int rc = 0;
203 u8 scsi_cmd[MAX_COMMAND_SIZE];
204 u8 args[4], *argbuf = NULL, *sensebuf = NULL;
205 int argsize = 0;
206 enum dma_data_direction data_dir;
207 int cmd_result;
209 if (arg == NULL)
210 return -EINVAL;
212 if (copy_from_user(args, arg, sizeof(args)))
213 return -EFAULT;
215 sensebuf = kzalloc(SCSI_SENSE_BUFFERSIZE, GFP_NOIO);
216 if (!sensebuf)
217 return -ENOMEM;
219 memset(scsi_cmd, 0, sizeof(scsi_cmd));
221 if (args[3]) {
222 argsize = SECTOR_SIZE * args[3];
223 argbuf = kmalloc(argsize, GFP_KERNEL);
224 if (argbuf == NULL) {
225 rc = -ENOMEM;
226 goto error;
229 scsi_cmd[1] = (4 << 1); /* PIO Data-in */
230 scsi_cmd[2] = 0x0e; /* no off.line or cc, read from dev,
231 block count in sector count field */
232 data_dir = DMA_FROM_DEVICE;
233 } else {
234 scsi_cmd[1] = (3 << 1); /* Non-data */
235 scsi_cmd[2] = 0x20; /* cc but no off.line or data xfer */
236 data_dir = DMA_NONE;
239 scsi_cmd[0] = ATA_16;
241 scsi_cmd[4] = args[2];
242 if (args[0] == WIN_SMART) { /* hack -- ide driver does this too... */
243 scsi_cmd[6] = args[3];
244 scsi_cmd[8] = args[1];
245 scsi_cmd[10] = 0x4f;
246 scsi_cmd[12] = 0xc2;
247 } else {
248 scsi_cmd[6] = args[1];
250 scsi_cmd[14] = args[0];
252 /* Good values for timeout and retries? Values below
253 from scsi_ioctl_send_command() for default case... */
254 cmd_result = scsi_execute(scsidev, scsi_cmd, data_dir, argbuf, argsize,
255 sensebuf, (10*HZ), 5, 0);
257 if (driver_byte(cmd_result) == DRIVER_SENSE) {/* sense data available */
258 u8 *desc = sensebuf + 8;
259 cmd_result &= ~(0xFF<<24); /* DRIVER_SENSE is not an error */
261 /* If we set cc then ATA pass-through will cause a
262 * check condition even if no error. Filter that. */
263 if (cmd_result & SAM_STAT_CHECK_CONDITION) {
264 struct scsi_sense_hdr sshdr;
265 scsi_normalize_sense(sensebuf, SCSI_SENSE_BUFFERSIZE,
266 &sshdr);
267 if (sshdr.sense_key==0 &&
268 sshdr.asc==0 && sshdr.ascq==0)
269 cmd_result &= ~SAM_STAT_CHECK_CONDITION;
272 /* Send userspace a few ATA registers (same as drivers/ide) */
273 if (sensebuf[0] == 0x72 && /* format is "descriptor" */
274 desc[0] == 0x09 ) { /* code is "ATA Descriptor" */
275 args[0] = desc[13]; /* status */
276 args[1] = desc[3]; /* error */
277 args[2] = desc[5]; /* sector count (0:7) */
278 if (copy_to_user(arg, args, sizeof(args)))
279 rc = -EFAULT;
284 if (cmd_result) {
285 rc = -EIO;
286 goto error;
289 if ((argbuf)
290 && copy_to_user(arg + sizeof(args), argbuf, argsize))
291 rc = -EFAULT;
292 error:
293 kfree(sensebuf);
294 kfree(argbuf);
295 return rc;
299 * ata_task_ioctl - Handler for HDIO_DRIVE_TASK ioctl
300 * @scsidev: Device to which we are issuing command
301 * @arg: User provided data for issuing command
303 * LOCKING:
304 * Defined by the SCSI layer. We don't really care.
306 * RETURNS:
307 * Zero on success, negative errno on error.
309 int ata_task_ioctl(struct scsi_device *scsidev, void __user *arg)
311 int rc = 0;
312 u8 scsi_cmd[MAX_COMMAND_SIZE];
313 u8 args[7], *sensebuf = NULL;
314 int cmd_result;
316 if (arg == NULL)
317 return -EINVAL;
319 if (copy_from_user(args, arg, sizeof(args)))
320 return -EFAULT;
322 sensebuf = kzalloc(SCSI_SENSE_BUFFERSIZE, GFP_NOIO);
323 if (!sensebuf)
324 return -ENOMEM;
326 memset(scsi_cmd, 0, sizeof(scsi_cmd));
327 scsi_cmd[0] = ATA_16;
328 scsi_cmd[1] = (3 << 1); /* Non-data */
329 scsi_cmd[2] = 0x20; /* cc but no off.line or data xfer */
330 scsi_cmd[4] = args[1];
331 scsi_cmd[6] = args[2];
332 scsi_cmd[8] = args[3];
333 scsi_cmd[10] = args[4];
334 scsi_cmd[12] = args[5];
335 scsi_cmd[13] = args[6] & 0x4f;
336 scsi_cmd[14] = args[0];
338 /* Good values for timeout and retries? Values below
339 from scsi_ioctl_send_command() for default case... */
340 cmd_result = scsi_execute(scsidev, scsi_cmd, DMA_NONE, NULL, 0,
341 sensebuf, (10*HZ), 5, 0);
343 if (driver_byte(cmd_result) == DRIVER_SENSE) {/* sense data available */
344 u8 *desc = sensebuf + 8;
345 cmd_result &= ~(0xFF<<24); /* DRIVER_SENSE is not an error */
347 /* If we set cc then ATA pass-through will cause a
348 * check condition even if no error. Filter that. */
349 if (cmd_result & SAM_STAT_CHECK_CONDITION) {
350 struct scsi_sense_hdr sshdr;
351 scsi_normalize_sense(sensebuf, SCSI_SENSE_BUFFERSIZE,
352 &sshdr);
353 if (sshdr.sense_key==0 &&
354 sshdr.asc==0 && sshdr.ascq==0)
355 cmd_result &= ~SAM_STAT_CHECK_CONDITION;
358 /* Send userspace ATA registers */
359 if (sensebuf[0] == 0x72 && /* format is "descriptor" */
360 desc[0] == 0x09) {/* code is "ATA Descriptor" */
361 args[0] = desc[13]; /* status */
362 args[1] = desc[3]; /* error */
363 args[2] = desc[5]; /* sector count (0:7) */
364 args[3] = desc[7]; /* lbal */
365 args[4] = desc[9]; /* lbam */
366 args[5] = desc[11]; /* lbah */
367 args[6] = desc[12]; /* select */
368 if (copy_to_user(arg, args, sizeof(args)))
369 rc = -EFAULT;
373 if (cmd_result) {
374 rc = -EIO;
375 goto error;
378 error:
379 kfree(sensebuf);
380 return rc;
383 int ata_scsi_ioctl(struct scsi_device *scsidev, int cmd, void __user *arg)
385 int val = -EINVAL, rc = -EINVAL;
387 switch (cmd) {
388 case ATA_IOC_GET_IO32:
389 val = 0;
390 if (copy_to_user(arg, &val, 1))
391 return -EFAULT;
392 return 0;
394 case ATA_IOC_SET_IO32:
395 val = (unsigned long) arg;
396 if (val != 0)
397 return -EINVAL;
398 return 0;
400 case HDIO_GET_IDENTITY:
401 return ata_get_identity(scsidev, arg);
403 case HDIO_DRIVE_CMD:
404 if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
405 return -EACCES;
406 return ata_cmd_ioctl(scsidev, arg);
408 case HDIO_DRIVE_TASK:
409 if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
410 return -EACCES;
411 return ata_task_ioctl(scsidev, arg);
413 default:
414 rc = -ENOTTY;
415 break;
418 return rc;
422 * ata_scsi_qc_new - acquire new ata_queued_cmd reference
423 * @dev: ATA device to which the new command is attached
424 * @cmd: SCSI command that originated this ATA command
425 * @done: SCSI command completion function
427 * Obtain a reference to an unused ata_queued_cmd structure,
428 * which is the basic libata structure representing a single
429 * ATA command sent to the hardware.
431 * If a command was available, fill in the SCSI-specific
432 * portions of the structure with information on the
433 * current command.
435 * LOCKING:
436 * spin_lock_irqsave(host lock)
438 * RETURNS:
439 * Command allocated, or %NULL if none available.
441 static struct ata_queued_cmd *ata_scsi_qc_new(struct ata_device *dev,
442 struct scsi_cmnd *cmd,
443 void (*done)(struct scsi_cmnd *))
445 struct ata_queued_cmd *qc;
447 qc = ata_qc_new_init(dev);
448 if (qc) {
449 qc->scsicmd = cmd;
450 qc->scsidone = done;
452 qc->__sg = scsi_sglist(cmd);
453 qc->n_elem = scsi_sg_count(cmd);
454 } else {
455 cmd->result = (DID_OK << 16) | (QUEUE_FULL << 1);
456 done(cmd);
459 return qc;
463 * ata_dump_status - user friendly display of error info
464 * @id: id of the port in question
465 * @tf: ptr to filled out taskfile
467 * Decode and dump the ATA error/status registers for the user so
468 * that they have some idea what really happened at the non
469 * make-believe layer.
471 * LOCKING:
472 * inherited from caller
474 static void ata_dump_status(unsigned id, struct ata_taskfile *tf)
476 u8 stat = tf->command, err = tf->feature;
478 printk(KERN_WARNING "ata%u: status=0x%02x { ", id, stat);
479 if (stat & ATA_BUSY) {
480 printk("Busy }\n"); /* Data is not valid in this case */
481 } else {
482 if (stat & 0x40) printk("DriveReady ");
483 if (stat & 0x20) printk("DeviceFault ");
484 if (stat & 0x10) printk("SeekComplete ");
485 if (stat & 0x08) printk("DataRequest ");
486 if (stat & 0x04) printk("CorrectedError ");
487 if (stat & 0x02) printk("Index ");
488 if (stat & 0x01) printk("Error ");
489 printk("}\n");
491 if (err) {
492 printk(KERN_WARNING "ata%u: error=0x%02x { ", id, err);
493 if (err & 0x04) printk("DriveStatusError ");
494 if (err & 0x80) {
495 if (err & 0x04) printk("BadCRC ");
496 else printk("Sector ");
498 if (err & 0x40) printk("UncorrectableError ");
499 if (err & 0x10) printk("SectorIdNotFound ");
500 if (err & 0x02) printk("TrackZeroNotFound ");
501 if (err & 0x01) printk("AddrMarkNotFound ");
502 printk("}\n");
508 * ata_to_sense_error - convert ATA error to SCSI error
509 * @id: ATA device number
510 * @drv_stat: value contained in ATA status register
511 * @drv_err: value contained in ATA error register
512 * @sk: the sense key we'll fill out
513 * @asc: the additional sense code we'll fill out
514 * @ascq: the additional sense code qualifier we'll fill out
515 * @verbose: be verbose
517 * Converts an ATA error into a SCSI error. Fill out pointers to
518 * SK, ASC, and ASCQ bytes for later use in fixed or descriptor
519 * format sense blocks.
521 * LOCKING:
522 * spin_lock_irqsave(host lock)
524 static void ata_to_sense_error(unsigned id, u8 drv_stat, u8 drv_err, u8 *sk,
525 u8 *asc, u8 *ascq, int verbose)
527 int i;
529 /* Based on the 3ware driver translation table */
530 static const unsigned char sense_table[][4] = {
531 /* BBD|ECC|ID|MAR */
532 {0xd1, ABORTED_COMMAND, 0x00, 0x00}, // Device busy Aborted command
533 /* BBD|ECC|ID */
534 {0xd0, ABORTED_COMMAND, 0x00, 0x00}, // Device busy Aborted command
535 /* ECC|MC|MARK */
536 {0x61, HARDWARE_ERROR, 0x00, 0x00}, // Device fault Hardware error
537 /* ICRC|ABRT */ /* NB: ICRC & !ABRT is BBD */
538 {0x84, ABORTED_COMMAND, 0x47, 0x00}, // Data CRC error SCSI parity error
539 /* MC|ID|ABRT|TRK0|MARK */
540 {0x37, NOT_READY, 0x04, 0x00}, // Unit offline Not ready
541 /* MCR|MARK */
542 {0x09, NOT_READY, 0x04, 0x00}, // Unrecovered disk error Not ready
543 /* Bad address mark */
544 {0x01, MEDIUM_ERROR, 0x13, 0x00}, // Address mark not found Address mark not found for data field
545 /* TRK0 */
546 {0x02, HARDWARE_ERROR, 0x00, 0x00}, // Track 0 not found Hardware error
547 /* Abort & !ICRC */
548 {0x04, ABORTED_COMMAND, 0x00, 0x00}, // Aborted command Aborted command
549 /* Media change request */
550 {0x08, NOT_READY, 0x04, 0x00}, // Media change request FIXME: faking offline
551 /* SRV */
552 {0x10, ABORTED_COMMAND, 0x14, 0x00}, // ID not found Recorded entity not found
553 /* Media change */
554 {0x08, NOT_READY, 0x04, 0x00}, // Media change FIXME: faking offline
555 /* ECC */
556 {0x40, MEDIUM_ERROR, 0x11, 0x04}, // Uncorrectable ECC error Unrecovered read error
557 /* BBD - block marked bad */
558 {0x80, MEDIUM_ERROR, 0x11, 0x04}, // Block marked bad Medium error, unrecovered read error
559 {0xFF, 0xFF, 0xFF, 0xFF}, // END mark
561 static const unsigned char stat_table[][4] = {
562 /* Must be first because BUSY means no other bits valid */
563 {0x80, ABORTED_COMMAND, 0x47, 0x00}, // Busy, fake parity for now
564 {0x20, HARDWARE_ERROR, 0x00, 0x00}, // Device fault
565 {0x08, ABORTED_COMMAND, 0x47, 0x00}, // Timed out in xfer, fake parity for now
566 {0x04, RECOVERED_ERROR, 0x11, 0x00}, // Recovered ECC error Medium error, recovered
567 {0xFF, 0xFF, 0xFF, 0xFF}, // END mark
571 * Is this an error we can process/parse
573 if (drv_stat & ATA_BUSY) {
574 drv_err = 0; /* Ignore the err bits, they're invalid */
577 if (drv_err) {
578 /* Look for drv_err */
579 for (i = 0; sense_table[i][0] != 0xFF; i++) {
580 /* Look for best matches first */
581 if ((sense_table[i][0] & drv_err) ==
582 sense_table[i][0]) {
583 *sk = sense_table[i][1];
584 *asc = sense_table[i][2];
585 *ascq = sense_table[i][3];
586 goto translate_done;
589 /* No immediate match */
590 if (verbose)
591 printk(KERN_WARNING "ata%u: no sense translation for "
592 "error 0x%02x\n", id, drv_err);
595 /* Fall back to interpreting status bits */
596 for (i = 0; stat_table[i][0] != 0xFF; i++) {
597 if (stat_table[i][0] & drv_stat) {
598 *sk = stat_table[i][1];
599 *asc = stat_table[i][2];
600 *ascq = stat_table[i][3];
601 goto translate_done;
604 /* No error? Undecoded? */
605 if (verbose)
606 printk(KERN_WARNING "ata%u: no sense translation for "
607 "status: 0x%02x\n", id, drv_stat);
609 /* We need a sensible error return here, which is tricky, and one
610 that won't cause people to do things like return a disk wrongly */
611 *sk = ABORTED_COMMAND;
612 *asc = 0x00;
613 *ascq = 0x00;
615 translate_done:
616 if (verbose)
617 printk(KERN_ERR "ata%u: translated ATA stat/err 0x%02x/%02x "
618 "to SCSI SK/ASC/ASCQ 0x%x/%02x/%02x\n",
619 id, drv_stat, drv_err, *sk, *asc, *ascq);
620 return;
624 * ata_gen_passthru_sense - Generate check condition sense block.
625 * @qc: Command that completed.
627 * This function is specific to the ATA descriptor format sense
628 * block specified for the ATA pass through commands. Regardless
629 * of whether the command errored or not, return a sense
630 * block. Copy all controller registers into the sense
631 * block. Clear sense key, ASC & ASCQ if there is no error.
633 * LOCKING:
634 * None.
636 static void ata_gen_passthru_sense(struct ata_queued_cmd *qc)
638 struct scsi_cmnd *cmd = qc->scsicmd;
639 struct ata_taskfile *tf = &qc->result_tf;
640 unsigned char *sb = cmd->sense_buffer;
641 unsigned char *desc = sb + 8;
642 int verbose = qc->ap->ops->error_handler == NULL;
644 memset(sb, 0, SCSI_SENSE_BUFFERSIZE);
646 cmd->result = (DRIVER_SENSE << 24) | SAM_STAT_CHECK_CONDITION;
649 * Use ata_to_sense_error() to map status register bits
650 * onto sense key, asc & ascq.
652 if (qc->err_mask ||
653 tf->command & (ATA_BUSY | ATA_DF | ATA_ERR | ATA_DRQ)) {
654 ata_to_sense_error(qc->ap->print_id, tf->command, tf->feature,
655 &sb[1], &sb[2], &sb[3], verbose);
656 sb[1] &= 0x0f;
660 * Sense data is current and format is descriptor.
662 sb[0] = 0x72;
664 desc[0] = 0x09;
666 /* set length of additional sense data */
667 sb[7] = 14;
668 desc[1] = 12;
671 * Copy registers into sense buffer.
673 desc[2] = 0x00;
674 desc[3] = tf->feature; /* == error reg */
675 desc[5] = tf->nsect;
676 desc[7] = tf->lbal;
677 desc[9] = tf->lbam;
678 desc[11] = tf->lbah;
679 desc[12] = tf->device;
680 desc[13] = tf->command; /* == status reg */
683 * Fill in Extend bit, and the high order bytes
684 * if applicable.
686 if (tf->flags & ATA_TFLAG_LBA48) {
687 desc[2] |= 0x01;
688 desc[4] = tf->hob_nsect;
689 desc[6] = tf->hob_lbal;
690 desc[8] = tf->hob_lbam;
691 desc[10] = tf->hob_lbah;
696 * ata_gen_ata_sense - generate a SCSI fixed sense block
697 * @qc: Command that we are erroring out
699 * Generate sense block for a failed ATA command @qc. Descriptor
700 * format is used to accomodate LBA48 block address.
702 * LOCKING:
703 * None.
705 static void ata_gen_ata_sense(struct ata_queued_cmd *qc)
707 struct ata_device *dev = qc->dev;
708 struct scsi_cmnd *cmd = qc->scsicmd;
709 struct ata_taskfile *tf = &qc->result_tf;
710 unsigned char *sb = cmd->sense_buffer;
711 unsigned char *desc = sb + 8;
712 int verbose = qc->ap->ops->error_handler == NULL;
713 u64 block;
715 memset(sb, 0, SCSI_SENSE_BUFFERSIZE);
717 cmd->result = (DRIVER_SENSE << 24) | SAM_STAT_CHECK_CONDITION;
719 /* sense data is current and format is descriptor */
720 sb[0] = 0x72;
722 /* Use ata_to_sense_error() to map status register bits
723 * onto sense key, asc & ascq.
725 if (qc->err_mask ||
726 tf->command & (ATA_BUSY | ATA_DF | ATA_ERR | ATA_DRQ)) {
727 ata_to_sense_error(qc->ap->print_id, tf->command, tf->feature,
728 &sb[1], &sb[2], &sb[3], verbose);
729 sb[1] &= 0x0f;
732 block = ata_tf_read_block(&qc->result_tf, dev);
734 /* information sense data descriptor */
735 sb[7] = 12;
736 desc[0] = 0x00;
737 desc[1] = 10;
739 desc[2] |= 0x80; /* valid */
740 desc[6] = block >> 40;
741 desc[7] = block >> 32;
742 desc[8] = block >> 24;
743 desc[9] = block >> 16;
744 desc[10] = block >> 8;
745 desc[11] = block;
748 static void ata_scsi_sdev_config(struct scsi_device *sdev)
750 sdev->use_10_for_rw = 1;
751 sdev->use_10_for_ms = 1;
754 static void ata_scsi_dev_config(struct scsi_device *sdev,
755 struct ata_device *dev)
757 /* configure max sectors */
758 blk_queue_max_sectors(sdev->request_queue, dev->max_sectors);
760 /* SATA DMA transfers must be multiples of 4 byte, so
761 * we need to pad ATAPI transfers using an extra sg.
762 * Decrement max hw segments accordingly.
764 if (dev->class == ATA_DEV_ATAPI) {
765 struct request_queue *q = sdev->request_queue;
766 blk_queue_max_hw_segments(q, q->max_hw_segments - 1);
769 if (dev->flags & ATA_DFLAG_NCQ) {
770 int depth;
772 depth = min(sdev->host->can_queue, ata_id_queue_depth(dev->id));
773 depth = min(ATA_MAX_QUEUE - 1, depth);
774 scsi_adjust_queue_depth(sdev, MSG_SIMPLE_TAG, depth);
779 * ata_scsi_slave_config - Set SCSI device attributes
780 * @sdev: SCSI device to examine
782 * This is called before we actually start reading
783 * and writing to the device, to configure certain
784 * SCSI mid-layer behaviors.
786 * LOCKING:
787 * Defined by SCSI layer. We don't really care.
790 int ata_scsi_slave_config(struct scsi_device *sdev)
792 struct ata_port *ap = ata_shost_to_port(sdev->host);
793 struct ata_device *dev = __ata_scsi_find_dev(ap, sdev);
795 ata_scsi_sdev_config(sdev);
797 blk_queue_max_phys_segments(sdev->request_queue, LIBATA_MAX_PRD);
799 sdev->manage_start_stop = 1;
801 if (dev)
802 ata_scsi_dev_config(sdev, dev);
804 return 0; /* scsi layer doesn't check return value, sigh */
808 * ata_scsi_slave_destroy - SCSI device is about to be destroyed
809 * @sdev: SCSI device to be destroyed
811 * @sdev is about to be destroyed for hot/warm unplugging. If
812 * this unplugging was initiated by libata as indicated by NULL
813 * dev->sdev, this function doesn't have to do anything.
814 * Otherwise, SCSI layer initiated warm-unplug is in progress.
815 * Clear dev->sdev, schedule the device for ATA detach and invoke
816 * EH.
818 * LOCKING:
819 * Defined by SCSI layer. We don't really care.
821 void ata_scsi_slave_destroy(struct scsi_device *sdev)
823 struct ata_port *ap = ata_shost_to_port(sdev->host);
824 unsigned long flags;
825 struct ata_device *dev;
827 if (!ap->ops->error_handler)
828 return;
830 spin_lock_irqsave(ap->lock, flags);
831 dev = __ata_scsi_find_dev(ap, sdev);
832 if (dev && dev->sdev) {
833 /* SCSI device already in CANCEL state, no need to offline it */
834 dev->sdev = NULL;
835 dev->flags |= ATA_DFLAG_DETACH;
836 ata_port_schedule_eh(ap);
838 spin_unlock_irqrestore(ap->lock, flags);
842 * ata_scsi_change_queue_depth - SCSI callback for queue depth config
843 * @sdev: SCSI device to configure queue depth for
844 * @queue_depth: new queue depth
846 * This is libata standard hostt->change_queue_depth callback.
847 * SCSI will call into this callback when user tries to set queue
848 * depth via sysfs.
850 * LOCKING:
851 * SCSI layer (we don't care)
853 * RETURNS:
854 * Newly configured queue depth.
856 int ata_scsi_change_queue_depth(struct scsi_device *sdev, int queue_depth)
858 struct ata_port *ap = ata_shost_to_port(sdev->host);
859 struct ata_device *dev;
860 unsigned long flags;
862 if (queue_depth < 1 || queue_depth == sdev->queue_depth)
863 return sdev->queue_depth;
865 dev = ata_scsi_find_dev(ap, sdev);
866 if (!dev || !ata_dev_enabled(dev))
867 return sdev->queue_depth;
869 /* NCQ enabled? */
870 spin_lock_irqsave(ap->lock, flags);
871 dev->flags &= ~ATA_DFLAG_NCQ_OFF;
872 if (queue_depth == 1 || !ata_ncq_enabled(dev)) {
873 dev->flags |= ATA_DFLAG_NCQ_OFF;
874 queue_depth = 1;
876 spin_unlock_irqrestore(ap->lock, flags);
878 /* limit and apply queue depth */
879 queue_depth = min(queue_depth, sdev->host->can_queue);
880 queue_depth = min(queue_depth, ata_id_queue_depth(dev->id));
881 queue_depth = min(queue_depth, ATA_MAX_QUEUE - 1);
883 if (sdev->queue_depth == queue_depth)
884 return -EINVAL;
886 scsi_adjust_queue_depth(sdev, MSG_SIMPLE_TAG, queue_depth);
887 return queue_depth;
890 /* XXX: for spindown warning */
891 static void ata_delayed_done_timerfn(unsigned long arg)
893 struct scsi_cmnd *scmd = (void *)arg;
895 scmd->scsi_done(scmd);
898 /* XXX: for spindown warning */
899 static void ata_delayed_done(struct scsi_cmnd *scmd)
901 static struct timer_list timer;
903 setup_timer(&timer, ata_delayed_done_timerfn, (unsigned long)scmd);
904 mod_timer(&timer, jiffies + 5 * HZ);
908 * ata_scsi_start_stop_xlat - Translate SCSI START STOP UNIT command
909 * @qc: Storage for translated ATA taskfile
911 * Sets up an ATA taskfile to issue STANDBY (to stop) or READ VERIFY
912 * (to start). Perhaps these commands should be preceded by
913 * CHECK POWER MODE to see what power mode the device is already in.
914 * [See SAT revision 5 at www.t10.org]
916 * LOCKING:
917 * spin_lock_irqsave(host lock)
919 * RETURNS:
920 * Zero on success, non-zero on error.
922 static unsigned int ata_scsi_start_stop_xlat(struct ata_queued_cmd *qc)
924 struct scsi_cmnd *scmd = qc->scsicmd;
925 struct ata_taskfile *tf = &qc->tf;
926 const u8 *cdb = scmd->cmnd;
928 if (scmd->cmd_len < 5)
929 goto invalid_fld;
931 tf->flags |= ATA_TFLAG_DEVICE | ATA_TFLAG_ISADDR;
932 tf->protocol = ATA_PROT_NODATA;
933 if (cdb[1] & 0x1) {
934 ; /* ignore IMMED bit, violates sat-r05 */
936 if (cdb[4] & 0x2)
937 goto invalid_fld; /* LOEJ bit set not supported */
938 if (((cdb[4] >> 4) & 0xf) != 0)
939 goto invalid_fld; /* power conditions not supported */
940 if (cdb[4] & 0x1) {
941 tf->nsect = 1; /* 1 sector, lba=0 */
943 if (qc->dev->flags & ATA_DFLAG_LBA) {
944 tf->flags |= ATA_TFLAG_LBA;
946 tf->lbah = 0x0;
947 tf->lbam = 0x0;
948 tf->lbal = 0x0;
949 tf->device |= ATA_LBA;
950 } else {
951 /* CHS */
952 tf->lbal = 0x1; /* sect */
953 tf->lbam = 0x0; /* cyl low */
954 tf->lbah = 0x0; /* cyl high */
957 tf->command = ATA_CMD_VERIFY; /* READ VERIFY */
958 } else {
959 /* XXX: This is for backward compatibility, will be
960 * removed. Read Documentation/feature-removal-schedule.txt
961 * for more info.
963 if ((qc->dev->flags & ATA_DFLAG_SPUNDOWN) &&
964 (system_state == SYSTEM_HALT ||
965 system_state == SYSTEM_POWER_OFF)) {
966 static unsigned long warned = 0;
968 if (!test_and_set_bit(0, &warned)) {
969 ata_dev_printk(qc->dev, KERN_WARNING,
970 "DISK MIGHT NOT BE SPUN DOWN PROPERLY. "
971 "UPDATE SHUTDOWN UTILITY\n");
972 ata_dev_printk(qc->dev, KERN_WARNING,
973 "For more info, visit "
974 "http://linux-ata.org/shutdown.html\n");
976 /* ->scsi_done is not used, use it for
977 * delayed completion.
979 scmd->scsi_done = qc->scsidone;
980 qc->scsidone = ata_delayed_done;
982 scmd->result = SAM_STAT_GOOD;
983 return 1;
986 /* Issue ATA STANDBY IMMEDIATE command */
987 tf->command = ATA_CMD_STANDBYNOW1;
991 * Standby and Idle condition timers could be implemented but that
992 * would require libata to implement the Power condition mode page
993 * and allow the user to change it. Changing mode pages requires
994 * MODE SELECT to be implemented.
997 return 0;
999 invalid_fld:
1000 ata_scsi_set_sense(scmd, ILLEGAL_REQUEST, 0x24, 0x0);
1001 /* "Invalid field in cbd" */
1002 return 1;
1007 * ata_scsi_flush_xlat - Translate SCSI SYNCHRONIZE CACHE command
1008 * @qc: Storage for translated ATA taskfile
1010 * Sets up an ATA taskfile to issue FLUSH CACHE or
1011 * FLUSH CACHE EXT.
1013 * LOCKING:
1014 * spin_lock_irqsave(host lock)
1016 * RETURNS:
1017 * Zero on success, non-zero on error.
1019 static unsigned int ata_scsi_flush_xlat(struct ata_queued_cmd *qc)
1021 struct ata_taskfile *tf = &qc->tf;
1023 tf->flags |= ATA_TFLAG_DEVICE;
1024 tf->protocol = ATA_PROT_NODATA;
1026 if (qc->dev->flags & ATA_DFLAG_FLUSH_EXT)
1027 tf->command = ATA_CMD_FLUSH_EXT;
1028 else
1029 tf->command = ATA_CMD_FLUSH;
1031 return 0;
1035 * scsi_6_lba_len - Get LBA and transfer length
1036 * @cdb: SCSI command to translate
1038 * Calculate LBA and transfer length for 6-byte commands.
1040 * RETURNS:
1041 * @plba: the LBA
1042 * @plen: the transfer length
1044 static void scsi_6_lba_len(const u8 *cdb, u64 *plba, u32 *plen)
1046 u64 lba = 0;
1047 u32 len;
1049 VPRINTK("six-byte command\n");
1051 lba |= ((u64)(cdb[1] & 0x1f)) << 16;
1052 lba |= ((u64)cdb[2]) << 8;
1053 lba |= ((u64)cdb[3]);
1055 len = cdb[4];
1057 *plba = lba;
1058 *plen = len;
1062 * scsi_10_lba_len - Get LBA and transfer length
1063 * @cdb: SCSI command to translate
1065 * Calculate LBA and transfer length for 10-byte commands.
1067 * RETURNS:
1068 * @plba: the LBA
1069 * @plen: the transfer length
1071 static void scsi_10_lba_len(const u8 *cdb, u64 *plba, u32 *plen)
1073 u64 lba = 0;
1074 u32 len = 0;
1076 VPRINTK("ten-byte command\n");
1078 lba |= ((u64)cdb[2]) << 24;
1079 lba |= ((u64)cdb[3]) << 16;
1080 lba |= ((u64)cdb[4]) << 8;
1081 lba |= ((u64)cdb[5]);
1083 len |= ((u32)cdb[7]) << 8;
1084 len |= ((u32)cdb[8]);
1086 *plba = lba;
1087 *plen = len;
1091 * scsi_16_lba_len - Get LBA and transfer length
1092 * @cdb: SCSI command to translate
1094 * Calculate LBA and transfer length for 16-byte commands.
1096 * RETURNS:
1097 * @plba: the LBA
1098 * @plen: the transfer length
1100 static void scsi_16_lba_len(const u8 *cdb, u64 *plba, u32 *plen)
1102 u64 lba = 0;
1103 u32 len = 0;
1105 VPRINTK("sixteen-byte command\n");
1107 lba |= ((u64)cdb[2]) << 56;
1108 lba |= ((u64)cdb[3]) << 48;
1109 lba |= ((u64)cdb[4]) << 40;
1110 lba |= ((u64)cdb[5]) << 32;
1111 lba |= ((u64)cdb[6]) << 24;
1112 lba |= ((u64)cdb[7]) << 16;
1113 lba |= ((u64)cdb[8]) << 8;
1114 lba |= ((u64)cdb[9]);
1116 len |= ((u32)cdb[10]) << 24;
1117 len |= ((u32)cdb[11]) << 16;
1118 len |= ((u32)cdb[12]) << 8;
1119 len |= ((u32)cdb[13]);
1121 *plba = lba;
1122 *plen = len;
1126 * ata_scsi_verify_xlat - Translate SCSI VERIFY command into an ATA one
1127 * @qc: Storage for translated ATA taskfile
1129 * Converts SCSI VERIFY command to an ATA READ VERIFY command.
1131 * LOCKING:
1132 * spin_lock_irqsave(host lock)
1134 * RETURNS:
1135 * Zero on success, non-zero on error.
1137 static unsigned int ata_scsi_verify_xlat(struct ata_queued_cmd *qc)
1139 struct scsi_cmnd *scmd = qc->scsicmd;
1140 struct ata_taskfile *tf = &qc->tf;
1141 struct ata_device *dev = qc->dev;
1142 u64 dev_sectors = qc->dev->n_sectors;
1143 const u8 *cdb = scmd->cmnd;
1144 u64 block;
1145 u32 n_block;
1147 tf->flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
1148 tf->protocol = ATA_PROT_NODATA;
1150 if (cdb[0] == VERIFY) {
1151 if (scmd->cmd_len < 10)
1152 goto invalid_fld;
1153 scsi_10_lba_len(cdb, &block, &n_block);
1154 } else if (cdb[0] == VERIFY_16) {
1155 if (scmd->cmd_len < 16)
1156 goto invalid_fld;
1157 scsi_16_lba_len(cdb, &block, &n_block);
1158 } else
1159 goto invalid_fld;
1161 if (!n_block)
1162 goto nothing_to_do;
1163 if (block >= dev_sectors)
1164 goto out_of_range;
1165 if ((block + n_block) > dev_sectors)
1166 goto out_of_range;
1168 if (dev->flags & ATA_DFLAG_LBA) {
1169 tf->flags |= ATA_TFLAG_LBA;
1171 if (lba_28_ok(block, n_block)) {
1172 /* use LBA28 */
1173 tf->command = ATA_CMD_VERIFY;
1174 tf->device |= (block >> 24) & 0xf;
1175 } else if (lba_48_ok(block, n_block)) {
1176 if (!(dev->flags & ATA_DFLAG_LBA48))
1177 goto out_of_range;
1179 /* use LBA48 */
1180 tf->flags |= ATA_TFLAG_LBA48;
1181 tf->command = ATA_CMD_VERIFY_EXT;
1183 tf->hob_nsect = (n_block >> 8) & 0xff;
1185 tf->hob_lbah = (block >> 40) & 0xff;
1186 tf->hob_lbam = (block >> 32) & 0xff;
1187 tf->hob_lbal = (block >> 24) & 0xff;
1188 } else
1189 /* request too large even for LBA48 */
1190 goto out_of_range;
1192 tf->nsect = n_block & 0xff;
1194 tf->lbah = (block >> 16) & 0xff;
1195 tf->lbam = (block >> 8) & 0xff;
1196 tf->lbal = block & 0xff;
1198 tf->device |= ATA_LBA;
1199 } else {
1200 /* CHS */
1201 u32 sect, head, cyl, track;
1203 if (!lba_28_ok(block, n_block))
1204 goto out_of_range;
1206 /* Convert LBA to CHS */
1207 track = (u32)block / dev->sectors;
1208 cyl = track / dev->heads;
1209 head = track % dev->heads;
1210 sect = (u32)block % dev->sectors + 1;
1212 DPRINTK("block %u track %u cyl %u head %u sect %u\n",
1213 (u32)block, track, cyl, head, sect);
1215 /* Check whether the converted CHS can fit.
1216 Cylinder: 0-65535
1217 Head: 0-15
1218 Sector: 1-255*/
1219 if ((cyl >> 16) || (head >> 4) || (sect >> 8) || (!sect))
1220 goto out_of_range;
1222 tf->command = ATA_CMD_VERIFY;
1223 tf->nsect = n_block & 0xff; /* Sector count 0 means 256 sectors */
1224 tf->lbal = sect;
1225 tf->lbam = cyl;
1226 tf->lbah = cyl >> 8;
1227 tf->device |= head;
1230 return 0;
1232 invalid_fld:
1233 ata_scsi_set_sense(scmd, ILLEGAL_REQUEST, 0x24, 0x0);
1234 /* "Invalid field in cbd" */
1235 return 1;
1237 out_of_range:
1238 ata_scsi_set_sense(scmd, ILLEGAL_REQUEST, 0x21, 0x0);
1239 /* "Logical Block Address out of range" */
1240 return 1;
1242 nothing_to_do:
1243 scmd->result = SAM_STAT_GOOD;
1244 return 1;
1248 * ata_scsi_rw_xlat - Translate SCSI r/w command into an ATA one
1249 * @qc: Storage for translated ATA taskfile
1251 * Converts any of six SCSI read/write commands into the
1252 * ATA counterpart, including starting sector (LBA),
1253 * sector count, and taking into account the device's LBA48
1254 * support.
1256 * Commands %READ_6, %READ_10, %READ_16, %WRITE_6, %WRITE_10, and
1257 * %WRITE_16 are currently supported.
1259 * LOCKING:
1260 * spin_lock_irqsave(host lock)
1262 * RETURNS:
1263 * Zero on success, non-zero on error.
1265 static unsigned int ata_scsi_rw_xlat(struct ata_queued_cmd *qc)
1267 struct scsi_cmnd *scmd = qc->scsicmd;
1268 const u8 *cdb = scmd->cmnd;
1269 unsigned int tf_flags = 0;
1270 u64 block;
1271 u32 n_block;
1272 int rc;
1274 if (cdb[0] == WRITE_10 || cdb[0] == WRITE_6 || cdb[0] == WRITE_16)
1275 tf_flags |= ATA_TFLAG_WRITE;
1277 /* Calculate the SCSI LBA, transfer length and FUA. */
1278 switch (cdb[0]) {
1279 case READ_10:
1280 case WRITE_10:
1281 if (unlikely(scmd->cmd_len < 10))
1282 goto invalid_fld;
1283 scsi_10_lba_len(cdb, &block, &n_block);
1284 if (unlikely(cdb[1] & (1 << 3)))
1285 tf_flags |= ATA_TFLAG_FUA;
1286 break;
1287 case READ_6:
1288 case WRITE_6:
1289 if (unlikely(scmd->cmd_len < 6))
1290 goto invalid_fld;
1291 scsi_6_lba_len(cdb, &block, &n_block);
1293 /* for 6-byte r/w commands, transfer length 0
1294 * means 256 blocks of data, not 0 block.
1296 if (!n_block)
1297 n_block = 256;
1298 break;
1299 case READ_16:
1300 case WRITE_16:
1301 if (unlikely(scmd->cmd_len < 16))
1302 goto invalid_fld;
1303 scsi_16_lba_len(cdb, &block, &n_block);
1304 if (unlikely(cdb[1] & (1 << 3)))
1305 tf_flags |= ATA_TFLAG_FUA;
1306 break;
1307 default:
1308 DPRINTK("no-byte command\n");
1309 goto invalid_fld;
1312 /* Check and compose ATA command */
1313 if (!n_block)
1314 /* For 10-byte and 16-byte SCSI R/W commands, transfer
1315 * length 0 means transfer 0 block of data.
1316 * However, for ATA R/W commands, sector count 0 means
1317 * 256 or 65536 sectors, not 0 sectors as in SCSI.
1319 * WARNING: one or two older ATA drives treat 0 as 0...
1321 goto nothing_to_do;
1323 qc->flags |= ATA_QCFLAG_IO;
1324 qc->nbytes = n_block * ATA_SECT_SIZE;
1326 rc = ata_build_rw_tf(&qc->tf, qc->dev, block, n_block, tf_flags,
1327 qc->tag);
1328 if (likely(rc == 0))
1329 return 0;
1331 if (rc == -ERANGE)
1332 goto out_of_range;
1333 /* treat all other errors as -EINVAL, fall through */
1334 invalid_fld:
1335 ata_scsi_set_sense(scmd, ILLEGAL_REQUEST, 0x24, 0x0);
1336 /* "Invalid field in cbd" */
1337 return 1;
1339 out_of_range:
1340 ata_scsi_set_sense(scmd, ILLEGAL_REQUEST, 0x21, 0x0);
1341 /* "Logical Block Address out of range" */
1342 return 1;
1344 nothing_to_do:
1345 scmd->result = SAM_STAT_GOOD;
1346 return 1;
1349 static void ata_scsi_qc_complete(struct ata_queued_cmd *qc)
1351 struct ata_port *ap = qc->ap;
1352 struct scsi_cmnd *cmd = qc->scsicmd;
1353 u8 *cdb = cmd->cmnd;
1354 int need_sense = (qc->err_mask != 0);
1356 /* We snoop the SET_FEATURES - Write Cache ON/OFF command, and
1357 * schedule EH_REVALIDATE operation to update the IDENTIFY DEVICE
1358 * cache
1360 if (ap->ops->error_handler && !need_sense) {
1361 switch (qc->tf.command) {
1362 case ATA_CMD_SET_FEATURES:
1363 if ((qc->tf.feature == SETFEATURES_WC_ON) ||
1364 (qc->tf.feature == SETFEATURES_WC_OFF)) {
1365 ap->link.eh_info.action |= ATA_EH_REVALIDATE;
1366 ata_port_schedule_eh(ap);
1368 break;
1370 case ATA_CMD_INIT_DEV_PARAMS: /* CHS translation changed */
1371 case ATA_CMD_SET_MULTI: /* multi_count changed */
1372 ap->link.eh_info.action |= ATA_EH_REVALIDATE;
1373 ata_port_schedule_eh(ap);
1374 break;
1378 /* For ATA pass thru (SAT) commands, generate a sense block if
1379 * user mandated it or if there's an error. Note that if we
1380 * generate because the user forced us to, a check condition
1381 * is generated and the ATA register values are returned
1382 * whether the command completed successfully or not. If there
1383 * was no error, SK, ASC and ASCQ will all be zero.
1385 if (((cdb[0] == ATA_16) || (cdb[0] == ATA_12)) &&
1386 ((cdb[2] & 0x20) || need_sense)) {
1387 ata_gen_passthru_sense(qc);
1388 } else {
1389 if (!need_sense) {
1390 cmd->result = SAM_STAT_GOOD;
1391 } else {
1392 /* TODO: decide which descriptor format to use
1393 * for 48b LBA devices and call that here
1394 * instead of the fixed desc, which is only
1395 * good for smaller LBA (and maybe CHS?)
1396 * devices.
1398 ata_gen_ata_sense(qc);
1402 /* XXX: track spindown state for spindown skipping and warning */
1403 if (unlikely(qc->tf.command == ATA_CMD_STANDBY ||
1404 qc->tf.command == ATA_CMD_STANDBYNOW1))
1405 qc->dev->flags |= ATA_DFLAG_SPUNDOWN;
1406 else if (likely(system_state != SYSTEM_HALT &&
1407 system_state != SYSTEM_POWER_OFF))
1408 qc->dev->flags &= ~ATA_DFLAG_SPUNDOWN;
1410 if (need_sense && !ap->ops->error_handler)
1411 ata_dump_status(ap->print_id, &qc->result_tf);
1413 qc->scsidone(cmd);
1415 ata_qc_free(qc);
1419 * ata_scmd_need_defer - Check whether we need to defer scmd
1420 * @dev: ATA device to which the command is addressed
1421 * @is_io: Is the command IO (and thus possibly NCQ)?
1423 * NCQ and non-NCQ commands cannot run together. As upper layer
1424 * only knows the queue depth, we are responsible for maintaining
1425 * exclusion. This function checks whether a new command can be
1426 * issued to @dev.
1428 * LOCKING:
1429 * spin_lock_irqsave(host lock)
1431 * RETURNS:
1432 * 1 if deferring is needed, 0 otherwise.
1434 static int ata_scmd_need_defer(struct ata_device *dev, int is_io)
1436 struct ata_link *link = dev->link;
1437 int is_ncq = is_io && ata_ncq_enabled(dev);
1439 if (is_ncq) {
1440 if (!ata_tag_valid(link->active_tag))
1441 return 0;
1442 } else {
1443 if (!ata_tag_valid(link->active_tag) && !link->sactive)
1444 return 0;
1446 return 1;
1450 * ata_scsi_translate - Translate then issue SCSI command to ATA device
1451 * @dev: ATA device to which the command is addressed
1452 * @cmd: SCSI command to execute
1453 * @done: SCSI command completion function
1454 * @xlat_func: Actor which translates @cmd to an ATA taskfile
1456 * Our ->queuecommand() function has decided that the SCSI
1457 * command issued can be directly translated into an ATA
1458 * command, rather than handled internally.
1460 * This function sets up an ata_queued_cmd structure for the
1461 * SCSI command, and sends that ata_queued_cmd to the hardware.
1463 * The xlat_func argument (actor) returns 0 if ready to execute
1464 * ATA command, else 1 to finish translation. If 1 is returned
1465 * then cmd->result (and possibly cmd->sense_buffer) are assumed
1466 * to be set reflecting an error condition or clean (early)
1467 * termination.
1469 * LOCKING:
1470 * spin_lock_irqsave(host lock)
1472 * RETURNS:
1473 * 0 on success, SCSI_ML_QUEUE_DEVICE_BUSY if the command
1474 * needs to be deferred.
1476 static int ata_scsi_translate(struct ata_device *dev, struct scsi_cmnd *cmd,
1477 void (*done)(struct scsi_cmnd *),
1478 ata_xlat_func_t xlat_func)
1480 struct ata_queued_cmd *qc;
1481 int is_io = xlat_func == ata_scsi_rw_xlat;
1483 VPRINTK("ENTER\n");
1485 if (unlikely(ata_scmd_need_defer(dev, is_io)))
1486 goto defer;
1488 qc = ata_scsi_qc_new(dev, cmd, done);
1489 if (!qc)
1490 goto err_mem;
1492 /* data is present; dma-map it */
1493 if (cmd->sc_data_direction == DMA_FROM_DEVICE ||
1494 cmd->sc_data_direction == DMA_TO_DEVICE) {
1495 if (unlikely(scsi_bufflen(cmd) < 1)) {
1496 ata_dev_printk(dev, KERN_WARNING,
1497 "WARNING: zero len r/w req\n");
1498 goto err_did;
1501 ata_sg_init(qc, scsi_sglist(cmd), scsi_sg_count(cmd));
1503 qc->dma_dir = cmd->sc_data_direction;
1506 qc->complete_fn = ata_scsi_qc_complete;
1508 if (xlat_func(qc))
1509 goto early_finish;
1511 /* select device, send command to hardware */
1512 ata_qc_issue(qc);
1514 VPRINTK("EXIT\n");
1515 return 0;
1517 early_finish:
1518 ata_qc_free(qc);
1519 qc->scsidone(cmd);
1520 DPRINTK("EXIT - early finish (good or error)\n");
1521 return 0;
1523 err_did:
1524 ata_qc_free(qc);
1525 cmd->result = (DID_ERROR << 16);
1526 qc->scsidone(cmd);
1527 err_mem:
1528 DPRINTK("EXIT - internal\n");
1529 return 0;
1531 defer:
1532 DPRINTK("EXIT - defer\n");
1533 return SCSI_MLQUEUE_DEVICE_BUSY;
1537 * ata_scsi_rbuf_get - Map response buffer.
1538 * @cmd: SCSI command containing buffer to be mapped.
1539 * @buf_out: Pointer to mapped area.
1541 * Maps buffer contained within SCSI command @cmd.
1543 * LOCKING:
1544 * spin_lock_irqsave(host lock)
1546 * RETURNS:
1547 * Length of response buffer.
1550 static unsigned int ata_scsi_rbuf_get(struct scsi_cmnd *cmd, u8 **buf_out)
1552 u8 *buf;
1553 unsigned int buflen;
1555 struct scatterlist *sg = scsi_sglist(cmd);
1557 if (sg) {
1558 buf = kmap_atomic(sg->page, KM_IRQ0) + sg->offset;
1559 buflen = sg->length;
1560 } else {
1561 buf = NULL;
1562 buflen = 0;
1565 *buf_out = buf;
1566 return buflen;
1570 * ata_scsi_rbuf_put - Unmap response buffer.
1571 * @cmd: SCSI command containing buffer to be unmapped.
1572 * @buf: buffer to unmap
1574 * Unmaps response buffer contained within @cmd.
1576 * LOCKING:
1577 * spin_lock_irqsave(host lock)
1580 static inline void ata_scsi_rbuf_put(struct scsi_cmnd *cmd, u8 *buf)
1582 struct scatterlist *sg = scsi_sglist(cmd);
1583 if (sg)
1584 kunmap_atomic(buf - sg->offset, KM_IRQ0);
1588 * ata_scsi_rbuf_fill - wrapper for SCSI command simulators
1589 * @args: device IDENTIFY data / SCSI command of interest.
1590 * @actor: Callback hook for desired SCSI command simulator
1592 * Takes care of the hard work of simulating a SCSI command...
1593 * Mapping the response buffer, calling the command's handler,
1594 * and handling the handler's return value. This return value
1595 * indicates whether the handler wishes the SCSI command to be
1596 * completed successfully (0), or not (in which case cmd->result
1597 * and sense buffer are assumed to be set).
1599 * LOCKING:
1600 * spin_lock_irqsave(host lock)
1603 void ata_scsi_rbuf_fill(struct ata_scsi_args *args,
1604 unsigned int (*actor) (struct ata_scsi_args *args,
1605 u8 *rbuf, unsigned int buflen))
1607 u8 *rbuf;
1608 unsigned int buflen, rc;
1609 struct scsi_cmnd *cmd = args->cmd;
1611 buflen = ata_scsi_rbuf_get(cmd, &rbuf);
1612 memset(rbuf, 0, buflen);
1613 rc = actor(args, rbuf, buflen);
1614 ata_scsi_rbuf_put(cmd, rbuf);
1616 if (rc == 0)
1617 cmd->result = SAM_STAT_GOOD;
1618 args->done(cmd);
1622 * ATA_SCSI_RBUF_SET - helper to set values in SCSI response buffer
1623 * @idx: byte index into SCSI response buffer
1624 * @val: value to set
1626 * To be used by SCSI command simulator functions. This macros
1627 * expects two local variables, u8 *rbuf and unsigned int buflen,
1628 * are in scope.
1630 * LOCKING:
1631 * None.
1633 #define ATA_SCSI_RBUF_SET(idx, val) do { \
1634 if ((idx) < buflen) rbuf[(idx)] = (u8)(val); \
1635 } while (0)
1638 * ata_scsiop_inq_std - Simulate INQUIRY command
1639 * @args: device IDENTIFY data / SCSI command of interest.
1640 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1641 * @buflen: Response buffer length.
1643 * Returns standard device identification data associated
1644 * with non-VPD INQUIRY command output.
1646 * LOCKING:
1647 * spin_lock_irqsave(host lock)
1650 unsigned int ata_scsiop_inq_std(struct ata_scsi_args *args, u8 *rbuf,
1651 unsigned int buflen)
1653 u8 hdr[] = {
1654 TYPE_DISK,
1656 0x5, /* claim SPC-3 version compatibility */
1658 95 - 4
1661 /* set scsi removeable (RMB) bit per ata bit */
1662 if (ata_id_removeable(args->id))
1663 hdr[1] |= (1 << 7);
1665 VPRINTK("ENTER\n");
1667 memcpy(rbuf, hdr, sizeof(hdr));
1669 if (buflen > 35) {
1670 memcpy(&rbuf[8], "ATA ", 8);
1671 ata_id_string(args->id, &rbuf[16], ATA_ID_PROD, 16);
1672 ata_id_string(args->id, &rbuf[32], ATA_ID_FW_REV, 4);
1673 if (rbuf[32] == 0 || rbuf[32] == ' ')
1674 memcpy(&rbuf[32], "n/a ", 4);
1677 if (buflen > 63) {
1678 const u8 versions[] = {
1679 0x60, /* SAM-3 (no version claimed) */
1681 0x03,
1682 0x20, /* SBC-2 (no version claimed) */
1684 0x02,
1685 0x60 /* SPC-3 (no version claimed) */
1688 memcpy(rbuf + 59, versions, sizeof(versions));
1691 return 0;
1695 * ata_scsiop_inq_00 - Simulate INQUIRY VPD page 0, list of pages
1696 * @args: device IDENTIFY data / SCSI command of interest.
1697 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1698 * @buflen: Response buffer length.
1700 * Returns list of inquiry VPD pages available.
1702 * LOCKING:
1703 * spin_lock_irqsave(host lock)
1706 unsigned int ata_scsiop_inq_00(struct ata_scsi_args *args, u8 *rbuf,
1707 unsigned int buflen)
1709 const u8 pages[] = {
1710 0x00, /* page 0x00, this page */
1711 0x80, /* page 0x80, unit serial no page */
1712 0x83 /* page 0x83, device ident page */
1714 rbuf[3] = sizeof(pages); /* number of supported VPD pages */
1716 if (buflen > 6)
1717 memcpy(rbuf + 4, pages, sizeof(pages));
1719 return 0;
1723 * ata_scsiop_inq_80 - Simulate INQUIRY VPD page 80, device serial number
1724 * @args: device IDENTIFY data / SCSI command of interest.
1725 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1726 * @buflen: Response buffer length.
1728 * Returns ATA device serial number.
1730 * LOCKING:
1731 * spin_lock_irqsave(host lock)
1734 unsigned int ata_scsiop_inq_80(struct ata_scsi_args *args, u8 *rbuf,
1735 unsigned int buflen)
1737 const u8 hdr[] = {
1739 0x80, /* this page code */
1741 ATA_ID_SERNO_LEN, /* page len */
1743 memcpy(rbuf, hdr, sizeof(hdr));
1745 if (buflen > (ATA_ID_SERNO_LEN + 4 - 1))
1746 ata_id_string(args->id, (unsigned char *) &rbuf[4],
1747 ATA_ID_SERNO, ATA_ID_SERNO_LEN);
1749 return 0;
1753 * ata_scsiop_inq_83 - Simulate INQUIRY VPD page 83, device identity
1754 * @args: device IDENTIFY data / SCSI command of interest.
1755 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1756 * @buflen: Response buffer length.
1758 * Yields two logical unit device identification designators:
1759 * - vendor specific ASCII containing the ATA serial number
1760 * - SAT defined "t10 vendor id based" containing ASCII vendor
1761 * name ("ATA "), model and serial numbers.
1763 * LOCKING:
1764 * spin_lock_irqsave(host lock)
1767 unsigned int ata_scsiop_inq_83(struct ata_scsi_args *args, u8 *rbuf,
1768 unsigned int buflen)
1770 int num;
1771 const int sat_model_serial_desc_len = 68;
1773 rbuf[1] = 0x83; /* this page code */
1774 num = 4;
1776 if (buflen > (ATA_ID_SERNO_LEN + num + 3)) {
1777 /* piv=0, assoc=lu, code_set=ACSII, designator=vendor */
1778 rbuf[num + 0] = 2;
1779 rbuf[num + 3] = ATA_ID_SERNO_LEN;
1780 num += 4;
1781 ata_id_string(args->id, (unsigned char *) rbuf + num,
1782 ATA_ID_SERNO, ATA_ID_SERNO_LEN);
1783 num += ATA_ID_SERNO_LEN;
1785 if (buflen > (sat_model_serial_desc_len + num + 3)) {
1786 /* SAT defined lu model and serial numbers descriptor */
1787 /* piv=0, assoc=lu, code_set=ACSII, designator=t10 vendor id */
1788 rbuf[num + 0] = 2;
1789 rbuf[num + 1] = 1;
1790 rbuf[num + 3] = sat_model_serial_desc_len;
1791 num += 4;
1792 memcpy(rbuf + num, "ATA ", 8);
1793 num += 8;
1794 ata_id_string(args->id, (unsigned char *) rbuf + num,
1795 ATA_ID_PROD, ATA_ID_PROD_LEN);
1796 num += ATA_ID_PROD_LEN;
1797 ata_id_string(args->id, (unsigned char *) rbuf + num,
1798 ATA_ID_SERNO, ATA_ID_SERNO_LEN);
1799 num += ATA_ID_SERNO_LEN;
1801 rbuf[3] = num - 4; /* page len (assume less than 256 bytes) */
1802 return 0;
1806 * ata_scsiop_inq_89 - Simulate INQUIRY VPD page 89, ATA info
1807 * @args: device IDENTIFY data / SCSI command of interest.
1808 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1809 * @buflen: Response buffer length.
1811 * Yields SAT-specified ATA VPD page.
1813 * LOCKING:
1814 * spin_lock_irqsave(host lock)
1817 unsigned int ata_scsiop_inq_89(struct ata_scsi_args *args, u8 *rbuf,
1818 unsigned int buflen)
1820 u8 pbuf[60];
1821 struct ata_taskfile tf;
1822 unsigned int i;
1824 if (!buflen)
1825 return 0;
1827 memset(&pbuf, 0, sizeof(pbuf));
1828 memset(&tf, 0, sizeof(tf));
1830 pbuf[1] = 0x89; /* our page code */
1831 pbuf[2] = (0x238 >> 8); /* page size fixed at 238h */
1832 pbuf[3] = (0x238 & 0xff);
1834 memcpy(&pbuf[8], "linux ", 8);
1835 memcpy(&pbuf[16], "libata ", 16);
1836 memcpy(&pbuf[32], DRV_VERSION, 4);
1837 ata_id_string(args->id, &pbuf[32], ATA_ID_FW_REV, 4);
1839 /* we don't store the ATA device signature, so we fake it */
1841 tf.command = ATA_DRDY; /* really, this is Status reg */
1842 tf.lbal = 0x1;
1843 tf.nsect = 0x1;
1845 ata_tf_to_fis(&tf, 0, 1, &pbuf[36]); /* TODO: PMP? */
1846 pbuf[36] = 0x34; /* force D2H Reg FIS (34h) */
1848 pbuf[56] = ATA_CMD_ID_ATA;
1850 i = min(buflen, 60U);
1851 memcpy(rbuf, &pbuf[0], i);
1852 buflen -= i;
1854 if (!buflen)
1855 return 0;
1857 memcpy(&rbuf[60], &args->id[0], min(buflen, 512U));
1858 return 0;
1862 * ata_scsiop_noop - Command handler that simply returns success.
1863 * @args: device IDENTIFY data / SCSI command of interest.
1864 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1865 * @buflen: Response buffer length.
1867 * No operation. Simply returns success to caller, to indicate
1868 * that the caller should successfully complete this SCSI command.
1870 * LOCKING:
1871 * spin_lock_irqsave(host lock)
1874 unsigned int ata_scsiop_noop(struct ata_scsi_args *args, u8 *rbuf,
1875 unsigned int buflen)
1877 VPRINTK("ENTER\n");
1878 return 0;
1882 * ata_msense_push - Push data onto MODE SENSE data output buffer
1883 * @ptr_io: (input/output) Location to store more output data
1884 * @last: End of output data buffer
1885 * @buf: Pointer to BLOB being added to output buffer
1886 * @buflen: Length of BLOB
1888 * Store MODE SENSE data on an output buffer.
1890 * LOCKING:
1891 * None.
1894 static void ata_msense_push(u8 **ptr_io, const u8 *last,
1895 const u8 *buf, unsigned int buflen)
1897 u8 *ptr = *ptr_io;
1899 if ((ptr + buflen - 1) > last)
1900 return;
1902 memcpy(ptr, buf, buflen);
1904 ptr += buflen;
1906 *ptr_io = ptr;
1910 * ata_msense_caching - Simulate MODE SENSE caching info page
1911 * @id: device IDENTIFY data
1912 * @ptr_io: (input/output) Location to store more output data
1913 * @last: End of output data buffer
1915 * Generate a caching info page, which conditionally indicates
1916 * write caching to the SCSI layer, depending on device
1917 * capabilities.
1919 * LOCKING:
1920 * None.
1923 static unsigned int ata_msense_caching(u16 *id, u8 **ptr_io,
1924 const u8 *last)
1926 u8 page[CACHE_MPAGE_LEN];
1928 memcpy(page, def_cache_mpage, sizeof(page));
1929 if (ata_id_wcache_enabled(id))
1930 page[2] |= (1 << 2); /* write cache enable */
1931 if (!ata_id_rahead_enabled(id))
1932 page[12] |= (1 << 5); /* disable read ahead */
1934 ata_msense_push(ptr_io, last, page, sizeof(page));
1935 return sizeof(page);
1939 * ata_msense_ctl_mode - Simulate MODE SENSE control mode page
1940 * @dev: Device associated with this MODE SENSE command
1941 * @ptr_io: (input/output) Location to store more output data
1942 * @last: End of output data buffer
1944 * Generate a generic MODE SENSE control mode page.
1946 * LOCKING:
1947 * None.
1950 static unsigned int ata_msense_ctl_mode(u8 **ptr_io, const u8 *last)
1952 ata_msense_push(ptr_io, last, def_control_mpage,
1953 sizeof(def_control_mpage));
1954 return sizeof(def_control_mpage);
1958 * ata_msense_rw_recovery - Simulate MODE SENSE r/w error recovery page
1959 * @dev: Device associated with this MODE SENSE command
1960 * @ptr_io: (input/output) Location to store more output data
1961 * @last: End of output data buffer
1963 * Generate a generic MODE SENSE r/w error recovery page.
1965 * LOCKING:
1966 * None.
1969 static unsigned int ata_msense_rw_recovery(u8 **ptr_io, const u8 *last)
1972 ata_msense_push(ptr_io, last, def_rw_recovery_mpage,
1973 sizeof(def_rw_recovery_mpage));
1974 return sizeof(def_rw_recovery_mpage);
1978 * We can turn this into a real blacklist if it's needed, for now just
1979 * blacklist any Maxtor BANC1G10 revision firmware
1981 static int ata_dev_supports_fua(u16 *id)
1983 unsigned char model[ATA_ID_PROD_LEN + 1], fw[ATA_ID_FW_REV_LEN + 1];
1985 if (!libata_fua)
1986 return 0;
1987 if (!ata_id_has_fua(id))
1988 return 0;
1990 ata_id_c_string(id, model, ATA_ID_PROD, sizeof(model));
1991 ata_id_c_string(id, fw, ATA_ID_FW_REV, sizeof(fw));
1993 if (strcmp(model, "Maxtor"))
1994 return 1;
1995 if (strcmp(fw, "BANC1G10"))
1996 return 1;
1998 return 0; /* blacklisted */
2002 * ata_scsiop_mode_sense - Simulate MODE SENSE 6, 10 commands
2003 * @args: device IDENTIFY data / SCSI command of interest.
2004 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2005 * @buflen: Response buffer length.
2007 * Simulate MODE SENSE commands. Assume this is invoked for direct
2008 * access devices (e.g. disks) only. There should be no block
2009 * descriptor for other device types.
2011 * LOCKING:
2012 * spin_lock_irqsave(host lock)
2015 unsigned int ata_scsiop_mode_sense(struct ata_scsi_args *args, u8 *rbuf,
2016 unsigned int buflen)
2018 struct ata_device *dev = args->dev;
2019 u8 *scsicmd = args->cmd->cmnd, *p, *last;
2020 const u8 sat_blk_desc[] = {
2021 0, 0, 0, 0, /* number of blocks: sat unspecified */
2023 0, 0x2, 0x0 /* block length: 512 bytes */
2025 u8 pg, spg;
2026 unsigned int ebd, page_control, six_byte, output_len, alloc_len, minlen;
2027 u8 dpofua;
2029 VPRINTK("ENTER\n");
2031 six_byte = (scsicmd[0] == MODE_SENSE);
2032 ebd = !(scsicmd[1] & 0x8); /* dbd bit inverted == edb */
2034 * LLBA bit in msense(10) ignored (compliant)
2037 page_control = scsicmd[2] >> 6;
2038 switch (page_control) {
2039 case 0: /* current */
2040 break; /* supported */
2041 case 3: /* saved */
2042 goto saving_not_supp;
2043 case 1: /* changeable */
2044 case 2: /* defaults */
2045 default:
2046 goto invalid_fld;
2049 if (six_byte) {
2050 output_len = 4 + (ebd ? 8 : 0);
2051 alloc_len = scsicmd[4];
2052 } else {
2053 output_len = 8 + (ebd ? 8 : 0);
2054 alloc_len = (scsicmd[7] << 8) + scsicmd[8];
2056 minlen = (alloc_len < buflen) ? alloc_len : buflen;
2058 p = rbuf + output_len;
2059 last = rbuf + minlen - 1;
2061 pg = scsicmd[2] & 0x3f;
2062 spg = scsicmd[3];
2064 * No mode subpages supported (yet) but asking for _all_
2065 * subpages may be valid
2067 if (spg && (spg != ALL_SUB_MPAGES))
2068 goto invalid_fld;
2070 switch(pg) {
2071 case RW_RECOVERY_MPAGE:
2072 output_len += ata_msense_rw_recovery(&p, last);
2073 break;
2075 case CACHE_MPAGE:
2076 output_len += ata_msense_caching(args->id, &p, last);
2077 break;
2079 case CONTROL_MPAGE: {
2080 output_len += ata_msense_ctl_mode(&p, last);
2081 break;
2084 case ALL_MPAGES:
2085 output_len += ata_msense_rw_recovery(&p, last);
2086 output_len += ata_msense_caching(args->id, &p, last);
2087 output_len += ata_msense_ctl_mode(&p, last);
2088 break;
2090 default: /* invalid page code */
2091 goto invalid_fld;
2094 if (minlen < 1)
2095 return 0;
2097 dpofua = 0;
2098 if (ata_dev_supports_fua(args->id) && (dev->flags & ATA_DFLAG_LBA48) &&
2099 (!(dev->flags & ATA_DFLAG_PIO) || dev->multi_count))
2100 dpofua = 1 << 4;
2102 if (six_byte) {
2103 output_len--;
2104 rbuf[0] = output_len;
2105 if (minlen > 2)
2106 rbuf[2] |= dpofua;
2107 if (ebd) {
2108 if (minlen > 3)
2109 rbuf[3] = sizeof(sat_blk_desc);
2110 if (minlen > 11)
2111 memcpy(rbuf + 4, sat_blk_desc,
2112 sizeof(sat_blk_desc));
2114 } else {
2115 output_len -= 2;
2116 rbuf[0] = output_len >> 8;
2117 if (minlen > 1)
2118 rbuf[1] = output_len;
2119 if (minlen > 3)
2120 rbuf[3] |= dpofua;
2121 if (ebd) {
2122 if (minlen > 7)
2123 rbuf[7] = sizeof(sat_blk_desc);
2124 if (minlen > 15)
2125 memcpy(rbuf + 8, sat_blk_desc,
2126 sizeof(sat_blk_desc));
2129 return 0;
2131 invalid_fld:
2132 ata_scsi_set_sense(args->cmd, ILLEGAL_REQUEST, 0x24, 0x0);
2133 /* "Invalid field in cbd" */
2134 return 1;
2136 saving_not_supp:
2137 ata_scsi_set_sense(args->cmd, ILLEGAL_REQUEST, 0x39, 0x0);
2138 /* "Saving parameters not supported" */
2139 return 1;
2143 * ata_scsiop_read_cap - Simulate READ CAPACITY[ 16] commands
2144 * @args: device IDENTIFY data / SCSI command of interest.
2145 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2146 * @buflen: Response buffer length.
2148 * Simulate READ CAPACITY commands.
2150 * LOCKING:
2151 * None.
2153 unsigned int ata_scsiop_read_cap(struct ata_scsi_args *args, u8 *rbuf,
2154 unsigned int buflen)
2156 u64 last_lba = args->dev->n_sectors - 1; /* LBA of the last block */
2158 VPRINTK("ENTER\n");
2160 if (args->cmd->cmnd[0] == READ_CAPACITY) {
2161 if (last_lba >= 0xffffffffULL)
2162 last_lba = 0xffffffff;
2164 /* sector count, 32-bit */
2165 ATA_SCSI_RBUF_SET(0, last_lba >> (8 * 3));
2166 ATA_SCSI_RBUF_SET(1, last_lba >> (8 * 2));
2167 ATA_SCSI_RBUF_SET(2, last_lba >> (8 * 1));
2168 ATA_SCSI_RBUF_SET(3, last_lba);
2170 /* sector size */
2171 ATA_SCSI_RBUF_SET(6, ATA_SECT_SIZE >> 8);
2172 ATA_SCSI_RBUF_SET(7, ATA_SECT_SIZE);
2173 } else {
2174 /* sector count, 64-bit */
2175 ATA_SCSI_RBUF_SET(0, last_lba >> (8 * 7));
2176 ATA_SCSI_RBUF_SET(1, last_lba >> (8 * 6));
2177 ATA_SCSI_RBUF_SET(2, last_lba >> (8 * 5));
2178 ATA_SCSI_RBUF_SET(3, last_lba >> (8 * 4));
2179 ATA_SCSI_RBUF_SET(4, last_lba >> (8 * 3));
2180 ATA_SCSI_RBUF_SET(5, last_lba >> (8 * 2));
2181 ATA_SCSI_RBUF_SET(6, last_lba >> (8 * 1));
2182 ATA_SCSI_RBUF_SET(7, last_lba);
2184 /* sector size */
2185 ATA_SCSI_RBUF_SET(10, ATA_SECT_SIZE >> 8);
2186 ATA_SCSI_RBUF_SET(11, ATA_SECT_SIZE);
2189 return 0;
2193 * ata_scsiop_report_luns - Simulate REPORT LUNS command
2194 * @args: device IDENTIFY data / SCSI command of interest.
2195 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2196 * @buflen: Response buffer length.
2198 * Simulate REPORT LUNS command.
2200 * LOCKING:
2201 * spin_lock_irqsave(host lock)
2204 unsigned int ata_scsiop_report_luns(struct ata_scsi_args *args, u8 *rbuf,
2205 unsigned int buflen)
2207 VPRINTK("ENTER\n");
2208 rbuf[3] = 8; /* just one lun, LUN 0, size 8 bytes */
2210 return 0;
2214 * ata_scsi_set_sense - Set SCSI sense data and status
2215 * @cmd: SCSI request to be handled
2216 * @sk: SCSI-defined sense key
2217 * @asc: SCSI-defined additional sense code
2218 * @ascq: SCSI-defined additional sense code qualifier
2220 * Helper function that builds a valid fixed format, current
2221 * response code and the given sense key (sk), additional sense
2222 * code (asc) and additional sense code qualifier (ascq) with
2223 * a SCSI command status of %SAM_STAT_CHECK_CONDITION and
2224 * DRIVER_SENSE set in the upper bits of scsi_cmnd::result .
2226 * LOCKING:
2227 * Not required
2230 void ata_scsi_set_sense(struct scsi_cmnd *cmd, u8 sk, u8 asc, u8 ascq)
2232 cmd->result = (DRIVER_SENSE << 24) | SAM_STAT_CHECK_CONDITION;
2234 cmd->sense_buffer[0] = 0x70; /* fixed format, current */
2235 cmd->sense_buffer[2] = sk;
2236 cmd->sense_buffer[7] = 18 - 8; /* additional sense length */
2237 cmd->sense_buffer[12] = asc;
2238 cmd->sense_buffer[13] = ascq;
2242 * ata_scsi_badcmd - End a SCSI request with an error
2243 * @cmd: SCSI request to be handled
2244 * @done: SCSI command completion function
2245 * @asc: SCSI-defined additional sense code
2246 * @ascq: SCSI-defined additional sense code qualifier
2248 * Helper function that completes a SCSI command with
2249 * %SAM_STAT_CHECK_CONDITION, with a sense key %ILLEGAL_REQUEST
2250 * and the specified additional sense codes.
2252 * LOCKING:
2253 * spin_lock_irqsave(host lock)
2256 void ata_scsi_badcmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *), u8 asc, u8 ascq)
2258 DPRINTK("ENTER\n");
2259 ata_scsi_set_sense(cmd, ILLEGAL_REQUEST, asc, ascq);
2261 done(cmd);
2264 static void atapi_sense_complete(struct ata_queued_cmd *qc)
2266 if (qc->err_mask && ((qc->err_mask & AC_ERR_DEV) == 0)) {
2267 /* FIXME: not quite right; we don't want the
2268 * translation of taskfile registers into
2269 * a sense descriptors, since that's only
2270 * correct for ATA, not ATAPI
2272 ata_gen_passthru_sense(qc);
2275 qc->scsidone(qc->scsicmd);
2276 ata_qc_free(qc);
2279 /* is it pointless to prefer PIO for "safety reasons"? */
2280 static inline int ata_pio_use_silly(struct ata_port *ap)
2282 return (ap->flags & ATA_FLAG_PIO_DMA);
2285 static void atapi_request_sense(struct ata_queued_cmd *qc)
2287 struct ata_port *ap = qc->ap;
2288 struct scsi_cmnd *cmd = qc->scsicmd;
2290 DPRINTK("ATAPI request sense\n");
2292 /* FIXME: is this needed? */
2293 memset(cmd->sense_buffer, 0, sizeof(cmd->sense_buffer));
2295 ap->ops->tf_read(ap, &qc->tf);
2297 /* fill these in, for the case where they are -not- overwritten */
2298 cmd->sense_buffer[0] = 0x70;
2299 cmd->sense_buffer[2] = qc->tf.feature >> 4;
2301 ata_qc_reinit(qc);
2303 ata_sg_init_one(qc, cmd->sense_buffer, sizeof(cmd->sense_buffer));
2304 qc->dma_dir = DMA_FROM_DEVICE;
2306 memset(&qc->cdb, 0, qc->dev->cdb_len);
2307 qc->cdb[0] = REQUEST_SENSE;
2308 qc->cdb[4] = SCSI_SENSE_BUFFERSIZE;
2310 qc->tf.flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
2311 qc->tf.command = ATA_CMD_PACKET;
2313 if (ata_pio_use_silly(ap)) {
2314 qc->tf.protocol = ATA_PROT_ATAPI_DMA;
2315 qc->tf.feature |= ATAPI_PKT_DMA;
2316 } else {
2317 qc->tf.protocol = ATA_PROT_ATAPI;
2318 qc->tf.lbam = (8 * 1024) & 0xff;
2319 qc->tf.lbah = (8 * 1024) >> 8;
2321 qc->nbytes = SCSI_SENSE_BUFFERSIZE;
2323 qc->complete_fn = atapi_sense_complete;
2325 ata_qc_issue(qc);
2327 DPRINTK("EXIT\n");
2330 static void atapi_qc_complete(struct ata_queued_cmd *qc)
2332 struct scsi_cmnd *cmd = qc->scsicmd;
2333 unsigned int err_mask = qc->err_mask;
2335 VPRINTK("ENTER, err_mask 0x%X\n", err_mask);
2337 /* handle completion from new EH */
2338 if (unlikely(qc->ap->ops->error_handler &&
2339 (err_mask || qc->flags & ATA_QCFLAG_SENSE_VALID))) {
2341 if (!(qc->flags & ATA_QCFLAG_SENSE_VALID)) {
2342 /* FIXME: not quite right; we don't want the
2343 * translation of taskfile registers into a
2344 * sense descriptors, since that's only
2345 * correct for ATA, not ATAPI
2347 ata_gen_passthru_sense(qc);
2350 /* SCSI EH automatically locks door if sdev->locked is
2351 * set. Sometimes door lock request continues to
2352 * fail, for example, when no media is present. This
2353 * creates a loop - SCSI EH issues door lock which
2354 * fails and gets invoked again to acquire sense data
2355 * for the failed command.
2357 * If door lock fails, always clear sdev->locked to
2358 * avoid this infinite loop.
2360 if (qc->cdb[0] == ALLOW_MEDIUM_REMOVAL)
2361 qc->dev->sdev->locked = 0;
2363 qc->scsicmd->result = SAM_STAT_CHECK_CONDITION;
2364 qc->scsidone(cmd);
2365 ata_qc_free(qc);
2366 return;
2369 /* successful completion or old EH failure path */
2370 if (unlikely(err_mask & AC_ERR_DEV)) {
2371 cmd->result = SAM_STAT_CHECK_CONDITION;
2372 atapi_request_sense(qc);
2373 return;
2374 } else if (unlikely(err_mask)) {
2375 /* FIXME: not quite right; we don't want the
2376 * translation of taskfile registers into
2377 * a sense descriptors, since that's only
2378 * correct for ATA, not ATAPI
2380 ata_gen_passthru_sense(qc);
2381 } else {
2382 u8 *scsicmd = cmd->cmnd;
2384 if ((scsicmd[0] == INQUIRY) && ((scsicmd[1] & 0x03) == 0)) {
2385 u8 *buf = NULL;
2386 unsigned int buflen;
2388 buflen = ata_scsi_rbuf_get(cmd, &buf);
2390 /* ATAPI devices typically report zero for their SCSI version,
2391 * and sometimes deviate from the spec WRT response data
2392 * format. If SCSI version is reported as zero like normal,
2393 * then we make the following fixups: 1) Fake MMC-5 version,
2394 * to indicate to the Linux scsi midlayer this is a modern
2395 * device. 2) Ensure response data format / ATAPI information
2396 * are always correct.
2398 if (buf[2] == 0) {
2399 buf[2] = 0x5;
2400 buf[3] = 0x32;
2403 ata_scsi_rbuf_put(cmd, buf);
2406 cmd->result = SAM_STAT_GOOD;
2409 qc->scsidone(cmd);
2410 ata_qc_free(qc);
2413 * atapi_xlat - Initialize PACKET taskfile
2414 * @qc: command structure to be initialized
2416 * LOCKING:
2417 * spin_lock_irqsave(host lock)
2419 * RETURNS:
2420 * Zero on success, non-zero on failure.
2422 static unsigned int atapi_xlat(struct ata_queued_cmd *qc)
2424 struct scsi_cmnd *scmd = qc->scsicmd;
2425 struct ata_device *dev = qc->dev;
2426 int using_pio = (dev->flags & ATA_DFLAG_PIO);
2427 int nodata = (scmd->sc_data_direction == DMA_NONE);
2429 memset(qc->cdb, 0, dev->cdb_len);
2430 memcpy(qc->cdb, scmd->cmnd, scmd->cmd_len);
2432 qc->complete_fn = atapi_qc_complete;
2434 qc->tf.flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
2435 if (scmd->sc_data_direction == DMA_TO_DEVICE) {
2436 qc->tf.flags |= ATA_TFLAG_WRITE;
2437 DPRINTK("direction: write\n");
2440 qc->tf.command = ATA_CMD_PACKET;
2441 qc->nbytes = scsi_bufflen(scmd);
2443 /* check whether ATAPI DMA is safe */
2444 if (!using_pio && ata_check_atapi_dma(qc))
2445 using_pio = 1;
2447 if (using_pio || nodata) {
2448 /* no data, or PIO data xfer */
2449 if (nodata)
2450 qc->tf.protocol = ATA_PROT_ATAPI_NODATA;
2451 else
2452 qc->tf.protocol = ATA_PROT_ATAPI;
2453 qc->tf.lbam = (8 * 1024) & 0xff;
2454 qc->tf.lbah = (8 * 1024) >> 8;
2455 } else {
2456 /* DMA data xfer */
2457 qc->tf.protocol = ATA_PROT_ATAPI_DMA;
2458 qc->tf.feature |= ATAPI_PKT_DMA;
2460 if (atapi_dmadir && (scmd->sc_data_direction != DMA_TO_DEVICE))
2461 /* some SATA bridges need us to indicate data xfer direction */
2462 qc->tf.feature |= ATAPI_DMADIR;
2465 return 0;
2468 static struct ata_device * ata_find_dev(struct ata_port *ap, int devno)
2470 if (ap->nr_pmp_links == 0) {
2471 if (likely(devno < ata_link_max_devices(&ap->link)))
2472 return &ap->link.device[devno];
2473 } else {
2474 if (likely(devno < ap->nr_pmp_links))
2475 return &ap->pmp_link[devno].device[0];
2478 return NULL;
2481 static struct ata_device * __ata_scsi_find_dev(struct ata_port *ap,
2482 const struct scsi_device *scsidev)
2484 int devno;
2486 /* skip commands not addressed to targets we simulate */
2487 if (ap->nr_pmp_links == 0) {
2488 if (unlikely(scsidev->channel || scsidev->lun))
2489 return NULL;
2490 devno = scsidev->id;
2491 } else {
2492 if (unlikely(scsidev->id || scsidev->lun))
2493 return NULL;
2494 devno = scsidev->channel;
2497 return ata_find_dev(ap, devno);
2501 * ata_scsi_dev_enabled - determine if device is enabled
2502 * @dev: ATA device
2504 * Determine if commands should be sent to the specified device.
2506 * LOCKING:
2507 * spin_lock_irqsave(host lock)
2509 * RETURNS:
2510 * 0 if commands are not allowed / 1 if commands are allowed
2513 static int ata_scsi_dev_enabled(struct ata_device *dev)
2515 if (unlikely(!ata_dev_enabled(dev)))
2516 return 0;
2518 if (!atapi_enabled || (dev->link->ap->flags & ATA_FLAG_NO_ATAPI)) {
2519 if (unlikely(dev->class == ATA_DEV_ATAPI)) {
2520 ata_dev_printk(dev, KERN_WARNING,
2521 "WARNING: ATAPI is %s, device ignored.\n",
2522 atapi_enabled ? "not supported with this driver" : "disabled");
2523 return 0;
2527 return 1;
2531 * ata_scsi_find_dev - lookup ata_device from scsi_cmnd
2532 * @ap: ATA port to which the device is attached
2533 * @scsidev: SCSI device from which we derive the ATA device
2535 * Given various information provided in struct scsi_cmnd,
2536 * map that onto an ATA bus, and using that mapping
2537 * determine which ata_device is associated with the
2538 * SCSI command to be sent.
2540 * LOCKING:
2541 * spin_lock_irqsave(host lock)
2543 * RETURNS:
2544 * Associated ATA device, or %NULL if not found.
2546 static struct ata_device *
2547 ata_scsi_find_dev(struct ata_port *ap, const struct scsi_device *scsidev)
2549 struct ata_device *dev = __ata_scsi_find_dev(ap, scsidev);
2551 if (unlikely(!dev || !ata_scsi_dev_enabled(dev)))
2552 return NULL;
2554 return dev;
2558 * ata_scsi_map_proto - Map pass-thru protocol value to taskfile value.
2559 * @byte1: Byte 1 from pass-thru CDB.
2561 * RETURNS:
2562 * ATA_PROT_UNKNOWN if mapping failed/unimplemented, protocol otherwise.
2564 static u8
2565 ata_scsi_map_proto(u8 byte1)
2567 switch((byte1 & 0x1e) >> 1) {
2568 case 3: /* Non-data */
2569 return ATA_PROT_NODATA;
2571 case 6: /* DMA */
2572 case 10: /* UDMA Data-in */
2573 case 11: /* UDMA Data-Out */
2574 return ATA_PROT_DMA;
2576 case 4: /* PIO Data-in */
2577 case 5: /* PIO Data-out */
2578 return ATA_PROT_PIO;
2580 case 0: /* Hard Reset */
2581 case 1: /* SRST */
2582 case 8: /* Device Diagnostic */
2583 case 9: /* Device Reset */
2584 case 7: /* DMA Queued */
2585 case 12: /* FPDMA */
2586 case 15: /* Return Response Info */
2587 default: /* Reserved */
2588 break;
2591 return ATA_PROT_UNKNOWN;
2595 * ata_scsi_pass_thru - convert ATA pass-thru CDB to taskfile
2596 * @qc: command structure to be initialized
2598 * Handles either 12 or 16-byte versions of the CDB.
2600 * RETURNS:
2601 * Zero on success, non-zero on failure.
2603 static unsigned int ata_scsi_pass_thru(struct ata_queued_cmd *qc)
2605 struct ata_taskfile *tf = &(qc->tf);
2606 struct scsi_cmnd *scmd = qc->scsicmd;
2607 struct ata_device *dev = qc->dev;
2608 const u8 *cdb = scmd->cmnd;
2610 if ((tf->protocol = ata_scsi_map_proto(cdb[1])) == ATA_PROT_UNKNOWN)
2611 goto invalid_fld;
2613 /* We may not issue DMA commands if no DMA mode is set */
2614 if (tf->protocol == ATA_PROT_DMA && dev->dma_mode == 0)
2615 goto invalid_fld;
2618 * 12 and 16 byte CDBs use different offsets to
2619 * provide the various register values.
2621 if (cdb[0] == ATA_16) {
2623 * 16-byte CDB - may contain extended commands.
2625 * If that is the case, copy the upper byte register values.
2627 if (cdb[1] & 0x01) {
2628 tf->hob_feature = cdb[3];
2629 tf->hob_nsect = cdb[5];
2630 tf->hob_lbal = cdb[7];
2631 tf->hob_lbam = cdb[9];
2632 tf->hob_lbah = cdb[11];
2633 tf->flags |= ATA_TFLAG_LBA48;
2634 } else
2635 tf->flags &= ~ATA_TFLAG_LBA48;
2638 * Always copy low byte, device and command registers.
2640 tf->feature = cdb[4];
2641 tf->nsect = cdb[6];
2642 tf->lbal = cdb[8];
2643 tf->lbam = cdb[10];
2644 tf->lbah = cdb[12];
2645 tf->device = cdb[13];
2646 tf->command = cdb[14];
2647 } else {
2649 * 12-byte CDB - incapable of extended commands.
2651 tf->flags &= ~ATA_TFLAG_LBA48;
2653 tf->feature = cdb[3];
2654 tf->nsect = cdb[4];
2655 tf->lbal = cdb[5];
2656 tf->lbam = cdb[6];
2657 tf->lbah = cdb[7];
2658 tf->device = cdb[8];
2659 tf->command = cdb[9];
2662 /* enforce correct master/slave bit */
2663 tf->device = dev->devno ?
2664 tf->device | ATA_DEV1 : tf->device & ~ATA_DEV1;
2666 /* sanity check for pio multi commands */
2667 if ((cdb[1] & 0xe0) && !is_multi_taskfile(tf))
2668 goto invalid_fld;
2670 if (is_multi_taskfile(tf)) {
2671 unsigned int multi_count = 1 << (cdb[1] >> 5);
2673 /* compare the passed through multi_count
2674 * with the cached multi_count of libata
2676 if (multi_count != dev->multi_count)
2677 ata_dev_printk(dev, KERN_WARNING,
2678 "invalid multi_count %u ignored\n",
2679 multi_count);
2682 /* READ/WRITE LONG use a non-standard sect_size */
2683 qc->sect_size = ATA_SECT_SIZE;
2684 switch (tf->command) {
2685 case ATA_CMD_READ_LONG:
2686 case ATA_CMD_READ_LONG_ONCE:
2687 case ATA_CMD_WRITE_LONG:
2688 case ATA_CMD_WRITE_LONG_ONCE:
2689 if (tf->protocol != ATA_PROT_PIO || tf->nsect != 1)
2690 goto invalid_fld;
2691 qc->sect_size = scsi_bufflen(scmd);
2695 * Filter SET_FEATURES - XFER MODE command -- otherwise,
2696 * SET_FEATURES - XFER MODE must be preceded/succeeded
2697 * by an update to hardware-specific registers for each
2698 * controller (i.e. the reason for ->set_piomode(),
2699 * ->set_dmamode(), and ->post_set_mode() hooks).
2701 if ((tf->command == ATA_CMD_SET_FEATURES)
2702 && (tf->feature == SETFEATURES_XFER))
2703 goto invalid_fld;
2706 * Set flags so that all registers will be written,
2707 * and pass on write indication (used for PIO/DMA
2708 * setup.)
2710 tf->flags |= (ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE);
2712 if (scmd->sc_data_direction == DMA_TO_DEVICE)
2713 tf->flags |= ATA_TFLAG_WRITE;
2716 * Set transfer length.
2718 * TODO: find out if we need to do more here to
2719 * cover scatter/gather case.
2721 qc->nbytes = scsi_bufflen(scmd);
2723 /* request result TF */
2724 qc->flags |= ATA_QCFLAG_RESULT_TF;
2726 return 0;
2728 invalid_fld:
2729 ata_scsi_set_sense(scmd, ILLEGAL_REQUEST, 0x24, 0x00);
2730 /* "Invalid field in cdb" */
2731 return 1;
2735 * ata_get_xlat_func - check if SCSI to ATA translation is possible
2736 * @dev: ATA device
2737 * @cmd: SCSI command opcode to consider
2739 * Look up the SCSI command given, and determine whether the
2740 * SCSI command is to be translated or simulated.
2742 * RETURNS:
2743 * Pointer to translation function if possible, %NULL if not.
2746 static inline ata_xlat_func_t ata_get_xlat_func(struct ata_device *dev, u8 cmd)
2748 switch (cmd) {
2749 case READ_6:
2750 case READ_10:
2751 case READ_16:
2753 case WRITE_6:
2754 case WRITE_10:
2755 case WRITE_16:
2756 return ata_scsi_rw_xlat;
2758 case SYNCHRONIZE_CACHE:
2759 if (ata_try_flush_cache(dev))
2760 return ata_scsi_flush_xlat;
2761 break;
2763 case VERIFY:
2764 case VERIFY_16:
2765 return ata_scsi_verify_xlat;
2767 case ATA_12:
2768 case ATA_16:
2769 return ata_scsi_pass_thru;
2771 case START_STOP:
2772 return ata_scsi_start_stop_xlat;
2775 return NULL;
2779 * ata_scsi_dump_cdb - dump SCSI command contents to dmesg
2780 * @ap: ATA port to which the command was being sent
2781 * @cmd: SCSI command to dump
2783 * Prints the contents of a SCSI command via printk().
2786 static inline void ata_scsi_dump_cdb(struct ata_port *ap,
2787 struct scsi_cmnd *cmd)
2789 #ifdef ATA_DEBUG
2790 struct scsi_device *scsidev = cmd->device;
2791 u8 *scsicmd = cmd->cmnd;
2793 DPRINTK("CDB (%u:%d,%d,%d) %02x %02x %02x %02x %02x %02x %02x %02x %02x\n",
2794 ap->print_id,
2795 scsidev->channel, scsidev->id, scsidev->lun,
2796 scsicmd[0], scsicmd[1], scsicmd[2], scsicmd[3],
2797 scsicmd[4], scsicmd[5], scsicmd[6], scsicmd[7],
2798 scsicmd[8]);
2799 #endif
2802 static inline int __ata_scsi_queuecmd(struct scsi_cmnd *scmd,
2803 void (*done)(struct scsi_cmnd *),
2804 struct ata_device *dev)
2806 u8 scsi_op = scmd->cmnd[0];
2807 ata_xlat_func_t xlat_func;
2808 int rc = 0;
2810 if (dev->class == ATA_DEV_ATA) {
2811 if (unlikely(!scmd->cmd_len || scmd->cmd_len > dev->cdb_len))
2812 goto bad_cdb_len;
2814 xlat_func = ata_get_xlat_func(dev, scsi_op);
2815 } else {
2816 if (unlikely(!scmd->cmd_len))
2817 goto bad_cdb_len;
2819 xlat_func = NULL;
2820 if (likely((scsi_op != ATA_16) || !atapi_passthru16)) {
2821 /* relay SCSI command to ATAPI device */
2822 if (unlikely(scmd->cmd_len > dev->cdb_len))
2823 goto bad_cdb_len;
2825 xlat_func = atapi_xlat;
2826 } else {
2827 /* ATA_16 passthru, treat as an ATA command */
2828 if (unlikely(scmd->cmd_len > 16))
2829 goto bad_cdb_len;
2831 xlat_func = ata_get_xlat_func(dev, scsi_op);
2835 if (xlat_func)
2836 rc = ata_scsi_translate(dev, scmd, done, xlat_func);
2837 else
2838 ata_scsi_simulate(dev, scmd, done);
2840 return rc;
2842 bad_cdb_len:
2843 DPRINTK("bad CDB len=%u, scsi_op=0x%02x, max=%u\n",
2844 scmd->cmd_len, scsi_op, dev->cdb_len);
2845 scmd->result = DID_ERROR << 16;
2846 done(scmd);
2847 return 0;
2851 * ata_scsi_queuecmd - Issue SCSI cdb to libata-managed device
2852 * @cmd: SCSI command to be sent
2853 * @done: Completion function, called when command is complete
2855 * In some cases, this function translates SCSI commands into
2856 * ATA taskfiles, and queues the taskfiles to be sent to
2857 * hardware. In other cases, this function simulates a
2858 * SCSI device by evaluating and responding to certain
2859 * SCSI commands. This creates the overall effect of
2860 * ATA and ATAPI devices appearing as SCSI devices.
2862 * LOCKING:
2863 * Releases scsi-layer-held lock, and obtains host lock.
2865 * RETURNS:
2866 * Return value from __ata_scsi_queuecmd() if @cmd can be queued,
2867 * 0 otherwise.
2869 int ata_scsi_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *))
2871 struct ata_port *ap;
2872 struct ata_device *dev;
2873 struct scsi_device *scsidev = cmd->device;
2874 struct Scsi_Host *shost = scsidev->host;
2875 int rc = 0;
2877 ap = ata_shost_to_port(shost);
2879 spin_unlock(shost->host_lock);
2880 spin_lock(ap->lock);
2882 ata_scsi_dump_cdb(ap, cmd);
2884 dev = ata_scsi_find_dev(ap, scsidev);
2885 if (likely(dev))
2886 rc = __ata_scsi_queuecmd(cmd, done, dev);
2887 else {
2888 cmd->result = (DID_BAD_TARGET << 16);
2889 done(cmd);
2892 spin_unlock(ap->lock);
2893 spin_lock(shost->host_lock);
2894 return rc;
2898 * ata_scsi_simulate - simulate SCSI command on ATA device
2899 * @dev: the target device
2900 * @cmd: SCSI command being sent to device.
2901 * @done: SCSI command completion function.
2903 * Interprets and directly executes a select list of SCSI commands
2904 * that can be handled internally.
2906 * LOCKING:
2907 * spin_lock_irqsave(host lock)
2910 void ata_scsi_simulate(struct ata_device *dev, struct scsi_cmnd *cmd,
2911 void (*done)(struct scsi_cmnd *))
2913 struct ata_scsi_args args;
2914 const u8 *scsicmd = cmd->cmnd;
2915 u8 tmp8;
2917 args.dev = dev;
2918 args.id = dev->id;
2919 args.cmd = cmd;
2920 args.done = done;
2922 switch(scsicmd[0]) {
2923 /* TODO: worth improving? */
2924 case FORMAT_UNIT:
2925 ata_scsi_invalid_field(cmd, done);
2926 break;
2928 case INQUIRY:
2929 if (scsicmd[1] & 2) /* is CmdDt set? */
2930 ata_scsi_invalid_field(cmd, done);
2931 else if ((scsicmd[1] & 1) == 0) /* is EVPD clear? */
2932 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_std);
2933 else switch (scsicmd[2]) {
2934 case 0x00:
2935 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_00);
2936 break;
2937 case 0x80:
2938 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_80);
2939 break;
2940 case 0x83:
2941 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_83);
2942 break;
2943 case 0x89:
2944 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_89);
2945 break;
2946 default:
2947 ata_scsi_invalid_field(cmd, done);
2948 break;
2950 break;
2952 case MODE_SENSE:
2953 case MODE_SENSE_10:
2954 ata_scsi_rbuf_fill(&args, ata_scsiop_mode_sense);
2955 break;
2957 case MODE_SELECT: /* unconditionally return */
2958 case MODE_SELECT_10: /* bad-field-in-cdb */
2959 ata_scsi_invalid_field(cmd, done);
2960 break;
2962 case READ_CAPACITY:
2963 ata_scsi_rbuf_fill(&args, ata_scsiop_read_cap);
2964 break;
2966 case SERVICE_ACTION_IN:
2967 if ((scsicmd[1] & 0x1f) == SAI_READ_CAPACITY_16)
2968 ata_scsi_rbuf_fill(&args, ata_scsiop_read_cap);
2969 else
2970 ata_scsi_invalid_field(cmd, done);
2971 break;
2973 case REPORT_LUNS:
2974 ata_scsi_rbuf_fill(&args, ata_scsiop_report_luns);
2975 break;
2977 case REQUEST_SENSE:
2978 ata_scsi_set_sense(cmd, 0, 0, 0);
2979 cmd->result = (DRIVER_SENSE << 24);
2980 done(cmd);
2981 break;
2983 /* if we reach this, then writeback caching is disabled,
2984 * turning this into a no-op.
2986 case SYNCHRONIZE_CACHE:
2987 /* fall through */
2989 /* no-op's, complete with success */
2990 case REZERO_UNIT:
2991 case SEEK_6:
2992 case SEEK_10:
2993 case TEST_UNIT_READY:
2994 ata_scsi_rbuf_fill(&args, ata_scsiop_noop);
2995 break;
2997 case SEND_DIAGNOSTIC:
2998 tmp8 = scsicmd[1] & ~(1 << 3);
2999 if ((tmp8 == 0x4) && (!scsicmd[3]) && (!scsicmd[4]))
3000 ata_scsi_rbuf_fill(&args, ata_scsiop_noop);
3001 else
3002 ata_scsi_invalid_field(cmd, done);
3003 break;
3005 /* all other commands */
3006 default:
3007 ata_scsi_set_sense(cmd, ILLEGAL_REQUEST, 0x20, 0x0);
3008 /* "Invalid command operation code" */
3009 done(cmd);
3010 break;
3014 int ata_scsi_add_hosts(struct ata_host *host, struct scsi_host_template *sht)
3016 int i, rc;
3018 for (i = 0; i < host->n_ports; i++) {
3019 struct ata_port *ap = host->ports[i];
3020 struct Scsi_Host *shost;
3022 rc = -ENOMEM;
3023 shost = scsi_host_alloc(sht, sizeof(struct ata_port *));
3024 if (!shost)
3025 goto err_alloc;
3027 *(struct ata_port **)&shost->hostdata[0] = ap;
3028 ap->scsi_host = shost;
3030 shost->transportt = &ata_scsi_transport_template;
3031 shost->unique_id = ap->print_id;
3032 shost->max_id = 16;
3033 shost->max_lun = 1;
3034 shost->max_channel = 1;
3035 shost->max_cmd_len = 16;
3037 rc = scsi_add_host(ap->scsi_host, ap->host->dev);
3038 if (rc)
3039 goto err_add;
3042 return 0;
3044 err_add:
3045 scsi_host_put(host->ports[i]->scsi_host);
3046 err_alloc:
3047 while (--i >= 0) {
3048 struct Scsi_Host *shost = host->ports[i]->scsi_host;
3050 scsi_remove_host(shost);
3051 scsi_host_put(shost);
3053 return rc;
3056 void ata_scsi_scan_host(struct ata_port *ap, int sync)
3058 int tries = 5;
3059 struct ata_device *last_failed_dev = NULL;
3060 struct ata_link *link;
3061 struct ata_device *dev;
3063 if (ap->flags & ATA_FLAG_DISABLED)
3064 return;
3066 repeat:
3067 ata_port_for_each_link(link, ap) {
3068 ata_link_for_each_dev(dev, link) {
3069 struct scsi_device *sdev;
3070 int channel = 0, id = 0;
3072 if (!ata_dev_enabled(dev) || dev->sdev)
3073 continue;
3075 if (ata_is_host_link(link))
3076 id = dev->devno;
3077 else
3078 channel = link->pmp;
3080 sdev = __scsi_add_device(ap->scsi_host, channel, id, 0,
3081 NULL);
3082 if (!IS_ERR(sdev)) {
3083 dev->sdev = sdev;
3084 scsi_device_put(sdev);
3089 /* If we scanned while EH was in progress or allocation
3090 * failure occurred, scan would have failed silently. Check
3091 * whether all devices are attached.
3093 ata_port_for_each_link(link, ap) {
3094 ata_link_for_each_dev(dev, link) {
3095 if (ata_dev_enabled(dev) && !dev->sdev)
3096 goto exit_loop;
3099 exit_loop:
3100 if (!link)
3101 return;
3103 /* we're missing some SCSI devices */
3104 if (sync) {
3105 /* If caller requested synchrnous scan && we've made
3106 * any progress, sleep briefly and repeat.
3108 if (dev != last_failed_dev) {
3109 msleep(100);
3110 last_failed_dev = dev;
3111 goto repeat;
3114 /* We might be failing to detect boot device, give it
3115 * a few more chances.
3117 if (--tries) {
3118 msleep(100);
3119 goto repeat;
3122 ata_port_printk(ap, KERN_ERR, "WARNING: synchronous SCSI scan "
3123 "failed without making any progress,\n"
3124 " switching to async\n");
3127 queue_delayed_work(ata_aux_wq, &ap->hotplug_task,
3128 round_jiffies_relative(HZ));
3132 * ata_scsi_offline_dev - offline attached SCSI device
3133 * @dev: ATA device to offline attached SCSI device for
3135 * This function is called from ata_eh_hotplug() and responsible
3136 * for taking the SCSI device attached to @dev offline. This
3137 * function is called with host lock which protects dev->sdev
3138 * against clearing.
3140 * LOCKING:
3141 * spin_lock_irqsave(host lock)
3143 * RETURNS:
3144 * 1 if attached SCSI device exists, 0 otherwise.
3146 int ata_scsi_offline_dev(struct ata_device *dev)
3148 if (dev->sdev) {
3149 scsi_device_set_state(dev->sdev, SDEV_OFFLINE);
3150 return 1;
3152 return 0;
3156 * ata_scsi_remove_dev - remove attached SCSI device
3157 * @dev: ATA device to remove attached SCSI device for
3159 * This function is called from ata_eh_scsi_hotplug() and
3160 * responsible for removing the SCSI device attached to @dev.
3162 * LOCKING:
3163 * Kernel thread context (may sleep).
3165 static void ata_scsi_remove_dev(struct ata_device *dev)
3167 struct ata_port *ap = dev->link->ap;
3168 struct scsi_device *sdev;
3169 unsigned long flags;
3171 /* Alas, we need to grab scan_mutex to ensure SCSI device
3172 * state doesn't change underneath us and thus
3173 * scsi_device_get() always succeeds. The mutex locking can
3174 * be removed if there is __scsi_device_get() interface which
3175 * increments reference counts regardless of device state.
3177 mutex_lock(&ap->scsi_host->scan_mutex);
3178 spin_lock_irqsave(ap->lock, flags);
3180 /* clearing dev->sdev is protected by host lock */
3181 sdev = dev->sdev;
3182 dev->sdev = NULL;
3184 if (sdev) {
3185 /* If user initiated unplug races with us, sdev can go
3186 * away underneath us after the host lock and
3187 * scan_mutex are released. Hold onto it.
3189 if (scsi_device_get(sdev) == 0) {
3190 /* The following ensures the attached sdev is
3191 * offline on return from ata_scsi_offline_dev()
3192 * regardless it wins or loses the race
3193 * against this function.
3195 scsi_device_set_state(sdev, SDEV_OFFLINE);
3196 } else {
3197 WARN_ON(1);
3198 sdev = NULL;
3202 spin_unlock_irqrestore(ap->lock, flags);
3203 mutex_unlock(&ap->scsi_host->scan_mutex);
3205 if (sdev) {
3206 ata_dev_printk(dev, KERN_INFO, "detaching (SCSI %s)\n",
3207 sdev->sdev_gendev.bus_id);
3209 scsi_remove_device(sdev);
3210 scsi_device_put(sdev);
3214 static void ata_scsi_handle_link_detach(struct ata_link *link)
3216 struct ata_port *ap = link->ap;
3217 struct ata_device *dev;
3219 ata_link_for_each_dev(dev, link) {
3220 unsigned long flags;
3222 if (!(dev->flags & ATA_DFLAG_DETACHED))
3223 continue;
3225 spin_lock_irqsave(ap->lock, flags);
3226 dev->flags &= ~ATA_DFLAG_DETACHED;
3227 spin_unlock_irqrestore(ap->lock, flags);
3229 ata_scsi_remove_dev(dev);
3234 * ata_scsi_media_change_notify - send media change event
3235 * @atadev: Pointer to the disk device with media change event
3237 * Tell the block layer to send a media change notification
3238 * event.
3240 * LOCKING:
3241 * interrupt context, may not sleep.
3243 void ata_scsi_media_change_notify(struct ata_device *atadev)
3245 #ifdef OTHER_AN_PATCHES_HAVE_BEEN_APPLIED
3246 scsi_device_event_notify(atadev->sdev, SDEV_MEDIA_CHANGE);
3247 #endif
3249 EXPORT_SYMBOL_GPL(ata_scsi_media_change_notify);
3252 * ata_scsi_hotplug - SCSI part of hotplug
3253 * @work: Pointer to ATA port to perform SCSI hotplug on
3255 * Perform SCSI part of hotplug. It's executed from a separate
3256 * workqueue after EH completes. This is necessary because SCSI
3257 * hot plugging requires working EH and hot unplugging is
3258 * synchronized with hot plugging with a mutex.
3260 * LOCKING:
3261 * Kernel thread context (may sleep).
3263 void ata_scsi_hotplug(struct work_struct *work)
3265 struct ata_port *ap =
3266 container_of(work, struct ata_port, hotplug_task.work);
3267 int i;
3269 if (ap->pflags & ATA_PFLAG_UNLOADING) {
3270 DPRINTK("ENTER/EXIT - unloading\n");
3271 return;
3274 DPRINTK("ENTER\n");
3276 /* Unplug detached devices. We cannot use link iterator here
3277 * because PMP links have to be scanned even if PMP is
3278 * currently not attached. Iterate manually.
3280 ata_scsi_handle_link_detach(&ap->link);
3281 if (ap->pmp_link)
3282 for (i = 0; i < SATA_PMP_MAX_PORTS; i++)
3283 ata_scsi_handle_link_detach(&ap->pmp_link[i]);
3285 /* scan for new ones */
3286 ata_scsi_scan_host(ap, 0);
3288 DPRINTK("EXIT\n");
3292 * ata_scsi_user_scan - indication for user-initiated bus scan
3293 * @shost: SCSI host to scan
3294 * @channel: Channel to scan
3295 * @id: ID to scan
3296 * @lun: LUN to scan
3298 * This function is called when user explicitly requests bus
3299 * scan. Set probe pending flag and invoke EH.
3301 * LOCKING:
3302 * SCSI layer (we don't care)
3304 * RETURNS:
3305 * Zero.
3307 static int ata_scsi_user_scan(struct Scsi_Host *shost, unsigned int channel,
3308 unsigned int id, unsigned int lun)
3310 struct ata_port *ap = ata_shost_to_port(shost);
3311 unsigned long flags;
3312 int devno, rc = 0;
3314 if (!ap->ops->error_handler)
3315 return -EOPNOTSUPP;
3317 if (lun != SCAN_WILD_CARD && lun)
3318 return -EINVAL;
3320 if (ap->nr_pmp_links == 0) {
3321 if (channel != SCAN_WILD_CARD && channel)
3322 return -EINVAL;
3323 devno = id;
3324 } else {
3325 if (id != SCAN_WILD_CARD && id)
3326 return -EINVAL;
3327 devno = channel;
3330 spin_lock_irqsave(ap->lock, flags);
3332 if (devno == SCAN_WILD_CARD) {
3333 struct ata_link *link;
3335 ata_port_for_each_link(link, ap) {
3336 struct ata_eh_info *ehi = &link->eh_info;
3337 ehi->probe_mask |= (1 << ata_link_max_devices(link)) - 1;
3338 ehi->action |= ATA_EH_SOFTRESET;
3340 } else {
3341 struct ata_device *dev = ata_find_dev(ap, devno);
3343 if (dev) {
3344 struct ata_eh_info *ehi = &dev->link->eh_info;
3345 ehi->probe_mask |= 1 << dev->devno;
3346 ehi->action |= ATA_EH_SOFTRESET;
3347 ehi->flags |= ATA_EHI_RESUME_LINK;
3348 } else
3349 rc = -EINVAL;
3352 if (rc == 0) {
3353 ata_port_schedule_eh(ap);
3354 spin_unlock_irqrestore(ap->lock, flags);
3355 ata_port_wait_eh(ap);
3356 } else
3357 spin_unlock_irqrestore(ap->lock, flags);
3359 return rc;
3363 * ata_scsi_dev_rescan - initiate scsi_rescan_device()
3364 * @work: Pointer to ATA port to perform scsi_rescan_device()
3366 * After ATA pass thru (SAT) commands are executed successfully,
3367 * libata need to propagate the changes to SCSI layer. This
3368 * function must be executed from ata_aux_wq such that sdev
3369 * attach/detach don't race with rescan.
3371 * LOCKING:
3372 * Kernel thread context (may sleep).
3374 void ata_scsi_dev_rescan(struct work_struct *work)
3376 struct ata_port *ap =
3377 container_of(work, struct ata_port, scsi_rescan_task);
3378 struct ata_link *link;
3379 struct ata_device *dev;
3380 unsigned long flags;
3382 spin_lock_irqsave(ap->lock, flags);
3384 ata_port_for_each_link(link, ap) {
3385 ata_link_for_each_dev(dev, link) {
3386 struct scsi_device *sdev = dev->sdev;
3388 if (!ata_dev_enabled(dev) || !sdev)
3389 continue;
3390 if (scsi_device_get(sdev))
3391 continue;
3393 spin_unlock_irqrestore(ap->lock, flags);
3394 scsi_rescan_device(&(sdev->sdev_gendev));
3395 scsi_device_put(sdev);
3396 spin_lock_irqsave(ap->lock, flags);
3400 spin_unlock_irqrestore(ap->lock, flags);
3404 * ata_sas_port_alloc - Allocate port for a SAS attached SATA device
3405 * @host: ATA host container for all SAS ports
3406 * @port_info: Information from low-level host driver
3407 * @shost: SCSI host that the scsi device is attached to
3409 * LOCKING:
3410 * PCI/etc. bus probe sem.
3412 * RETURNS:
3413 * ata_port pointer on success / NULL on failure.
3416 struct ata_port *ata_sas_port_alloc(struct ata_host *host,
3417 struct ata_port_info *port_info,
3418 struct Scsi_Host *shost)
3420 struct ata_port *ap;
3422 ap = ata_port_alloc(host);
3423 if (!ap)
3424 return NULL;
3426 ap->port_no = 0;
3427 ap->lock = shost->host_lock;
3428 ap->pio_mask = port_info->pio_mask;
3429 ap->mwdma_mask = port_info->mwdma_mask;
3430 ap->udma_mask = port_info->udma_mask;
3431 ap->flags |= port_info->flags;
3432 ap->ops = port_info->port_ops;
3433 ap->cbl = ATA_CBL_SATA;
3435 return ap;
3437 EXPORT_SYMBOL_GPL(ata_sas_port_alloc);
3440 * ata_sas_port_start - Set port up for dma.
3441 * @ap: Port to initialize
3443 * Called just after data structures for each port are
3444 * initialized. Allocates DMA pad.
3446 * May be used as the port_start() entry in ata_port_operations.
3448 * LOCKING:
3449 * Inherited from caller.
3451 int ata_sas_port_start(struct ata_port *ap)
3453 return ata_pad_alloc(ap, ap->dev);
3455 EXPORT_SYMBOL_GPL(ata_sas_port_start);
3458 * ata_port_stop - Undo ata_sas_port_start()
3459 * @ap: Port to shut down
3461 * Frees the DMA pad.
3463 * May be used as the port_stop() entry in ata_port_operations.
3465 * LOCKING:
3466 * Inherited from caller.
3469 void ata_sas_port_stop(struct ata_port *ap)
3471 ata_pad_free(ap, ap->dev);
3473 EXPORT_SYMBOL_GPL(ata_sas_port_stop);
3476 * ata_sas_port_init - Initialize a SATA device
3477 * @ap: SATA port to initialize
3479 * LOCKING:
3480 * PCI/etc. bus probe sem.
3482 * RETURNS:
3483 * Zero on success, non-zero on error.
3486 int ata_sas_port_init(struct ata_port *ap)
3488 int rc = ap->ops->port_start(ap);
3490 if (!rc) {
3491 ap->print_id = ata_print_id++;
3492 rc = ata_bus_probe(ap);
3495 return rc;
3497 EXPORT_SYMBOL_GPL(ata_sas_port_init);
3500 * ata_sas_port_destroy - Destroy a SATA port allocated by ata_sas_port_alloc
3501 * @ap: SATA port to destroy
3505 void ata_sas_port_destroy(struct ata_port *ap)
3507 if (ap->ops->port_stop)
3508 ap->ops->port_stop(ap);
3509 kfree(ap);
3511 EXPORT_SYMBOL_GPL(ata_sas_port_destroy);
3514 * ata_sas_slave_configure - Default slave_config routine for libata devices
3515 * @sdev: SCSI device to configure
3516 * @ap: ATA port to which SCSI device is attached
3518 * RETURNS:
3519 * Zero.
3522 int ata_sas_slave_configure(struct scsi_device *sdev, struct ata_port *ap)
3524 ata_scsi_sdev_config(sdev);
3525 ata_scsi_dev_config(sdev, ap->link.device);
3526 return 0;
3528 EXPORT_SYMBOL_GPL(ata_sas_slave_configure);
3531 * ata_sas_queuecmd - Issue SCSI cdb to libata-managed device
3532 * @cmd: SCSI command to be sent
3533 * @done: Completion function, called when command is complete
3534 * @ap: ATA port to which the command is being sent
3536 * RETURNS:
3537 * Return value from __ata_scsi_queuecmd() if @cmd can be queued,
3538 * 0 otherwise.
3541 int ata_sas_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *),
3542 struct ata_port *ap)
3544 int rc = 0;
3546 ata_scsi_dump_cdb(ap, cmd);
3548 if (likely(ata_scsi_dev_enabled(ap->link.device)))
3549 rc = __ata_scsi_queuecmd(cmd, done, ap->link.device);
3550 else {
3551 cmd->result = (DID_BAD_TARGET << 16);
3552 done(cmd);
3554 return rc;
3556 EXPORT_SYMBOL_GPL(ata_sas_queuecmd);