allow coexistance of N build and AC build.
[tomato.git] / release / src-rt-6.x / linux / linux-2.6 / drivers / ata / libata-scsi.c
blob577582a42307535aec1e0315afe9cf6df8cb7b42
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[] = {
75 RW_RECOVERY_MPAGE,
76 RW_RECOVERY_MPAGE_LEN - 2,
77 (1 << 7) | /* AWRE, sat-r06 say it shall be 0 */
78 (1 << 6), /* ARRE (auto read reallocation) */
79 0, /* read retry count */
80 0, 0, 0, 0,
81 0, /* write retry count */
82 0, 0, 0
85 static const u8 def_cache_mpage[CACHE_MPAGE_LEN] = {
86 CACHE_MPAGE,
87 CACHE_MPAGE_LEN - 2,
88 0, /* contains WCE, needs to be 0 for logic */
89 0, 0, 0, 0, 0, 0, 0, 0, 0,
90 0, /* contains DRA, needs to be 0 for logic */
91 0, 0, 0, 0, 0, 0, 0
94 static const u8 def_control_mpage[CONTROL_MPAGE_LEN] = {
95 CONTROL_MPAGE,
96 CONTROL_MPAGE_LEN - 2,
97 2, /* DSENSE=0, GLTSD=1 */
98 0, /* [QAM+QERR may be 1, see 05-359r1] */
99 0, 0, 0, 0, 0xff, 0xff,
100 0, 30 /* extended self test time, see 05-359r1 */
104 * libata transport template. libata doesn't do real transport stuff.
105 * It just needs the eh_timed_out hook.
107 static struct scsi_transport_template ata_scsi_transport_template = {
108 .eh_strategy_handler = ata_scsi_error,
109 .eh_timed_out = ata_scsi_timed_out,
110 .user_scan = ata_scsi_user_scan,
114 static void ata_scsi_invalid_field(struct scsi_cmnd *cmd,
115 void (*done)(struct scsi_cmnd *))
117 ata_scsi_set_sense(cmd, ILLEGAL_REQUEST, 0x24, 0x0);
118 /* "Invalid field in cbd" */
119 done(cmd);
123 * ata_std_bios_param - generic bios head/sector/cylinder calculator used by sd.
124 * @sdev: SCSI device for which BIOS geometry is to be determined
125 * @bdev: block device associated with @sdev
126 * @capacity: capacity of SCSI device
127 * @geom: location to which geometry will be output
129 * Generic bios head/sector/cylinder calculator
130 * used by sd. Most BIOSes nowadays expect a XXX/255/16 (CHS)
131 * mapping. Some situations may arise where the disk is not
132 * bootable if this is not used.
134 * LOCKING:
135 * Defined by the SCSI layer. We don't really care.
137 * RETURNS:
138 * Zero.
140 int ata_std_bios_param(struct scsi_device *sdev, struct block_device *bdev,
141 sector_t capacity, int geom[])
143 geom[0] = 255;
144 geom[1] = 63;
145 sector_div(capacity, 255*63);
146 geom[2] = capacity;
148 return 0;
152 * ata_get_identity - Handler for HDIO_GET_IDENTITY ioctl
153 * @sdev: SCSI device to get identify data for
154 * @arg: User buffer area for identify data
156 * LOCKING:
157 * Defined by the SCSI layer. We don't really care.
159 * RETURNS:
160 * Zero on success, negative errno on error.
162 static int ata_get_identity(struct scsi_device *sdev, void __user *arg)
164 struct ata_port *ap = ata_shost_to_port(sdev->host);
165 struct ata_device *dev = ata_scsi_find_dev(ap, sdev);
166 u16 __user *dst = arg;
167 char buf[40];
169 if (!dev)
170 return -ENOMSG;
172 if (copy_to_user(dst, dev->id, ATA_ID_WORDS * sizeof(u16)))
173 return -EFAULT;
175 ata_id_string(dev->id, buf, ATA_ID_PROD, ATA_ID_PROD_LEN);
176 if (copy_to_user(dst + ATA_ID_PROD, buf, ATA_ID_PROD_LEN))
177 return -EFAULT;
179 ata_id_string(dev->id, buf, ATA_ID_FW_REV, ATA_ID_FW_REV_LEN);
180 if (copy_to_user(dst + ATA_ID_FW_REV, buf, ATA_ID_FW_REV_LEN))
181 return -EFAULT;
183 ata_id_string(dev->id, buf, ATA_ID_SERNO, ATA_ID_SERNO_LEN);
184 if (copy_to_user(dst + ATA_ID_SERNO, buf, ATA_ID_SERNO_LEN))
185 return -EFAULT;
187 return 0;
191 * ata_cmd_ioctl - Handler for HDIO_DRIVE_CMD ioctl
192 * @scsidev: Device to which we are issuing command
193 * @arg: User provided data for issuing command
195 * LOCKING:
196 * Defined by the SCSI layer. We don't really care.
198 * RETURNS:
199 * Zero on success, negative errno on error.
201 int ata_cmd_ioctl(struct scsi_device *scsidev, void __user *arg)
203 int rc = 0;
204 u8 scsi_cmd[MAX_COMMAND_SIZE];
205 u8 args[4], *argbuf = NULL, *sensebuf = NULL;
206 int argsize = 0;
207 enum dma_data_direction data_dir;
208 int cmd_result;
210 if (arg == NULL)
211 return -EINVAL;
213 if (copy_from_user(args, arg, sizeof(args)))
214 return -EFAULT;
216 sensebuf = kzalloc(SCSI_SENSE_BUFFERSIZE, GFP_NOIO);
217 if (!sensebuf)
218 return -ENOMEM;
220 memset(scsi_cmd, 0, sizeof(scsi_cmd));
222 if (args[3]) {
223 argsize = SECTOR_SIZE * args[3];
224 argbuf = kmalloc(argsize, GFP_KERNEL);
225 if (argbuf == NULL) {
226 rc = -ENOMEM;
227 goto error;
230 scsi_cmd[1] = (4 << 1); /* PIO Data-in */
231 scsi_cmd[2] = 0x0e; /* no off.line or cc, read from dev,
232 block count in sector count field */
233 data_dir = DMA_FROM_DEVICE;
234 } else {
235 scsi_cmd[1] = (3 << 1); /* Non-data */
236 scsi_cmd[2] = 0x20; /* cc but no off.line or data xfer */
237 data_dir = DMA_NONE;
240 scsi_cmd[0] = ATA_16;
242 scsi_cmd[4] = args[2];
243 if (args[0] == WIN_SMART) { /* hack -- ide driver does this too... */
244 scsi_cmd[6] = args[3];
245 scsi_cmd[8] = args[1];
246 scsi_cmd[10] = 0x4f;
247 scsi_cmd[12] = 0xc2;
248 } else {
249 scsi_cmd[6] = args[1];
251 scsi_cmd[14] = args[0];
253 /* Good values for timeout and retries? Values below
254 from scsi_ioctl_send_command() for default case... */
255 cmd_result = scsi_execute(scsidev, scsi_cmd, data_dir, argbuf, argsize,
256 sensebuf, (10*HZ), 5, 0);
258 if (driver_byte(cmd_result) == DRIVER_SENSE) {/* sense data available */
259 u8 *desc = sensebuf + 8;
260 cmd_result &= ~(0xFF<<24); /* DRIVER_SENSE is not an error */
262 /* If we set cc then ATA pass-through will cause a
263 * check condition even if no error. Filter that. */
264 if (cmd_result & SAM_STAT_CHECK_CONDITION) {
265 struct scsi_sense_hdr sshdr;
266 scsi_normalize_sense(sensebuf, SCSI_SENSE_BUFFERSIZE,
267 &sshdr);
268 if (sshdr.sense_key==0 &&
269 sshdr.asc==0 && sshdr.ascq==0)
270 cmd_result &= ~SAM_STAT_CHECK_CONDITION;
273 /* Send userspace a few ATA registers (same as drivers/ide) */
274 if (sensebuf[0] == 0x72 && /* format is "descriptor" */
275 desc[0] == 0x09 ) { /* code is "ATA Descriptor" */
276 args[0] = desc[13]; /* status */
277 args[1] = desc[3]; /* error */
278 args[2] = desc[5]; /* sector count (0:7) */
279 if (copy_to_user(arg, args, sizeof(args)))
280 rc = -EFAULT;
285 if (cmd_result) {
286 rc = -EIO;
287 goto error;
290 if ((argbuf)
291 && copy_to_user(arg + sizeof(args), argbuf, argsize))
292 rc = -EFAULT;
293 error:
294 kfree(sensebuf);
295 kfree(argbuf);
296 return rc;
300 * ata_task_ioctl - Handler for HDIO_DRIVE_TASK ioctl
301 * @scsidev: Device to which we are issuing command
302 * @arg: User provided data for issuing command
304 * LOCKING:
305 * Defined by the SCSI layer. We don't really care.
307 * RETURNS:
308 * Zero on success, negative errno on error.
310 int ata_task_ioctl(struct scsi_device *scsidev, void __user *arg)
312 int rc = 0;
313 u8 scsi_cmd[MAX_COMMAND_SIZE];
314 u8 args[7], *sensebuf = NULL;
315 int cmd_result;
317 if (arg == NULL)
318 return -EINVAL;
320 if (copy_from_user(args, arg, sizeof(args)))
321 return -EFAULT;
323 sensebuf = kzalloc(SCSI_SENSE_BUFFERSIZE, GFP_NOIO);
324 if (!sensebuf)
325 return -ENOMEM;
327 memset(scsi_cmd, 0, sizeof(scsi_cmd));
328 scsi_cmd[0] = ATA_16;
329 scsi_cmd[1] = (3 << 1); /* Non-data */
330 scsi_cmd[2] = 0x20; /* cc but no off.line or data xfer */
331 scsi_cmd[4] = args[1];
332 scsi_cmd[6] = args[2];
333 scsi_cmd[8] = args[3];
334 scsi_cmd[10] = args[4];
335 scsi_cmd[12] = args[5];
336 scsi_cmd[13] = args[6] & 0x4f;
337 scsi_cmd[14] = args[0];
339 /* Good values for timeout and retries? Values below
340 from scsi_ioctl_send_command() for default case... */
341 cmd_result = scsi_execute(scsidev, scsi_cmd, DMA_NONE, NULL, 0,
342 sensebuf, (10*HZ), 5, 0);
344 if (driver_byte(cmd_result) == DRIVER_SENSE) {/* sense data available */
345 u8 *desc = sensebuf + 8;
346 cmd_result &= ~(0xFF<<24); /* DRIVER_SENSE is not an error */
348 /* If we set cc then ATA pass-through will cause a
349 * check condition even if no error. Filter that. */
350 if (cmd_result & SAM_STAT_CHECK_CONDITION) {
351 struct scsi_sense_hdr sshdr;
352 scsi_normalize_sense(sensebuf, SCSI_SENSE_BUFFERSIZE,
353 &sshdr);
354 if (sshdr.sense_key==0 &&
355 sshdr.asc==0 && sshdr.ascq==0)
356 cmd_result &= ~SAM_STAT_CHECK_CONDITION;
359 /* Send userspace ATA registers */
360 if (sensebuf[0] == 0x72 && /* format is "descriptor" */
361 desc[0] == 0x09) {/* code is "ATA Descriptor" */
362 args[0] = desc[13]; /* status */
363 args[1] = desc[3]; /* error */
364 args[2] = desc[5]; /* sector count (0:7) */
365 args[3] = desc[7]; /* lbal */
366 args[4] = desc[9]; /* lbam */
367 args[5] = desc[11]; /* lbah */
368 args[6] = desc[12]; /* select */
369 if (copy_to_user(arg, args, sizeof(args)))
370 rc = -EFAULT;
374 if (cmd_result) {
375 rc = -EIO;
376 goto error;
379 error:
380 kfree(sensebuf);
381 return rc;
384 int ata_scsi_ioctl(struct scsi_device *scsidev, int cmd, void __user *arg)
386 int val = -EINVAL, rc = -EINVAL;
388 switch (cmd) {
389 case ATA_IOC_GET_IO32:
390 val = 0;
391 if (copy_to_user(arg, &val, 1))
392 return -EFAULT;
393 return 0;
395 case ATA_IOC_SET_IO32:
396 val = (unsigned long) arg;
397 if (val != 0)
398 return -EINVAL;
399 return 0;
401 case HDIO_GET_IDENTITY:
402 return ata_get_identity(scsidev, arg);
404 case HDIO_DRIVE_CMD:
405 if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
406 return -EACCES;
407 return ata_cmd_ioctl(scsidev, arg);
409 case HDIO_DRIVE_TASK:
410 if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
411 return -EACCES;
412 return ata_task_ioctl(scsidev, arg);
414 default:
415 rc = -ENOTTY;
416 break;
419 return rc;
423 * ata_scsi_qc_new - acquire new ata_queued_cmd reference
424 * @dev: ATA device to which the new command is attached
425 * @cmd: SCSI command that originated this ATA command
426 * @done: SCSI command completion function
428 * Obtain a reference to an unused ata_queued_cmd structure,
429 * which is the basic libata structure representing a single
430 * ATA command sent to the hardware.
432 * If a command was available, fill in the SCSI-specific
433 * portions of the structure with information on the
434 * current command.
436 * LOCKING:
437 * spin_lock_irqsave(host lock)
439 * RETURNS:
440 * Command allocated, or %NULL if none available.
442 static struct ata_queued_cmd *ata_scsi_qc_new(struct ata_device *dev,
443 struct scsi_cmnd *cmd,
444 void (*done)(struct scsi_cmnd *))
446 struct ata_queued_cmd *qc;
448 qc = ata_qc_new_init(dev);
449 if (qc) {
450 qc->scsicmd = cmd;
451 qc->scsidone = done;
453 if (cmd->use_sg) {
454 qc->__sg = (struct scatterlist *) cmd->request_buffer;
455 qc->n_elem = cmd->use_sg;
456 } else if (cmd->request_bufflen) {
457 qc->__sg = &qc->sgent;
458 qc->n_elem = 1;
460 } else {
461 cmd->result = (DID_OK << 16) | (QUEUE_FULL << 1);
462 done(cmd);
465 return qc;
469 * ata_dump_status - user friendly display of error info
470 * @id: id of the port in question
471 * @tf: ptr to filled out taskfile
473 * Decode and dump the ATA error/status registers for the user so
474 * that they have some idea what really happened at the non
475 * make-believe layer.
477 * LOCKING:
478 * inherited from caller
480 static void ata_dump_status(unsigned id, struct ata_taskfile *tf)
482 u8 stat = tf->command, err = tf->feature;
484 printk(KERN_WARNING "ata%u: status=0x%02x { ", id, stat);
485 if (stat & ATA_BUSY) {
486 printk("Busy }\n"); /* Data is not valid in this case */
487 } else {
488 if (stat & 0x40) printk("DriveReady ");
489 if (stat & 0x20) printk("DeviceFault ");
490 if (stat & 0x10) printk("SeekComplete ");
491 if (stat & 0x08) printk("DataRequest ");
492 if (stat & 0x04) printk("CorrectedError ");
493 if (stat & 0x02) printk("Index ");
494 if (stat & 0x01) printk("Error ");
495 printk("}\n");
497 if (err) {
498 printk(KERN_WARNING "ata%u: error=0x%02x { ", id, err);
499 if (err & 0x04) printk("DriveStatusError ");
500 if (err & 0x80) {
501 if (err & 0x04) printk("BadCRC ");
502 else printk("Sector ");
504 if (err & 0x40) printk("UncorrectableError ");
505 if (err & 0x10) printk("SectorIdNotFound ");
506 if (err & 0x02) printk("TrackZeroNotFound ");
507 if (err & 0x01) printk("AddrMarkNotFound ");
508 printk("}\n");
514 * ata_to_sense_error - convert ATA error to SCSI error
515 * @id: ATA device number
516 * @drv_stat: value contained in ATA status register
517 * @drv_err: value contained in ATA error register
518 * @sk: the sense key we'll fill out
519 * @asc: the additional sense code we'll fill out
520 * @ascq: the additional sense code qualifier we'll fill out
521 * @verbose: be verbose
523 * Converts an ATA error into a SCSI error. Fill out pointers to
524 * SK, ASC, and ASCQ bytes for later use in fixed or descriptor
525 * format sense blocks.
527 * LOCKING:
528 * spin_lock_irqsave(host lock)
530 static void ata_to_sense_error(unsigned id, u8 drv_stat, u8 drv_err, u8 *sk,
531 u8 *asc, u8 *ascq, int verbose)
533 int i;
535 /* Based on the 3ware driver translation table */
536 static const unsigned char sense_table[][4] = {
537 /* BBD|ECC|ID|MAR */
538 {0xd1, ABORTED_COMMAND, 0x00, 0x00}, // Device busy Aborted command
539 /* BBD|ECC|ID */
540 {0xd0, ABORTED_COMMAND, 0x00, 0x00}, // Device busy Aborted command
541 /* ECC|MC|MARK */
542 {0x61, HARDWARE_ERROR, 0x00, 0x00}, // Device fault Hardware error
543 /* ICRC|ABRT */ /* NB: ICRC & !ABRT is BBD */
544 {0x84, ABORTED_COMMAND, 0x47, 0x00}, // Data CRC error SCSI parity error
545 /* MC|ID|ABRT|TRK0|MARK */
546 {0x37, NOT_READY, 0x04, 0x00}, // Unit offline Not ready
547 /* MCR|MARK */
548 {0x09, NOT_READY, 0x04, 0x00}, // Unrecovered disk error Not ready
549 /* Bad address mark */
550 {0x01, MEDIUM_ERROR, 0x13, 0x00}, // Address mark not found Address mark not found for data field
551 /* TRK0 */
552 {0x02, HARDWARE_ERROR, 0x00, 0x00}, // Track 0 not found Hardware error
553 /* Abort & !ICRC */
554 {0x04, ABORTED_COMMAND, 0x00, 0x00}, // Aborted command Aborted command
555 /* Media change request */
556 {0x08, NOT_READY, 0x04, 0x00}, // Media change request FIXME: faking offline
557 /* SRV */
558 {0x10, ABORTED_COMMAND, 0x14, 0x00}, // ID not found Recorded entity not found
559 /* Media change */
560 {0x08, NOT_READY, 0x04, 0x00}, // Media change FIXME: faking offline
561 /* ECC */
562 {0x40, MEDIUM_ERROR, 0x11, 0x04}, // Uncorrectable ECC error Unrecovered read error
563 /* BBD - block marked bad */
564 {0x80, MEDIUM_ERROR, 0x11, 0x04}, // Block marked bad Medium error, unrecovered read error
565 {0xFF, 0xFF, 0xFF, 0xFF}, // END mark
567 static const unsigned char stat_table[][4] = {
568 /* Must be first because BUSY means no other bits valid */
569 {0x80, ABORTED_COMMAND, 0x47, 0x00}, // Busy, fake parity for now
570 {0x20, HARDWARE_ERROR, 0x00, 0x00}, // Device fault
571 {0x08, ABORTED_COMMAND, 0x47, 0x00}, // Timed out in xfer, fake parity for now
572 {0x04, RECOVERED_ERROR, 0x11, 0x00}, // Recovered ECC error Medium error, recovered
573 {0xFF, 0xFF, 0xFF, 0xFF}, // END mark
577 * Is this an error we can process/parse
579 if (drv_stat & ATA_BUSY) {
580 drv_err = 0; /* Ignore the err bits, they're invalid */
583 if (drv_err) {
584 /* Look for drv_err */
585 for (i = 0; sense_table[i][0] != 0xFF; i++) {
586 /* Look for best matches first */
587 if ((sense_table[i][0] & drv_err) ==
588 sense_table[i][0]) {
589 *sk = sense_table[i][1];
590 *asc = sense_table[i][2];
591 *ascq = sense_table[i][3];
592 goto translate_done;
595 /* No immediate match */
596 if (verbose)
597 printk(KERN_WARNING "ata%u: no sense translation for "
598 "error 0x%02x\n", id, drv_err);
601 /* Fall back to interpreting status bits */
602 for (i = 0; stat_table[i][0] != 0xFF; i++) {
603 if (stat_table[i][0] & drv_stat) {
604 *sk = stat_table[i][1];
605 *asc = stat_table[i][2];
606 *ascq = stat_table[i][3];
607 goto translate_done;
610 /* No error? Undecoded? */
611 if (verbose)
612 printk(KERN_WARNING "ata%u: no sense translation for "
613 "status: 0x%02x\n", id, drv_stat);
615 /* We need a sensible error return here, which is tricky, and one
616 that won't cause people to do things like return a disk wrongly */
617 *sk = ABORTED_COMMAND;
618 *asc = 0x00;
619 *ascq = 0x00;
621 translate_done:
622 if (verbose)
623 printk(KERN_ERR "ata%u: translated ATA stat/err 0x%02x/%02x "
624 "to SCSI SK/ASC/ASCQ 0x%x/%02x/%02x\n",
625 id, drv_stat, drv_err, *sk, *asc, *ascq);
626 return;
630 * ata_gen_passthru_sense - Generate check condition sense block.
631 * @qc: Command that completed.
633 * This function is specific to the ATA descriptor format sense
634 * block specified for the ATA pass through commands. Regardless
635 * of whether the command errored or not, return a sense
636 * block. Copy all controller registers into the sense
637 * block. Clear sense key, ASC & ASCQ if there is no error.
639 * LOCKING:
640 * None.
642 static void ata_gen_passthru_sense(struct ata_queued_cmd *qc)
644 struct scsi_cmnd *cmd = qc->scsicmd;
645 struct ata_taskfile *tf = &qc->result_tf;
646 unsigned char *sb = cmd->sense_buffer;
647 unsigned char *desc = sb + 8;
648 int verbose = qc->ap->ops->error_handler == NULL;
650 memset(sb, 0, SCSI_SENSE_BUFFERSIZE);
652 cmd->result = (DRIVER_SENSE << 24) | SAM_STAT_CHECK_CONDITION;
655 * Use ata_to_sense_error() to map status register bits
656 * onto sense key, asc & ascq.
658 if (qc->err_mask ||
659 tf->command & (ATA_BUSY | ATA_DF | ATA_ERR | ATA_DRQ)) {
660 ata_to_sense_error(qc->ap->print_id, tf->command, tf->feature,
661 &sb[1], &sb[2], &sb[3], verbose);
662 sb[1] &= 0x0f;
666 * Sense data is current and format is descriptor.
668 sb[0] = 0x72;
670 desc[0] = 0x09;
672 /* set length of additional sense data */
673 sb[7] = 14;
674 desc[1] = 12;
677 * Copy registers into sense buffer.
679 desc[2] = 0x00;
680 desc[3] = tf->feature; /* == error reg */
681 desc[5] = tf->nsect;
682 desc[7] = tf->lbal;
683 desc[9] = tf->lbam;
684 desc[11] = tf->lbah;
685 desc[12] = tf->device;
686 desc[13] = tf->command; /* == status reg */
689 * Fill in Extend bit, and the high order bytes
690 * if applicable.
692 if (tf->flags & ATA_TFLAG_LBA48) {
693 desc[2] |= 0x01;
694 desc[4] = tf->hob_nsect;
695 desc[6] = tf->hob_lbal;
696 desc[8] = tf->hob_lbam;
697 desc[10] = tf->hob_lbah;
702 * ata_gen_ata_sense - generate a SCSI fixed sense block
703 * @qc: Command that we are erroring out
705 * Generate sense block for a failed ATA command @qc. Descriptor
706 * format is used to accomodate LBA48 block address.
708 * LOCKING:
709 * None.
711 static void ata_gen_ata_sense(struct ata_queued_cmd *qc)
713 struct ata_device *dev = qc->dev;
714 struct scsi_cmnd *cmd = qc->scsicmd;
715 struct ata_taskfile *tf = &qc->result_tf;
716 unsigned char *sb = cmd->sense_buffer;
717 unsigned char *desc = sb + 8;
718 int verbose = qc->ap->ops->error_handler == NULL;
719 u64 block;
721 memset(sb, 0, SCSI_SENSE_BUFFERSIZE);
723 cmd->result = (DRIVER_SENSE << 24) | SAM_STAT_CHECK_CONDITION;
725 /* sense data is current and format is descriptor */
726 sb[0] = 0x72;
728 /* Use ata_to_sense_error() to map status register bits
729 * onto sense key, asc & ascq.
731 if (qc->err_mask ||
732 tf->command & (ATA_BUSY | ATA_DF | ATA_ERR | ATA_DRQ)) {
733 ata_to_sense_error(qc->ap->print_id, tf->command, tf->feature,
734 &sb[1], &sb[2], &sb[3], verbose);
735 sb[1] &= 0x0f;
738 block = ata_tf_read_block(&qc->result_tf, dev);
740 /* information sense data descriptor */
741 sb[7] = 12;
742 desc[0] = 0x00;
743 desc[1] = 10;
745 desc[2] |= 0x80; /* valid */
746 desc[6] = block >> 40;
747 desc[7] = block >> 32;
748 desc[8] = block >> 24;
749 desc[9] = block >> 16;
750 desc[10] = block >> 8;
751 desc[11] = block;
754 static void ata_scsi_sdev_config(struct scsi_device *sdev)
756 sdev->use_10_for_rw = 1;
757 sdev->use_10_for_ms = 1;
759 /* set the min alignment */
760 blk_queue_update_dma_alignment(sdev->request_queue, ATA_DMA_PAD_SZ - 1);
763 static void ata_scsi_dev_config(struct scsi_device *sdev,
764 struct ata_device *dev)
766 /* configure max sectors */
767 blk_queue_max_sectors(sdev->request_queue, dev->max_sectors);
769 /* SATA DMA transfers must be multiples of 4 byte, so
770 * we need to pad ATAPI transfers using an extra sg.
771 * Decrement max hw segments accordingly.
773 if (dev->class == ATA_DEV_ATAPI) {
774 request_queue_t *q = sdev->request_queue;
775 blk_queue_max_hw_segments(q, q->max_hw_segments - 1);
778 if (dev->flags & ATA_DFLAG_NCQ) {
779 int depth;
781 depth = min(sdev->host->can_queue, ata_id_queue_depth(dev->id));
782 depth = min(ATA_MAX_QUEUE - 1, depth);
783 scsi_adjust_queue_depth(sdev, MSG_SIMPLE_TAG, depth);
788 * ata_scsi_slave_config - Set SCSI device attributes
789 * @sdev: SCSI device to examine
791 * This is called before we actually start reading
792 * and writing to the device, to configure certain
793 * SCSI mid-layer behaviors.
795 * LOCKING:
796 * Defined by SCSI layer. We don't really care.
799 int ata_scsi_slave_config(struct scsi_device *sdev)
801 struct ata_port *ap = ata_shost_to_port(sdev->host);
802 struct ata_device *dev = __ata_scsi_find_dev(ap, sdev);
804 ata_scsi_sdev_config(sdev);
806 blk_queue_max_phys_segments(sdev->request_queue, LIBATA_MAX_PRD);
808 sdev->manage_start_stop = 1;
810 if (dev)
811 ata_scsi_dev_config(sdev, dev);
813 return 0;
817 * ata_scsi_slave_destroy - SCSI device is about to be destroyed
818 * @sdev: SCSI device to be destroyed
820 * @sdev is about to be destroyed for hot/warm unplugging. If
821 * this unplugging was initiated by libata as indicated by NULL
822 * dev->sdev, this function doesn't have to do anything.
823 * Otherwise, SCSI layer initiated warm-unplug is in progress.
824 * Clear dev->sdev, schedule the device for ATA detach and invoke
825 * EH.
827 * LOCKING:
828 * Defined by SCSI layer. We don't really care.
830 void ata_scsi_slave_destroy(struct scsi_device *sdev)
832 struct ata_port *ap = ata_shost_to_port(sdev->host);
833 unsigned long flags;
834 struct ata_device *dev;
836 if (!ap->ops->error_handler)
837 return;
839 spin_lock_irqsave(ap->lock, flags);
840 dev = __ata_scsi_find_dev(ap, sdev);
841 if (dev && dev->sdev) {
842 /* SCSI device already in CANCEL state, no need to offline it */
843 dev->sdev = NULL;
844 dev->flags |= ATA_DFLAG_DETACH;
845 ata_port_schedule_eh(ap);
847 spin_unlock_irqrestore(ap->lock, flags);
851 * ata_scsi_change_queue_depth - SCSI callback for queue depth config
852 * @sdev: SCSI device to configure queue depth for
853 * @queue_depth: new queue depth
855 * This is libata standard hostt->change_queue_depth callback.
856 * SCSI will call into this callback when user tries to set queue
857 * depth via sysfs.
859 * LOCKING:
860 * SCSI layer (we don't care)
862 * RETURNS:
863 * Newly configured queue depth.
865 int ata_scsi_change_queue_depth(struct scsi_device *sdev, int queue_depth)
867 struct ata_port *ap = ata_shost_to_port(sdev->host);
868 struct ata_device *dev;
869 unsigned long flags;
871 if (queue_depth < 1 || queue_depth == sdev->queue_depth)
872 return sdev->queue_depth;
874 dev = ata_scsi_find_dev(ap, sdev);
875 if (!dev || !ata_dev_enabled(dev))
876 return sdev->queue_depth;
878 /* NCQ enabled? */
879 spin_lock_irqsave(ap->lock, flags);
880 dev->flags &= ~ATA_DFLAG_NCQ_OFF;
881 if (queue_depth == 1 || !ata_ncq_enabled(dev)) {
882 dev->flags |= ATA_DFLAG_NCQ_OFF;
883 queue_depth = 1;
885 spin_unlock_irqrestore(ap->lock, flags);
887 /* limit and apply queue depth */
888 queue_depth = min(queue_depth, sdev->host->can_queue);
889 queue_depth = min(queue_depth, ata_id_queue_depth(dev->id));
890 queue_depth = min(queue_depth, ATA_MAX_QUEUE - 1);
892 if (sdev->queue_depth == queue_depth)
893 return -EINVAL;
895 scsi_adjust_queue_depth(sdev, MSG_SIMPLE_TAG, queue_depth);
896 return queue_depth;
899 /* XXX: for spindown warning */
900 static void ata_delayed_done_timerfn(unsigned long arg)
902 struct scsi_cmnd *scmd = (void *)arg;
904 scmd->scsi_done(scmd);
907 /* XXX: for spindown warning */
908 static void ata_delayed_done(struct scsi_cmnd *scmd)
910 static struct timer_list timer;
912 setup_timer(&timer, ata_delayed_done_timerfn, (unsigned long)scmd);
913 mod_timer(&timer, jiffies + 5 * HZ);
917 * ata_scsi_start_stop_xlat - Translate SCSI START STOP UNIT command
918 * @qc: Storage for translated ATA taskfile
920 * Sets up an ATA taskfile to issue STANDBY (to stop) or READ VERIFY
921 * (to start). Perhaps these commands should be preceded by
922 * CHECK POWER MODE to see what power mode the device is already in.
923 * [See SAT revision 5 at www.t10.org]
925 * LOCKING:
926 * spin_lock_irqsave(host lock)
928 * RETURNS:
929 * Zero on success, non-zero on error.
931 static unsigned int ata_scsi_start_stop_xlat(struct ata_queued_cmd *qc)
933 struct scsi_cmnd *scmd = qc->scsicmd;
934 struct ata_taskfile *tf = &qc->tf;
935 const u8 *cdb = scmd->cmnd;
937 if (scmd->cmd_len < 5)
938 goto invalid_fld;
940 tf->flags |= ATA_TFLAG_DEVICE | ATA_TFLAG_ISADDR;
941 tf->protocol = ATA_PROT_NODATA;
942 if (cdb[1] & 0x1) {
943 ; /* ignore IMMED bit, violates sat-r05 */
945 if (cdb[4] & 0x2)
946 goto invalid_fld; /* LOEJ bit set not supported */
947 if (((cdb[4] >> 4) & 0xf) != 0)
948 goto invalid_fld; /* power conditions not supported */
949 if (cdb[4] & 0x1) {
950 tf->nsect = 1; /* 1 sector, lba=0 */
952 if (qc->dev->flags & ATA_DFLAG_LBA) {
953 tf->flags |= ATA_TFLAG_LBA;
955 tf->lbah = 0x0;
956 tf->lbam = 0x0;
957 tf->lbal = 0x0;
958 tf->device |= ATA_LBA;
959 } else {
960 /* CHS */
961 tf->lbal = 0x1; /* sect */
962 tf->lbam = 0x0; /* cyl low */
963 tf->lbah = 0x0; /* cyl high */
966 tf->command = ATA_CMD_VERIFY; /* READ VERIFY */
967 } else {
968 /* XXX: This is for backward compatibility, will be
969 * removed. Read Documentation/feature-removal-schedule.txt
970 * for more info.
972 if ((qc->dev->flags & ATA_DFLAG_SPUNDOWN) &&
973 (system_state == SYSTEM_HALT ||
974 system_state == SYSTEM_POWER_OFF)) {
975 static unsigned long warned = 0;
977 if (!test_and_set_bit(0, &warned)) {
978 ata_dev_printk(qc->dev, KERN_WARNING,
979 "DISK MIGHT NOT BE SPUN DOWN PROPERLY. "
980 "UPDATE SHUTDOWN UTILITY\n");
981 ata_dev_printk(qc->dev, KERN_WARNING,
982 "For more info, visit "
983 "http://linux-ata.org/shutdown.html\n");
985 /* ->scsi_done is not used, use it for
986 * delayed completion.
988 scmd->scsi_done = qc->scsidone;
989 qc->scsidone = ata_delayed_done;
991 scmd->result = SAM_STAT_GOOD;
992 return 1;
995 /* Issue ATA STANDBY IMMEDIATE command */
996 tf->command = ATA_CMD_STANDBYNOW1;
1000 * Standby and Idle condition timers could be implemented but that
1001 * would require libata to implement the Power condition mode page
1002 * and allow the user to change it. Changing mode pages requires
1003 * MODE SELECT to be implemented.
1006 return 0;
1008 invalid_fld:
1009 ata_scsi_set_sense(scmd, ILLEGAL_REQUEST, 0x24, 0x0);
1010 /* "Invalid field in cbd" */
1011 return 1;
1016 * ata_scsi_flush_xlat - Translate SCSI SYNCHRONIZE CACHE command
1017 * @qc: Storage for translated ATA taskfile
1019 * Sets up an ATA taskfile to issue FLUSH CACHE or
1020 * FLUSH CACHE EXT.
1022 * LOCKING:
1023 * spin_lock_irqsave(host lock)
1025 * RETURNS:
1026 * Zero on success, non-zero on error.
1028 static unsigned int ata_scsi_flush_xlat(struct ata_queued_cmd *qc)
1030 struct ata_taskfile *tf = &qc->tf;
1032 tf->flags |= ATA_TFLAG_DEVICE;
1033 tf->protocol = ATA_PROT_NODATA;
1035 if (qc->dev->flags & ATA_DFLAG_FLUSH_EXT)
1036 tf->command = ATA_CMD_FLUSH_EXT;
1037 else
1038 tf->command = ATA_CMD_FLUSH;
1040 return 0;
1044 * scsi_6_lba_len - Get LBA and transfer length
1045 * @cdb: SCSI command to translate
1047 * Calculate LBA and transfer length for 6-byte commands.
1049 * RETURNS:
1050 * @plba: the LBA
1051 * @plen: the transfer length
1053 static void scsi_6_lba_len(const u8 *cdb, u64 *plba, u32 *plen)
1055 u64 lba = 0;
1056 u32 len;
1058 VPRINTK("six-byte command\n");
1060 lba |= ((u64)(cdb[1] & 0x1f)) << 16;
1061 lba |= ((u64)cdb[2]) << 8;
1062 lba |= ((u64)cdb[3]);
1064 len = cdb[4];
1066 *plba = lba;
1067 *plen = len;
1071 * scsi_10_lba_len - Get LBA and transfer length
1072 * @cdb: SCSI command to translate
1074 * Calculate LBA and transfer length for 10-byte commands.
1076 * RETURNS:
1077 * @plba: the LBA
1078 * @plen: the transfer length
1080 static void scsi_10_lba_len(const u8 *cdb, u64 *plba, u32 *plen)
1082 u64 lba = 0;
1083 u32 len = 0;
1085 VPRINTK("ten-byte command\n");
1087 lba |= ((u64)cdb[2]) << 24;
1088 lba |= ((u64)cdb[3]) << 16;
1089 lba |= ((u64)cdb[4]) << 8;
1090 lba |= ((u64)cdb[5]);
1092 len |= ((u32)cdb[7]) << 8;
1093 len |= ((u32)cdb[8]);
1095 *plba = lba;
1096 *plen = len;
1100 * scsi_16_lba_len - Get LBA and transfer length
1101 * @cdb: SCSI command to translate
1103 * Calculate LBA and transfer length for 16-byte commands.
1105 * RETURNS:
1106 * @plba: the LBA
1107 * @plen: the transfer length
1109 static void scsi_16_lba_len(const u8 *cdb, u64 *plba, u32 *plen)
1111 u64 lba = 0;
1112 u32 len = 0;
1114 VPRINTK("sixteen-byte command\n");
1116 lba |= ((u64)cdb[2]) << 56;
1117 lba |= ((u64)cdb[3]) << 48;
1118 lba |= ((u64)cdb[4]) << 40;
1119 lba |= ((u64)cdb[5]) << 32;
1120 lba |= ((u64)cdb[6]) << 24;
1121 lba |= ((u64)cdb[7]) << 16;
1122 lba |= ((u64)cdb[8]) << 8;
1123 lba |= ((u64)cdb[9]);
1125 len |= ((u32)cdb[10]) << 24;
1126 len |= ((u32)cdb[11]) << 16;
1127 len |= ((u32)cdb[12]) << 8;
1128 len |= ((u32)cdb[13]);
1130 *plba = lba;
1131 *plen = len;
1135 * ata_scsi_verify_xlat - Translate SCSI VERIFY command into an ATA one
1136 * @qc: Storage for translated ATA taskfile
1138 * Converts SCSI VERIFY command to an ATA READ VERIFY command.
1140 * LOCKING:
1141 * spin_lock_irqsave(host lock)
1143 * RETURNS:
1144 * Zero on success, non-zero on error.
1146 static unsigned int ata_scsi_verify_xlat(struct ata_queued_cmd *qc)
1148 struct scsi_cmnd *scmd = qc->scsicmd;
1149 struct ata_taskfile *tf = &qc->tf;
1150 struct ata_device *dev = qc->dev;
1151 u64 dev_sectors = qc->dev->n_sectors;
1152 const u8 *cdb = scmd->cmnd;
1153 u64 block;
1154 u32 n_block;
1156 tf->flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
1157 tf->protocol = ATA_PROT_NODATA;
1159 if (cdb[0] == VERIFY) {
1160 if (scmd->cmd_len < 10)
1161 goto invalid_fld;
1162 scsi_10_lba_len(cdb, &block, &n_block);
1163 } else if (cdb[0] == VERIFY_16) {
1164 if (scmd->cmd_len < 16)
1165 goto invalid_fld;
1166 scsi_16_lba_len(cdb, &block, &n_block);
1167 } else
1168 goto invalid_fld;
1170 if (!n_block)
1171 goto nothing_to_do;
1172 if (block >= dev_sectors)
1173 goto out_of_range;
1174 if ((block + n_block) > dev_sectors)
1175 goto out_of_range;
1177 if (dev->flags & ATA_DFLAG_LBA) {
1178 tf->flags |= ATA_TFLAG_LBA;
1180 if (lba_28_ok(block, n_block)) {
1181 /* use LBA28 */
1182 tf->command = ATA_CMD_VERIFY;
1183 tf->device |= (block >> 24) & 0xf;
1184 } else if (lba_48_ok(block, n_block)) {
1185 if (!(dev->flags & ATA_DFLAG_LBA48))
1186 goto out_of_range;
1188 /* use LBA48 */
1189 tf->flags |= ATA_TFLAG_LBA48;
1190 tf->command = ATA_CMD_VERIFY_EXT;
1192 tf->hob_nsect = (n_block >> 8) & 0xff;
1194 tf->hob_lbah = (block >> 40) & 0xff;
1195 tf->hob_lbam = (block >> 32) & 0xff;
1196 tf->hob_lbal = (block >> 24) & 0xff;
1197 } else
1198 /* request too large even for LBA48 */
1199 goto out_of_range;
1201 tf->nsect = n_block & 0xff;
1203 tf->lbah = (block >> 16) & 0xff;
1204 tf->lbam = (block >> 8) & 0xff;
1205 tf->lbal = block & 0xff;
1207 tf->device |= ATA_LBA;
1208 } else {
1209 /* CHS */
1210 u32 sect, head, cyl, track;
1212 if (!lba_28_ok(block, n_block))
1213 goto out_of_range;
1215 /* Convert LBA to CHS */
1216 track = (u32)block / dev->sectors;
1217 cyl = track / dev->heads;
1218 head = track % dev->heads;
1219 sect = (u32)block % dev->sectors + 1;
1221 DPRINTK("block %u track %u cyl %u head %u sect %u\n",
1222 (u32)block, track, cyl, head, sect);
1224 /* Check whether the converted CHS can fit.
1225 Cylinder: 0-65535
1226 Head: 0-15
1227 Sector: 1-255*/
1228 if ((cyl >> 16) || (head >> 4) || (sect >> 8) || (!sect))
1229 goto out_of_range;
1231 tf->command = ATA_CMD_VERIFY;
1232 tf->nsect = n_block & 0xff; /* Sector count 0 means 256 sectors */
1233 tf->lbal = sect;
1234 tf->lbam = cyl;
1235 tf->lbah = cyl >> 8;
1236 tf->device |= head;
1239 return 0;
1241 invalid_fld:
1242 ata_scsi_set_sense(scmd, ILLEGAL_REQUEST, 0x24, 0x0);
1243 /* "Invalid field in cbd" */
1244 return 1;
1246 out_of_range:
1247 ata_scsi_set_sense(scmd, ILLEGAL_REQUEST, 0x21, 0x0);
1248 /* "Logical Block Address out of range" */
1249 return 1;
1251 nothing_to_do:
1252 scmd->result = SAM_STAT_GOOD;
1253 return 1;
1257 * ata_scsi_rw_xlat - Translate SCSI r/w command into an ATA one
1258 * @qc: Storage for translated ATA taskfile
1260 * Converts any of six SCSI read/write commands into the
1261 * ATA counterpart, including starting sector (LBA),
1262 * sector count, and taking into account the device's LBA48
1263 * support.
1265 * Commands %READ_6, %READ_10, %READ_16, %WRITE_6, %WRITE_10, and
1266 * %WRITE_16 are currently supported.
1268 * LOCKING:
1269 * spin_lock_irqsave(host lock)
1271 * RETURNS:
1272 * Zero on success, non-zero on error.
1274 static unsigned int ata_scsi_rw_xlat(struct ata_queued_cmd *qc)
1276 struct scsi_cmnd *scmd = qc->scsicmd;
1277 const u8 *cdb = scmd->cmnd;
1278 unsigned int tf_flags = 0;
1279 u64 block;
1280 u32 n_block;
1281 int rc;
1283 if (cdb[0] == WRITE_10 || cdb[0] == WRITE_6 || cdb[0] == WRITE_16)
1284 tf_flags |= ATA_TFLAG_WRITE;
1286 /* Calculate the SCSI LBA, transfer length and FUA. */
1287 switch (cdb[0]) {
1288 case READ_10:
1289 case WRITE_10:
1290 if (unlikely(scmd->cmd_len < 10))
1291 goto invalid_fld;
1292 scsi_10_lba_len(cdb, &block, &n_block);
1293 if (unlikely(cdb[1] & (1 << 3)))
1294 tf_flags |= ATA_TFLAG_FUA;
1295 break;
1296 case READ_6:
1297 case WRITE_6:
1298 if (unlikely(scmd->cmd_len < 6))
1299 goto invalid_fld;
1300 scsi_6_lba_len(cdb, &block, &n_block);
1302 /* for 6-byte r/w commands, transfer length 0
1303 * means 256 blocks of data, not 0 block.
1305 if (!n_block)
1306 n_block = 256;
1307 break;
1308 case READ_16:
1309 case WRITE_16:
1310 if (unlikely(scmd->cmd_len < 16))
1311 goto invalid_fld;
1312 scsi_16_lba_len(cdb, &block, &n_block);
1313 if (unlikely(cdb[1] & (1 << 3)))
1314 tf_flags |= ATA_TFLAG_FUA;
1315 break;
1316 default:
1317 DPRINTK("no-byte command\n");
1318 goto invalid_fld;
1321 /* Check and compose ATA command */
1322 if (!n_block)
1323 /* For 10-byte and 16-byte SCSI R/W commands, transfer
1324 * length 0 means transfer 0 block of data.
1325 * However, for ATA R/W commands, sector count 0 means
1326 * 256 or 65536 sectors, not 0 sectors as in SCSI.
1328 * WARNING: one or two older ATA drives treat 0 as 0...
1330 goto nothing_to_do;
1332 qc->flags |= ATA_QCFLAG_IO;
1333 qc->nbytes = n_block * ATA_SECT_SIZE;
1335 rc = ata_build_rw_tf(&qc->tf, qc->dev, block, n_block, tf_flags,
1336 qc->tag);
1337 if (likely(rc == 0))
1338 return 0;
1340 if (rc == -ERANGE)
1341 goto out_of_range;
1342 /* treat all other errors as -EINVAL, fall through */
1343 invalid_fld:
1344 ata_scsi_set_sense(scmd, ILLEGAL_REQUEST, 0x24, 0x0);
1345 /* "Invalid field in cbd" */
1346 return 1;
1348 out_of_range:
1349 ata_scsi_set_sense(scmd, ILLEGAL_REQUEST, 0x21, 0x0);
1350 /* "Logical Block Address out of range" */
1351 return 1;
1353 nothing_to_do:
1354 scmd->result = SAM_STAT_GOOD;
1355 return 1;
1358 static void ata_scsi_qc_complete(struct ata_queued_cmd *qc)
1360 struct ata_port *ap = qc->ap;
1361 struct scsi_cmnd *cmd = qc->scsicmd;
1362 u8 *cdb = cmd->cmnd;
1363 int need_sense = (qc->err_mask != 0);
1365 /* We snoop the SET_FEATURES - Write Cache ON/OFF command, and
1366 * schedule EH_REVALIDATE operation to update the IDENTIFY DEVICE
1367 * cache
1369 if (ap->ops->error_handler && !need_sense) {
1370 switch (qc->tf.command) {
1371 case ATA_CMD_SET_FEATURES:
1372 if ((qc->tf.feature == SETFEATURES_WC_ON) ||
1373 (qc->tf.feature == SETFEATURES_WC_OFF)) {
1374 ap->eh_info.action |= ATA_EH_REVALIDATE;
1375 ata_port_schedule_eh(ap);
1377 break;
1379 case ATA_CMD_INIT_DEV_PARAMS: /* CHS translation changed */
1380 case ATA_CMD_SET_MULTI: /* multi_count changed */
1381 ap->eh_info.action |= ATA_EH_REVALIDATE;
1382 ata_port_schedule_eh(ap);
1383 break;
1387 /* For ATA pass thru (SAT) commands, generate a sense block if
1388 * user mandated it or if there's an error. Note that if we
1389 * generate because the user forced us to, a check condition
1390 * is generated and the ATA register values are returned
1391 * whether the command completed successfully or not. If there
1392 * was no error, SK, ASC and ASCQ will all be zero.
1394 if (((cdb[0] == ATA_16) || (cdb[0] == ATA_12)) &&
1395 ((cdb[2] & 0x20) || need_sense)) {
1396 ata_gen_passthru_sense(qc);
1397 } else {
1398 if (!need_sense) {
1399 cmd->result = SAM_STAT_GOOD;
1400 } else {
1401 /* TODO: decide which descriptor format to use
1402 * for 48b LBA devices and call that here
1403 * instead of the fixed desc, which is only
1404 * good for smaller LBA (and maybe CHS?)
1405 * devices.
1407 ata_gen_ata_sense(qc);
1411 /* XXX: track spindown state for spindown skipping and warning */
1412 if (unlikely(qc->tf.command == ATA_CMD_STANDBY ||
1413 qc->tf.command == ATA_CMD_STANDBYNOW1))
1414 qc->dev->flags |= ATA_DFLAG_SPUNDOWN;
1415 else if (likely(system_state != SYSTEM_HALT &&
1416 system_state != SYSTEM_POWER_OFF))
1417 qc->dev->flags &= ~ATA_DFLAG_SPUNDOWN;
1419 if (need_sense && !ap->ops->error_handler)
1420 ata_dump_status(ap->print_id, &qc->result_tf);
1422 qc->scsidone(cmd);
1424 ata_qc_free(qc);
1428 * ata_scmd_need_defer - Check whether we need to defer scmd
1429 * @dev: ATA device to which the command is addressed
1430 * @is_io: Is the command IO (and thus possibly NCQ)?
1432 * NCQ and non-NCQ commands cannot run together. As upper layer
1433 * only knows the queue depth, we are responsible for maintaining
1434 * exclusion. This function checks whether a new command can be
1435 * issued to @dev.
1437 * LOCKING:
1438 * spin_lock_irqsave(host lock)
1440 * RETURNS:
1441 * 1 if deferring is needed, 0 otherwise.
1443 static int ata_scmd_need_defer(struct ata_device *dev, int is_io)
1445 struct ata_port *ap = dev->ap;
1446 int is_ncq = is_io && ata_ncq_enabled(dev);
1448 if (is_ncq) {
1449 if (!ata_tag_valid(ap->active_tag))
1450 return 0;
1451 } else {
1452 if (!ata_tag_valid(ap->active_tag) && !ap->sactive)
1453 return 0;
1455 return 1;
1459 * ata_scsi_translate - Translate then issue SCSI command to ATA device
1460 * @dev: ATA device to which the command is addressed
1461 * @cmd: SCSI command to execute
1462 * @done: SCSI command completion function
1463 * @xlat_func: Actor which translates @cmd to an ATA taskfile
1465 * Our ->queuecommand() function has decided that the SCSI
1466 * command issued can be directly translated into an ATA
1467 * command, rather than handled internally.
1469 * This function sets up an ata_queued_cmd structure for the
1470 * SCSI command, and sends that ata_queued_cmd to the hardware.
1472 * The xlat_func argument (actor) returns 0 if ready to execute
1473 * ATA command, else 1 to finish translation. If 1 is returned
1474 * then cmd->result (and possibly cmd->sense_buffer) are assumed
1475 * to be set reflecting an error condition or clean (early)
1476 * termination.
1478 * LOCKING:
1479 * spin_lock_irqsave(host lock)
1481 * RETURNS:
1482 * 0 on success, SCSI_ML_QUEUE_DEVICE_BUSY if the command
1483 * needs to be deferred.
1485 static int ata_scsi_translate(struct ata_device *dev, struct scsi_cmnd *cmd,
1486 void (*done)(struct scsi_cmnd *),
1487 ata_xlat_func_t xlat_func)
1489 struct ata_queued_cmd *qc;
1490 int is_io = xlat_func == ata_scsi_rw_xlat;
1492 VPRINTK("ENTER\n");
1494 if (unlikely(ata_scmd_need_defer(dev, is_io)))
1495 goto defer;
1497 qc = ata_scsi_qc_new(dev, cmd, done);
1498 if (!qc)
1499 goto err_mem;
1501 /* data is present; dma-map it */
1502 if (cmd->sc_data_direction == DMA_FROM_DEVICE ||
1503 cmd->sc_data_direction == DMA_TO_DEVICE) {
1504 if (unlikely(cmd->request_bufflen < 1)) {
1505 ata_dev_printk(dev, KERN_WARNING,
1506 "WARNING: zero len r/w req\n");
1507 goto err_did;
1510 if (cmd->use_sg)
1511 ata_sg_init(qc, cmd->request_buffer, cmd->use_sg);
1512 else
1513 ata_sg_init_one(qc, cmd->request_buffer,
1514 cmd->request_bufflen);
1516 qc->dma_dir = cmd->sc_data_direction;
1519 qc->complete_fn = ata_scsi_qc_complete;
1521 if (xlat_func(qc))
1522 goto early_finish;
1524 /* select device, send command to hardware */
1525 ata_qc_issue(qc);
1527 VPRINTK("EXIT\n");
1528 return 0;
1530 early_finish:
1531 ata_qc_free(qc);
1532 qc->scsidone(cmd);
1533 DPRINTK("EXIT - early finish (good or error)\n");
1534 return 0;
1536 err_did:
1537 ata_qc_free(qc);
1538 cmd->result = (DID_ERROR << 16);
1539 qc->scsidone(cmd);
1540 err_mem:
1541 DPRINTK("EXIT - internal\n");
1542 return 0;
1544 defer:
1545 DPRINTK("EXIT - defer\n");
1546 return SCSI_MLQUEUE_DEVICE_BUSY;
1550 * ata_scsi_rbuf_get - Map response buffer.
1551 * @cmd: SCSI command containing buffer to be mapped.
1552 * @buf_out: Pointer to mapped area.
1554 * Maps buffer contained within SCSI command @cmd.
1556 * LOCKING:
1557 * spin_lock_irqsave(host lock)
1559 * RETURNS:
1560 * Length of response buffer.
1563 static unsigned int ata_scsi_rbuf_get(struct scsi_cmnd *cmd, u8 **buf_out)
1565 u8 *buf;
1566 unsigned int buflen;
1568 if (cmd->use_sg) {
1569 struct scatterlist *sg;
1571 sg = (struct scatterlist *) cmd->request_buffer;
1572 buf = kmap_atomic(sg->page, KM_IRQ0) + sg->offset;
1573 buflen = sg->length;
1574 } else {
1575 buf = cmd->request_buffer;
1576 buflen = cmd->request_bufflen;
1579 *buf_out = buf;
1580 return buflen;
1584 * ata_scsi_rbuf_put - Unmap response buffer.
1585 * @cmd: SCSI command containing buffer to be unmapped.
1586 * @buf: buffer to unmap
1588 * Unmaps response buffer contained within @cmd.
1590 * LOCKING:
1591 * spin_lock_irqsave(host lock)
1594 static inline void ata_scsi_rbuf_put(struct scsi_cmnd *cmd, u8 *buf)
1596 if (cmd->use_sg) {
1597 struct scatterlist *sg;
1599 sg = (struct scatterlist *) cmd->request_buffer;
1600 kunmap_atomic(buf - sg->offset, KM_IRQ0);
1605 * ata_scsi_rbuf_fill - wrapper for SCSI command simulators
1606 * @args: device IDENTIFY data / SCSI command of interest.
1607 * @actor: Callback hook for desired SCSI command simulator
1609 * Takes care of the hard work of simulating a SCSI command...
1610 * Mapping the response buffer, calling the command's handler,
1611 * and handling the handler's return value. This return value
1612 * indicates whether the handler wishes the SCSI command to be
1613 * completed successfully (0), or not (in which case cmd->result
1614 * and sense buffer are assumed to be set).
1616 * LOCKING:
1617 * spin_lock_irqsave(host lock)
1620 void ata_scsi_rbuf_fill(struct ata_scsi_args *args,
1621 unsigned int (*actor) (struct ata_scsi_args *args,
1622 u8 *rbuf, unsigned int buflen))
1624 u8 *rbuf;
1625 unsigned int buflen, rc;
1626 struct scsi_cmnd *cmd = args->cmd;
1628 buflen = ata_scsi_rbuf_get(cmd, &rbuf);
1629 memset(rbuf, 0, buflen);
1630 rc = actor(args, rbuf, buflen);
1631 ata_scsi_rbuf_put(cmd, rbuf);
1633 if (rc == 0)
1634 cmd->result = SAM_STAT_GOOD;
1635 args->done(cmd);
1639 * ATA_SCSI_RBUF_SET - helper to set values in SCSI response buffer
1640 * @idx: byte index into SCSI response buffer
1641 * @val: value to set
1643 * To be used by SCSI command simulator functions. This macros
1644 * expects two local variables, u8 *rbuf and unsigned int buflen,
1645 * are in scope.
1647 * LOCKING:
1648 * None.
1650 #define ATA_SCSI_RBUF_SET(idx, val) do { \
1651 if ((idx) < buflen) rbuf[(idx)] = (u8)(val); \
1652 } while (0)
1655 * ata_scsiop_inq_std - Simulate INQUIRY command
1656 * @args: device IDENTIFY data / SCSI command of interest.
1657 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1658 * @buflen: Response buffer length.
1660 * Returns standard device identification data associated
1661 * with non-VPD INQUIRY command output.
1663 * LOCKING:
1664 * spin_lock_irqsave(host lock)
1667 unsigned int ata_scsiop_inq_std(struct ata_scsi_args *args, u8 *rbuf,
1668 unsigned int buflen)
1670 u8 hdr[] = {
1671 TYPE_DISK,
1673 0x5, /* claim SPC-3 version compatibility */
1675 95 - 4
1678 /* set scsi removeable (RMB) bit per ata bit */
1679 if (ata_id_removeable(args->id))
1680 hdr[1] |= (1 << 7);
1682 VPRINTK("ENTER\n");
1684 memcpy(rbuf, hdr, sizeof(hdr));
1686 if (buflen > 35) {
1687 memcpy(&rbuf[8], "ATA ", 8);
1688 ata_id_string(args->id, &rbuf[16], ATA_ID_PROD, 16);
1689 ata_id_string(args->id, &rbuf[32], ATA_ID_FW_REV, 4);
1690 if (rbuf[32] == 0 || rbuf[32] == ' ')
1691 memcpy(&rbuf[32], "n/a ", 4);
1694 if (buflen > 63) {
1695 const u8 versions[] = {
1696 0x60, /* SAM-3 (no version claimed) */
1698 0x03,
1699 0x20, /* SBC-2 (no version claimed) */
1701 0x02,
1702 0x60 /* SPC-3 (no version claimed) */
1705 memcpy(rbuf + 59, versions, sizeof(versions));
1708 return 0;
1712 * ata_scsiop_inq_00 - Simulate INQUIRY VPD page 0, list of pages
1713 * @args: device IDENTIFY data / SCSI command of interest.
1714 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1715 * @buflen: Response buffer length.
1717 * Returns list of inquiry VPD pages available.
1719 * LOCKING:
1720 * spin_lock_irqsave(host lock)
1723 unsigned int ata_scsiop_inq_00(struct ata_scsi_args *args, u8 *rbuf,
1724 unsigned int buflen)
1726 const u8 pages[] = {
1727 0x00, /* page 0x00, this page */
1728 0x80, /* page 0x80, unit serial no page */
1729 0x83 /* page 0x83, device ident page */
1731 rbuf[3] = sizeof(pages); /* number of supported VPD pages */
1733 if (buflen > 6)
1734 memcpy(rbuf + 4, pages, sizeof(pages));
1736 return 0;
1740 * ata_scsiop_inq_80 - Simulate INQUIRY VPD page 80, device serial number
1741 * @args: device IDENTIFY data / SCSI command of interest.
1742 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1743 * @buflen: Response buffer length.
1745 * Returns ATA device serial number.
1747 * LOCKING:
1748 * spin_lock_irqsave(host lock)
1751 unsigned int ata_scsiop_inq_80(struct ata_scsi_args *args, u8 *rbuf,
1752 unsigned int buflen)
1754 const u8 hdr[] = {
1756 0x80, /* this page code */
1758 ATA_ID_SERNO_LEN, /* page len */
1760 memcpy(rbuf, hdr, sizeof(hdr));
1762 if (buflen > (ATA_ID_SERNO_LEN + 4 - 1))
1763 ata_id_string(args->id, (unsigned char *) &rbuf[4],
1764 ATA_ID_SERNO, ATA_ID_SERNO_LEN);
1766 return 0;
1770 * ata_scsiop_inq_83 - Simulate INQUIRY VPD page 83, device identity
1771 * @args: device IDENTIFY data / SCSI command of interest.
1772 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1773 * @buflen: Response buffer length.
1775 * Yields two logical unit device identification designators:
1776 * - vendor specific ASCII containing the ATA serial number
1777 * - SAT defined "t10 vendor id based" containing ASCII vendor
1778 * name ("ATA "), model and serial numbers.
1780 * LOCKING:
1781 * spin_lock_irqsave(host lock)
1784 unsigned int ata_scsiop_inq_83(struct ata_scsi_args *args, u8 *rbuf,
1785 unsigned int buflen)
1787 int num;
1788 const int sat_model_serial_desc_len = 68;
1790 rbuf[1] = 0x83; /* this page code */
1791 num = 4;
1793 if (buflen > (ATA_ID_SERNO_LEN + num + 3)) {
1794 /* piv=0, assoc=lu, code_set=ACSII, designator=vendor */
1795 rbuf[num + 0] = 2;
1796 rbuf[num + 3] = ATA_ID_SERNO_LEN;
1797 num += 4;
1798 ata_id_string(args->id, (unsigned char *) rbuf + num,
1799 ATA_ID_SERNO, ATA_ID_SERNO_LEN);
1800 num += ATA_ID_SERNO_LEN;
1802 if (buflen > (sat_model_serial_desc_len + num + 3)) {
1803 /* SAT defined lu model and serial numbers descriptor */
1804 /* piv=0, assoc=lu, code_set=ACSII, designator=t10 vendor id */
1805 rbuf[num + 0] = 2;
1806 rbuf[num + 1] = 1;
1807 rbuf[num + 3] = sat_model_serial_desc_len;
1808 num += 4;
1809 memcpy(rbuf + num, "ATA ", 8);
1810 num += 8;
1811 ata_id_string(args->id, (unsigned char *) rbuf + num,
1812 ATA_ID_PROD, ATA_ID_PROD_LEN);
1813 num += ATA_ID_PROD_LEN;
1814 ata_id_string(args->id, (unsigned char *) rbuf + num,
1815 ATA_ID_SERNO, ATA_ID_SERNO_LEN);
1816 num += ATA_ID_SERNO_LEN;
1818 rbuf[3] = num - 4; /* page len (assume less than 256 bytes) */
1819 return 0;
1823 * ata_scsiop_noop - Command handler that simply returns success.
1824 * @args: device IDENTIFY data / SCSI command of interest.
1825 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1826 * @buflen: Response buffer length.
1828 * No operation. Simply returns success to caller, to indicate
1829 * that the caller should successfully complete this SCSI command.
1831 * LOCKING:
1832 * spin_lock_irqsave(host lock)
1835 unsigned int ata_scsiop_noop(struct ata_scsi_args *args, u8 *rbuf,
1836 unsigned int buflen)
1838 VPRINTK("ENTER\n");
1839 return 0;
1843 * ata_msense_push - Push data onto MODE SENSE data output buffer
1844 * @ptr_io: (input/output) Location to store more output data
1845 * @last: End of output data buffer
1846 * @buf: Pointer to BLOB being added to output buffer
1847 * @buflen: Length of BLOB
1849 * Store MODE SENSE data on an output buffer.
1851 * LOCKING:
1852 * None.
1855 static void ata_msense_push(u8 **ptr_io, const u8 *last,
1856 const u8 *buf, unsigned int buflen)
1858 u8 *ptr = *ptr_io;
1860 if ((ptr + buflen - 1) > last)
1861 return;
1863 memcpy(ptr, buf, buflen);
1865 ptr += buflen;
1867 *ptr_io = ptr;
1871 * ata_msense_caching - Simulate MODE SENSE caching info page
1872 * @id: device IDENTIFY data
1873 * @ptr_io: (input/output) Location to store more output data
1874 * @last: End of output data buffer
1876 * Generate a caching info page, which conditionally indicates
1877 * write caching to the SCSI layer, depending on device
1878 * capabilities.
1880 * LOCKING:
1881 * None.
1884 static unsigned int ata_msense_caching(u16 *id, u8 **ptr_io,
1885 const u8 *last)
1887 u8 page[CACHE_MPAGE_LEN];
1889 memcpy(page, def_cache_mpage, sizeof(page));
1890 if (ata_id_wcache_enabled(id))
1891 page[2] |= (1 << 2); /* write cache enable */
1892 if (!ata_id_rahead_enabled(id))
1893 page[12] |= (1 << 5); /* disable read ahead */
1895 ata_msense_push(ptr_io, last, page, sizeof(page));
1896 return sizeof(page);
1900 * ata_msense_ctl_mode - Simulate MODE SENSE control mode page
1901 * @dev: Device associated with this MODE SENSE command
1902 * @ptr_io: (input/output) Location to store more output data
1903 * @last: End of output data buffer
1905 * Generate a generic MODE SENSE control mode page.
1907 * LOCKING:
1908 * None.
1911 static unsigned int ata_msense_ctl_mode(u8 **ptr_io, const u8 *last)
1913 ata_msense_push(ptr_io, last, def_control_mpage,
1914 sizeof(def_control_mpage));
1915 return sizeof(def_control_mpage);
1919 * ata_msense_rw_recovery - Simulate MODE SENSE r/w error recovery page
1920 * @dev: Device associated with this MODE SENSE command
1921 * @ptr_io: (input/output) Location to store more output data
1922 * @last: End of output data buffer
1924 * Generate a generic MODE SENSE r/w error recovery page.
1926 * LOCKING:
1927 * None.
1930 static unsigned int ata_msense_rw_recovery(u8 **ptr_io, const u8 *last)
1933 ata_msense_push(ptr_io, last, def_rw_recovery_mpage,
1934 sizeof(def_rw_recovery_mpage));
1935 return sizeof(def_rw_recovery_mpage);
1939 * We can turn this into a real blacklist if it's needed, for now just
1940 * blacklist any Maxtor BANC1G10 revision firmware
1942 static int ata_dev_supports_fua(u16 *id)
1944 unsigned char model[ATA_ID_PROD_LEN + 1], fw[ATA_ID_FW_REV_LEN + 1];
1946 if (!libata_fua)
1947 return 0;
1948 if (!ata_id_has_fua(id))
1949 return 0;
1951 ata_id_c_string(id, model, ATA_ID_PROD, sizeof(model));
1952 ata_id_c_string(id, fw, ATA_ID_FW_REV, sizeof(fw));
1954 if (strcmp(model, "Maxtor"))
1955 return 1;
1956 if (strcmp(fw, "BANC1G10"))
1957 return 1;
1959 return 0; /* blacklisted */
1963 * ata_scsiop_mode_sense - Simulate MODE SENSE 6, 10 commands
1964 * @args: device IDENTIFY data / SCSI command of interest.
1965 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1966 * @buflen: Response buffer length.
1968 * Simulate MODE SENSE commands. Assume this is invoked for direct
1969 * access devices (e.g. disks) only. There should be no block
1970 * descriptor for other device types.
1972 * LOCKING:
1973 * spin_lock_irqsave(host lock)
1976 unsigned int ata_scsiop_mode_sense(struct ata_scsi_args *args, u8 *rbuf,
1977 unsigned int buflen)
1979 struct ata_device *dev = args->dev;
1980 u8 *scsicmd = args->cmd->cmnd, *p, *last;
1981 const u8 sat_blk_desc[] = {
1982 0, 0, 0, 0, /* number of blocks: sat unspecified */
1984 0, 0x2, 0x0 /* block length: 512 bytes */
1986 u8 pg, spg;
1987 unsigned int ebd, page_control, six_byte, output_len, alloc_len, minlen;
1988 u8 dpofua;
1990 VPRINTK("ENTER\n");
1992 six_byte = (scsicmd[0] == MODE_SENSE);
1993 ebd = !(scsicmd[1] & 0x8); /* dbd bit inverted == edb */
1995 * LLBA bit in msense(10) ignored (compliant)
1998 page_control = scsicmd[2] >> 6;
1999 switch (page_control) {
2000 case 0: /* current */
2001 break; /* supported */
2002 case 3: /* saved */
2003 goto saving_not_supp;
2004 case 1: /* changeable */
2005 case 2: /* defaults */
2006 default:
2007 goto invalid_fld;
2010 if (six_byte) {
2011 output_len = 4 + (ebd ? 8 : 0);
2012 alloc_len = scsicmd[4];
2013 } else {
2014 output_len = 8 + (ebd ? 8 : 0);
2015 alloc_len = (scsicmd[7] << 8) + scsicmd[8];
2017 minlen = (alloc_len < buflen) ? alloc_len : buflen;
2019 p = rbuf + output_len;
2020 last = rbuf + minlen - 1;
2022 pg = scsicmd[2] & 0x3f;
2023 spg = scsicmd[3];
2025 * No mode subpages supported (yet) but asking for _all_
2026 * subpages may be valid
2028 if (spg && (spg != ALL_SUB_MPAGES))
2029 goto invalid_fld;
2031 switch(pg) {
2032 case RW_RECOVERY_MPAGE:
2033 output_len += ata_msense_rw_recovery(&p, last);
2034 break;
2036 case CACHE_MPAGE:
2037 output_len += ata_msense_caching(args->id, &p, last);
2038 break;
2040 case CONTROL_MPAGE: {
2041 output_len += ata_msense_ctl_mode(&p, last);
2042 break;
2045 case ALL_MPAGES:
2046 output_len += ata_msense_rw_recovery(&p, last);
2047 output_len += ata_msense_caching(args->id, &p, last);
2048 output_len += ata_msense_ctl_mode(&p, last);
2049 break;
2051 default: /* invalid page code */
2052 goto invalid_fld;
2055 if (minlen < 1)
2056 return 0;
2058 dpofua = 0;
2059 if (ata_dev_supports_fua(args->id) && (dev->flags & ATA_DFLAG_LBA48) &&
2060 (!(dev->flags & ATA_DFLAG_PIO) || dev->multi_count))
2061 dpofua = 1 << 4;
2063 if (six_byte) {
2064 output_len--;
2065 rbuf[0] = output_len;
2066 if (minlen > 2)
2067 rbuf[2] |= dpofua;
2068 if (ebd) {
2069 if (minlen > 3)
2070 rbuf[3] = sizeof(sat_blk_desc);
2071 if (minlen > 11)
2072 memcpy(rbuf + 4, sat_blk_desc,
2073 sizeof(sat_blk_desc));
2075 } else {
2076 output_len -= 2;
2077 rbuf[0] = output_len >> 8;
2078 if (minlen > 1)
2079 rbuf[1] = output_len;
2080 if (minlen > 3)
2081 rbuf[3] |= dpofua;
2082 if (ebd) {
2083 if (minlen > 7)
2084 rbuf[7] = sizeof(sat_blk_desc);
2085 if (minlen > 15)
2086 memcpy(rbuf + 8, sat_blk_desc,
2087 sizeof(sat_blk_desc));
2090 return 0;
2092 invalid_fld:
2093 ata_scsi_set_sense(args->cmd, ILLEGAL_REQUEST, 0x24, 0x0);
2094 /* "Invalid field in cbd" */
2095 return 1;
2097 saving_not_supp:
2098 ata_scsi_set_sense(args->cmd, ILLEGAL_REQUEST, 0x39, 0x0);
2099 /* "Saving parameters not supported" */
2100 return 1;
2104 * ata_scsiop_read_cap - Simulate READ CAPACITY[ 16] commands
2105 * @args: device IDENTIFY data / SCSI command of interest.
2106 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2107 * @buflen: Response buffer length.
2109 * Simulate READ CAPACITY commands.
2111 * LOCKING:
2112 * None.
2114 unsigned int ata_scsiop_read_cap(struct ata_scsi_args *args, u8 *rbuf,
2115 unsigned int buflen)
2117 u64 last_lba = args->dev->n_sectors - 1; /* LBA of the last block */
2119 VPRINTK("ENTER\n");
2121 if (args->cmd->cmnd[0] == READ_CAPACITY) {
2122 if (last_lba >= 0xffffffffULL)
2123 last_lba = 0xffffffff;
2125 /* sector count, 32-bit */
2126 ATA_SCSI_RBUF_SET(0, last_lba >> (8 * 3));
2127 ATA_SCSI_RBUF_SET(1, last_lba >> (8 * 2));
2128 ATA_SCSI_RBUF_SET(2, last_lba >> (8 * 1));
2129 ATA_SCSI_RBUF_SET(3, last_lba);
2131 /* sector size */
2132 ATA_SCSI_RBUF_SET(6, ATA_SECT_SIZE >> 8);
2133 ATA_SCSI_RBUF_SET(7, ATA_SECT_SIZE);
2134 } else {
2135 /* sector count, 64-bit */
2136 ATA_SCSI_RBUF_SET(0, last_lba >> (8 * 7));
2137 ATA_SCSI_RBUF_SET(1, last_lba >> (8 * 6));
2138 ATA_SCSI_RBUF_SET(2, last_lba >> (8 * 5));
2139 ATA_SCSI_RBUF_SET(3, last_lba >> (8 * 4));
2140 ATA_SCSI_RBUF_SET(4, last_lba >> (8 * 3));
2141 ATA_SCSI_RBUF_SET(5, last_lba >> (8 * 2));
2142 ATA_SCSI_RBUF_SET(6, last_lba >> (8 * 1));
2143 ATA_SCSI_RBUF_SET(7, last_lba);
2145 /* sector size */
2146 ATA_SCSI_RBUF_SET(10, ATA_SECT_SIZE >> 8);
2147 ATA_SCSI_RBUF_SET(11, ATA_SECT_SIZE);
2150 return 0;
2154 * ata_scsiop_report_luns - Simulate REPORT LUNS command
2155 * @args: device IDENTIFY data / SCSI command of interest.
2156 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2157 * @buflen: Response buffer length.
2159 * Simulate REPORT LUNS command.
2161 * LOCKING:
2162 * spin_lock_irqsave(host lock)
2165 unsigned int ata_scsiop_report_luns(struct ata_scsi_args *args, u8 *rbuf,
2166 unsigned int buflen)
2168 VPRINTK("ENTER\n");
2169 rbuf[3] = 8; /* just one lun, LUN 0, size 8 bytes */
2171 return 0;
2175 * ata_scsi_set_sense - Set SCSI sense data and status
2176 * @cmd: SCSI request to be handled
2177 * @sk: SCSI-defined sense key
2178 * @asc: SCSI-defined additional sense code
2179 * @ascq: SCSI-defined additional sense code qualifier
2181 * Helper function that builds a valid fixed format, current
2182 * response code and the given sense key (sk), additional sense
2183 * code (asc) and additional sense code qualifier (ascq) with
2184 * a SCSI command status of %SAM_STAT_CHECK_CONDITION and
2185 * DRIVER_SENSE set in the upper bits of scsi_cmnd::result .
2187 * LOCKING:
2188 * Not required
2191 void ata_scsi_set_sense(struct scsi_cmnd *cmd, u8 sk, u8 asc, u8 ascq)
2193 cmd->result = (DRIVER_SENSE << 24) | SAM_STAT_CHECK_CONDITION;
2195 cmd->sense_buffer[0] = 0x70; /* fixed format, current */
2196 cmd->sense_buffer[2] = sk;
2197 cmd->sense_buffer[7] = 18 - 8; /* additional sense length */
2198 cmd->sense_buffer[12] = asc;
2199 cmd->sense_buffer[13] = ascq;
2203 * ata_scsi_badcmd - End a SCSI request with an error
2204 * @cmd: SCSI request to be handled
2205 * @done: SCSI command completion function
2206 * @asc: SCSI-defined additional sense code
2207 * @ascq: SCSI-defined additional sense code qualifier
2209 * Helper function that completes a SCSI command with
2210 * %SAM_STAT_CHECK_CONDITION, with a sense key %ILLEGAL_REQUEST
2211 * and the specified additional sense codes.
2213 * LOCKING:
2214 * spin_lock_irqsave(host lock)
2217 void ata_scsi_badcmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *), u8 asc, u8 ascq)
2219 DPRINTK("ENTER\n");
2220 ata_scsi_set_sense(cmd, ILLEGAL_REQUEST, asc, ascq);
2222 done(cmd);
2225 static void atapi_sense_complete(struct ata_queued_cmd *qc)
2227 if (qc->err_mask && ((qc->err_mask & AC_ERR_DEV) == 0)) {
2228 /* FIXME: not quite right; we don't want the
2229 * translation of taskfile registers into
2230 * a sense descriptors, since that's only
2231 * correct for ATA, not ATAPI
2233 ata_gen_passthru_sense(qc);
2236 qc->scsidone(qc->scsicmd);
2237 ata_qc_free(qc);
2240 /* is it pointless to prefer PIO for "safety reasons"? */
2241 static inline int ata_pio_use_silly(struct ata_port *ap)
2243 return (ap->flags & ATA_FLAG_PIO_DMA);
2246 static void atapi_request_sense(struct ata_queued_cmd *qc)
2248 struct ata_port *ap = qc->ap;
2249 struct scsi_cmnd *cmd = qc->scsicmd;
2251 DPRINTK("ATAPI request sense\n");
2253 /* FIXME: is this needed? */
2254 memset(cmd->sense_buffer, 0, sizeof(cmd->sense_buffer));
2256 ap->ops->tf_read(ap, &qc->tf);
2258 /* fill these in, for the case where they are -not- overwritten */
2259 cmd->sense_buffer[0] = 0x70;
2260 cmd->sense_buffer[2] = qc->tf.feature >> 4;
2262 ata_qc_reinit(qc);
2264 ata_sg_init_one(qc, cmd->sense_buffer, sizeof(cmd->sense_buffer));
2265 qc->dma_dir = DMA_FROM_DEVICE;
2267 memset(&qc->cdb, 0, qc->dev->cdb_len);
2268 qc->cdb[0] = REQUEST_SENSE;
2269 qc->cdb[4] = SCSI_SENSE_BUFFERSIZE;
2271 qc->tf.flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
2272 qc->tf.command = ATA_CMD_PACKET;
2274 if (ata_pio_use_silly(ap)) {
2275 qc->tf.protocol = ATA_PROT_ATAPI_DMA;
2276 qc->tf.feature |= ATAPI_PKT_DMA;
2277 } else {
2278 qc->tf.protocol = ATA_PROT_ATAPI;
2279 qc->tf.lbam = (8 * 1024) & 0xff;
2280 qc->tf.lbah = (8 * 1024) >> 8;
2282 qc->nbytes = SCSI_SENSE_BUFFERSIZE;
2284 qc->complete_fn = atapi_sense_complete;
2286 ata_qc_issue(qc);
2288 DPRINTK("EXIT\n");
2291 static void atapi_qc_complete(struct ata_queued_cmd *qc)
2293 struct scsi_cmnd *cmd = qc->scsicmd;
2294 unsigned int err_mask = qc->err_mask;
2296 VPRINTK("ENTER, err_mask 0x%X\n", err_mask);
2298 /* handle completion from new EH */
2299 if (unlikely(qc->ap->ops->error_handler &&
2300 (err_mask || qc->flags & ATA_QCFLAG_SENSE_VALID))) {
2302 if (!(qc->flags & ATA_QCFLAG_SENSE_VALID)) {
2303 /* FIXME: not quite right; we don't want the
2304 * translation of taskfile registers into a
2305 * sense descriptors, since that's only
2306 * correct for ATA, not ATAPI
2308 ata_gen_passthru_sense(qc);
2311 /* SCSI EH automatically locks door if sdev->locked is
2312 * set. Sometimes door lock request continues to
2313 * fail, for example, when no media is present. This
2314 * creates a loop - SCSI EH issues door lock which
2315 * fails and gets invoked again to acquire sense data
2316 * for the failed command.
2318 * If door lock fails, always clear sdev->locked to
2319 * avoid this infinite loop.
2321 if (qc->cdb[0] == ALLOW_MEDIUM_REMOVAL)
2322 qc->dev->sdev->locked = 0;
2324 qc->scsicmd->result = SAM_STAT_CHECK_CONDITION;
2325 qc->scsidone(cmd);
2326 ata_qc_free(qc);
2327 return;
2330 /* successful completion or old EH failure path */
2331 if (unlikely(err_mask & AC_ERR_DEV)) {
2332 cmd->result = SAM_STAT_CHECK_CONDITION;
2333 atapi_request_sense(qc);
2334 return;
2335 } else if (unlikely(err_mask)) {
2336 /* FIXME: not quite right; we don't want the
2337 * translation of taskfile registers into
2338 * a sense descriptors, since that's only
2339 * correct for ATA, not ATAPI
2341 ata_gen_passthru_sense(qc);
2342 } else {
2343 u8 *scsicmd = cmd->cmnd;
2345 if ((scsicmd[0] == INQUIRY) && ((scsicmd[1] & 0x03) == 0)) {
2346 u8 *buf = NULL;
2347 unsigned int buflen;
2349 buflen = ata_scsi_rbuf_get(cmd, &buf);
2351 /* ATAPI devices typically report zero for their SCSI version,
2352 * and sometimes deviate from the spec WRT response data
2353 * format. If SCSI version is reported as zero like normal,
2354 * then we make the following fixups: 1) Fake MMC-5 version,
2355 * to indicate to the Linux scsi midlayer this is a modern
2356 * device. 2) Ensure response data format / ATAPI information
2357 * are always correct.
2359 if (buf[2] == 0) {
2360 buf[2] = 0x5;
2361 buf[3] = 0x32;
2364 ata_scsi_rbuf_put(cmd, buf);
2367 cmd->result = SAM_STAT_GOOD;
2370 qc->scsidone(cmd);
2371 ata_qc_free(qc);
2374 * atapi_xlat - Initialize PACKET taskfile
2375 * @qc: command structure to be initialized
2377 * LOCKING:
2378 * spin_lock_irqsave(host lock)
2380 * RETURNS:
2381 * Zero on success, non-zero on failure.
2383 static unsigned int atapi_xlat(struct ata_queued_cmd *qc)
2385 struct scsi_cmnd *scmd = qc->scsicmd;
2386 struct ata_device *dev = qc->dev;
2387 int using_pio = (dev->flags & ATA_DFLAG_PIO);
2388 int nodata = (scmd->sc_data_direction == DMA_NONE);
2390 memset(qc->cdb, 0, dev->cdb_len);
2391 memcpy(qc->cdb, scmd->cmnd, scmd->cmd_len);
2393 qc->complete_fn = atapi_qc_complete;
2395 qc->tf.flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
2396 if (scmd->sc_data_direction == DMA_TO_DEVICE) {
2397 qc->tf.flags |= ATA_TFLAG_WRITE;
2398 DPRINTK("direction: write\n");
2401 qc->tf.command = ATA_CMD_PACKET;
2402 qc->nbytes = scmd->request_bufflen;
2404 /* check whether ATAPI DMA is safe */
2405 if (!using_pio && ata_check_atapi_dma(qc))
2406 using_pio = 1;
2408 if (using_pio || nodata) {
2409 /* no data, or PIO data xfer */
2410 if (nodata)
2411 qc->tf.protocol = ATA_PROT_ATAPI_NODATA;
2412 else
2413 qc->tf.protocol = ATA_PROT_ATAPI;
2414 qc->tf.lbam = (8 * 1024) & 0xff;
2415 qc->tf.lbah = (8 * 1024) >> 8;
2416 } else {
2417 /* DMA data xfer */
2418 qc->tf.protocol = ATA_PROT_ATAPI_DMA;
2419 qc->tf.feature |= ATAPI_PKT_DMA;
2421 if (atapi_dmadir && (scmd->sc_data_direction != DMA_TO_DEVICE))
2422 /* some SATA bridges need us to indicate data xfer direction */
2423 qc->tf.feature |= ATAPI_DMADIR;
2426 return 0;
2429 static struct ata_device * ata_find_dev(struct ata_port *ap, int id)
2431 if (likely(id < ATA_MAX_DEVICES))
2432 return &ap->device[id];
2433 return NULL;
2436 static struct ata_device * __ata_scsi_find_dev(struct ata_port *ap,
2437 const struct scsi_device *scsidev)
2439 /* skip commands not addressed to targets we simulate */
2440 if (unlikely(scsidev->channel || scsidev->lun))
2441 return NULL;
2443 return ata_find_dev(ap, scsidev->id);
2447 * ata_scsi_dev_enabled - determine if device is enabled
2448 * @dev: ATA device
2450 * Determine if commands should be sent to the specified device.
2452 * LOCKING:
2453 * spin_lock_irqsave(host lock)
2455 * RETURNS:
2456 * 0 if commands are not allowed / 1 if commands are allowed
2459 static int ata_scsi_dev_enabled(struct ata_device *dev)
2461 if (unlikely(!ata_dev_enabled(dev)))
2462 return 0;
2464 if (!atapi_enabled || (dev->ap->flags & ATA_FLAG_NO_ATAPI)) {
2465 if (unlikely(dev->class == ATA_DEV_ATAPI)) {
2466 ata_dev_printk(dev, KERN_WARNING,
2467 "WARNING: ATAPI is %s, device ignored.\n",
2468 atapi_enabled ? "not supported with this driver" : "disabled");
2469 return 0;
2473 return 1;
2477 * ata_scsi_find_dev - lookup ata_device from scsi_cmnd
2478 * @ap: ATA port to which the device is attached
2479 * @scsidev: SCSI device from which we derive the ATA device
2481 * Given various information provided in struct scsi_cmnd,
2482 * map that onto an ATA bus, and using that mapping
2483 * determine which ata_device is associated with the
2484 * SCSI command to be sent.
2486 * LOCKING:
2487 * spin_lock_irqsave(host lock)
2489 * RETURNS:
2490 * Associated ATA device, or %NULL if not found.
2492 static struct ata_device *
2493 ata_scsi_find_dev(struct ata_port *ap, const struct scsi_device *scsidev)
2495 struct ata_device *dev = __ata_scsi_find_dev(ap, scsidev);
2497 if (unlikely(!dev || !ata_scsi_dev_enabled(dev)))
2498 return NULL;
2500 return dev;
2504 * ata_scsi_map_proto - Map pass-thru protocol value to taskfile value.
2505 * @byte1: Byte 1 from pass-thru CDB.
2507 * RETURNS:
2508 * ATA_PROT_UNKNOWN if mapping failed/unimplemented, protocol otherwise.
2510 static u8
2511 ata_scsi_map_proto(u8 byte1)
2513 switch((byte1 & 0x1e) >> 1) {
2514 case 3: /* Non-data */
2515 return ATA_PROT_NODATA;
2517 case 6: /* DMA */
2518 case 10: /* UDMA Data-in */
2519 case 11: /* UDMA Data-Out */
2520 return ATA_PROT_DMA;
2522 case 4: /* PIO Data-in */
2523 case 5: /* PIO Data-out */
2524 return ATA_PROT_PIO;
2526 case 0: /* Hard Reset */
2527 case 1: /* SRST */
2528 case 8: /* Device Diagnostic */
2529 case 9: /* Device Reset */
2530 case 7: /* DMA Queued */
2531 case 12: /* FPDMA */
2532 case 15: /* Return Response Info */
2533 default: /* Reserved */
2534 break;
2537 return ATA_PROT_UNKNOWN;
2541 * ata_scsi_pass_thru - convert ATA pass-thru CDB to taskfile
2542 * @qc: command structure to be initialized
2544 * Handles either 12 or 16-byte versions of the CDB.
2546 * RETURNS:
2547 * Zero on success, non-zero on failure.
2549 static unsigned int ata_scsi_pass_thru(struct ata_queued_cmd *qc)
2551 struct ata_taskfile *tf = &(qc->tf);
2552 struct scsi_cmnd *scmd = qc->scsicmd;
2553 struct ata_device *dev = qc->dev;
2554 const u8 *cdb = scmd->cmnd;
2556 if ((tf->protocol = ata_scsi_map_proto(cdb[1])) == ATA_PROT_UNKNOWN)
2557 goto invalid_fld;
2559 /* We may not issue DMA commands if no DMA mode is set */
2560 if (tf->protocol == ATA_PROT_DMA && dev->dma_mode == 0)
2561 goto invalid_fld;
2564 * 12 and 16 byte CDBs use different offsets to
2565 * provide the various register values.
2567 if (cdb[0] == ATA_16) {
2569 * 16-byte CDB - may contain extended commands.
2571 * If that is the case, copy the upper byte register values.
2573 if (cdb[1] & 0x01) {
2574 tf->hob_feature = cdb[3];
2575 tf->hob_nsect = cdb[5];
2576 tf->hob_lbal = cdb[7];
2577 tf->hob_lbam = cdb[9];
2578 tf->hob_lbah = cdb[11];
2579 tf->flags |= ATA_TFLAG_LBA48;
2580 } else
2581 tf->flags &= ~ATA_TFLAG_LBA48;
2584 * Always copy low byte, device and command registers.
2586 tf->feature = cdb[4];
2587 tf->nsect = cdb[6];
2588 tf->lbal = cdb[8];
2589 tf->lbam = cdb[10];
2590 tf->lbah = cdb[12];
2591 tf->device = cdb[13];
2592 tf->command = cdb[14];
2593 } else {
2595 * 12-byte CDB - incapable of extended commands.
2597 tf->flags &= ~ATA_TFLAG_LBA48;
2599 tf->feature = cdb[3];
2600 tf->nsect = cdb[4];
2601 tf->lbal = cdb[5];
2602 tf->lbam = cdb[6];
2603 tf->lbah = cdb[7];
2604 tf->device = cdb[8];
2605 tf->command = cdb[9];
2608 /* enforce correct master/slave bit */
2609 tf->device = dev->devno ?
2610 tf->device | ATA_DEV1 : tf->device & ~ATA_DEV1;
2612 /* sanity check for pio multi commands */
2613 if ((cdb[1] & 0xe0) && !is_multi_taskfile(tf))
2614 goto invalid_fld;
2616 if (is_multi_taskfile(tf)) {
2617 unsigned int multi_count = 1 << (cdb[1] >> 5);
2619 /* compare the passed through multi_count
2620 * with the cached multi_count of libata
2622 if (multi_count != dev->multi_count)
2623 ata_dev_printk(dev, KERN_WARNING,
2624 "invalid multi_count %u ignored\n",
2625 multi_count);
2628 /* READ/WRITE LONG use a non-standard sect_size */
2629 qc->sect_size = ATA_SECT_SIZE;
2630 switch (tf->command) {
2631 case ATA_CMD_READ_LONG:
2632 case ATA_CMD_READ_LONG_ONCE:
2633 case ATA_CMD_WRITE_LONG:
2634 case ATA_CMD_WRITE_LONG_ONCE:
2635 if (tf->protocol != ATA_PROT_PIO || tf->nsect != 1)
2636 goto invalid_fld;
2637 qc->sect_size = scmd->request_bufflen;
2641 * Filter SET_FEATURES - XFER MODE command -- otherwise,
2642 * SET_FEATURES - XFER MODE must be preceded/succeeded
2643 * by an update to hardware-specific registers for each
2644 * controller (i.e. the reason for ->set_piomode(),
2645 * ->set_dmamode(), and ->post_set_mode() hooks).
2647 if ((tf->command == ATA_CMD_SET_FEATURES)
2648 && (tf->feature == SETFEATURES_XFER))
2649 goto invalid_fld;
2652 * Set flags so that all registers will be written,
2653 * and pass on write indication (used for PIO/DMA
2654 * setup.)
2656 tf->flags |= (ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE);
2658 if (scmd->sc_data_direction == DMA_TO_DEVICE)
2659 tf->flags |= ATA_TFLAG_WRITE;
2662 * Set transfer length.
2664 * TODO: find out if we need to do more here to
2665 * cover scatter/gather case.
2667 qc->nbytes = scmd->request_bufflen;
2669 /* request result TF */
2670 qc->flags |= ATA_QCFLAG_RESULT_TF;
2672 return 0;
2674 invalid_fld:
2675 ata_scsi_set_sense(scmd, ILLEGAL_REQUEST, 0x24, 0x00);
2676 /* "Invalid field in cdb" */
2677 return 1;
2681 * ata_get_xlat_func - check if SCSI to ATA translation is possible
2682 * @dev: ATA device
2683 * @cmd: SCSI command opcode to consider
2685 * Look up the SCSI command given, and determine whether the
2686 * SCSI command is to be translated or simulated.
2688 * RETURNS:
2689 * Pointer to translation function if possible, %NULL if not.
2692 static inline ata_xlat_func_t ata_get_xlat_func(struct ata_device *dev, u8 cmd)
2694 switch (cmd) {
2695 case READ_6:
2696 case READ_10:
2697 case READ_16:
2699 case WRITE_6:
2700 case WRITE_10:
2701 case WRITE_16:
2702 return ata_scsi_rw_xlat;
2704 case SYNCHRONIZE_CACHE:
2705 if (ata_try_flush_cache(dev))
2706 return ata_scsi_flush_xlat;
2707 break;
2709 case VERIFY:
2710 case VERIFY_16:
2711 return ata_scsi_verify_xlat;
2713 case ATA_12:
2714 case ATA_16:
2715 return ata_scsi_pass_thru;
2717 case START_STOP:
2718 return ata_scsi_start_stop_xlat;
2721 return NULL;
2725 * ata_scsi_dump_cdb - dump SCSI command contents to dmesg
2726 * @ap: ATA port to which the command was being sent
2727 * @cmd: SCSI command to dump
2729 * Prints the contents of a SCSI command via printk().
2732 static inline void ata_scsi_dump_cdb(struct ata_port *ap,
2733 struct scsi_cmnd *cmd)
2735 #ifdef ATA_DEBUG
2736 struct scsi_device *scsidev = cmd->device;
2737 u8 *scsicmd = cmd->cmnd;
2739 DPRINTK("CDB (%u:%d,%d,%d) %02x %02x %02x %02x %02x %02x %02x %02x %02x\n",
2740 ap->print_id,
2741 scsidev->channel, scsidev->id, scsidev->lun,
2742 scsicmd[0], scsicmd[1], scsicmd[2], scsicmd[3],
2743 scsicmd[4], scsicmd[5], scsicmd[6], scsicmd[7],
2744 scsicmd[8]);
2745 #endif
2748 static inline int __ata_scsi_queuecmd(struct scsi_cmnd *scmd,
2749 void (*done)(struct scsi_cmnd *),
2750 struct ata_device *dev)
2752 int rc = 0;
2754 if (unlikely(!scmd->cmd_len || scmd->cmd_len > dev->cdb_len)) {
2755 DPRINTK("bad CDB len=%u, max=%u\n",
2756 scmd->cmd_len, dev->cdb_len);
2757 scmd->result = DID_ERROR << 16;
2758 done(scmd);
2759 return 0;
2762 if (dev->class == ATA_DEV_ATA) {
2763 ata_xlat_func_t xlat_func = ata_get_xlat_func(dev,
2764 scmd->cmnd[0]);
2766 if (xlat_func)
2767 rc = ata_scsi_translate(dev, scmd, done, xlat_func);
2768 else
2769 ata_scsi_simulate(dev, scmd, done);
2770 } else
2771 rc = ata_scsi_translate(dev, scmd, done, atapi_xlat);
2773 return rc;
2777 * ata_scsi_queuecmd - Issue SCSI cdb to libata-managed device
2778 * @cmd: SCSI command to be sent
2779 * @done: Completion function, called when command is complete
2781 * In some cases, this function translates SCSI commands into
2782 * ATA taskfiles, and queues the taskfiles to be sent to
2783 * hardware. In other cases, this function simulates a
2784 * SCSI device by evaluating and responding to certain
2785 * SCSI commands. This creates the overall effect of
2786 * ATA and ATAPI devices appearing as SCSI devices.
2788 * LOCKING:
2789 * Releases scsi-layer-held lock, and obtains host lock.
2791 * RETURNS:
2792 * Return value from __ata_scsi_queuecmd() if @cmd can be queued,
2793 * 0 otherwise.
2795 int ata_scsi_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *))
2797 struct ata_port *ap;
2798 struct ata_device *dev;
2799 struct scsi_device *scsidev = cmd->device;
2800 struct Scsi_Host *shost = scsidev->host;
2801 int rc = 0;
2803 ap = ata_shost_to_port(shost);
2805 spin_unlock(shost->host_lock);
2806 spin_lock(ap->lock);
2808 ata_scsi_dump_cdb(ap, cmd);
2810 dev = ata_scsi_find_dev(ap, scsidev);
2811 if (likely(dev))
2812 rc = __ata_scsi_queuecmd(cmd, done, dev);
2813 else {
2814 cmd->result = (DID_BAD_TARGET << 16);
2815 done(cmd);
2818 spin_unlock(ap->lock);
2819 spin_lock(shost->host_lock);
2820 return rc;
2824 * ata_scsi_simulate - simulate SCSI command on ATA device
2825 * @dev: the target device
2826 * @cmd: SCSI command being sent to device.
2827 * @done: SCSI command completion function.
2829 * Interprets and directly executes a select list of SCSI commands
2830 * that can be handled internally.
2832 * LOCKING:
2833 * spin_lock_irqsave(host lock)
2836 void ata_scsi_simulate(struct ata_device *dev, struct scsi_cmnd *cmd,
2837 void (*done)(struct scsi_cmnd *))
2839 struct ata_scsi_args args;
2840 const u8 *scsicmd = cmd->cmnd;
2842 args.dev = dev;
2843 args.id = dev->id;
2844 args.cmd = cmd;
2845 args.done = done;
2847 switch(scsicmd[0]) {
2848 /* no-op's, complete with success */
2849 case SYNCHRONIZE_CACHE:
2850 case REZERO_UNIT:
2851 case SEEK_6:
2852 case SEEK_10:
2853 case TEST_UNIT_READY:
2854 case FORMAT_UNIT: /* FIXME: correct? */
2855 case SEND_DIAGNOSTIC: /* FIXME: correct? */
2856 ata_scsi_rbuf_fill(&args, ata_scsiop_noop);
2857 break;
2859 case INQUIRY:
2860 if (scsicmd[1] & 2) /* is CmdDt set? */
2861 ata_scsi_invalid_field(cmd, done);
2862 else if ((scsicmd[1] & 1) == 0) /* is EVPD clear? */
2863 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_std);
2864 else if (scsicmd[2] == 0x00)
2865 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_00);
2866 else if (scsicmd[2] == 0x80)
2867 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_80);
2868 else if (scsicmd[2] == 0x83)
2869 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_83);
2870 else
2871 ata_scsi_invalid_field(cmd, done);
2872 break;
2874 case MODE_SENSE:
2875 case MODE_SENSE_10:
2876 ata_scsi_rbuf_fill(&args, ata_scsiop_mode_sense);
2877 break;
2879 case MODE_SELECT: /* unconditionally return */
2880 case MODE_SELECT_10: /* bad-field-in-cdb */
2881 ata_scsi_invalid_field(cmd, done);
2882 break;
2884 case READ_CAPACITY:
2885 ata_scsi_rbuf_fill(&args, ata_scsiop_read_cap);
2886 break;
2888 case SERVICE_ACTION_IN:
2889 if ((scsicmd[1] & 0x1f) == SAI_READ_CAPACITY_16)
2890 ata_scsi_rbuf_fill(&args, ata_scsiop_read_cap);
2891 else
2892 ata_scsi_invalid_field(cmd, done);
2893 break;
2895 case REPORT_LUNS:
2896 ata_scsi_rbuf_fill(&args, ata_scsiop_report_luns);
2897 break;
2899 /* mandatory commands we haven't implemented yet */
2900 case REQUEST_SENSE:
2902 /* all other commands */
2903 default:
2904 ata_scsi_set_sense(cmd, ILLEGAL_REQUEST, 0x20, 0x0);
2905 /* "Invalid command operation code" */
2906 done(cmd);
2907 break;
2911 int ata_scsi_add_hosts(struct ata_host *host, struct scsi_host_template *sht)
2913 int i, rc;
2915 for (i = 0; i < host->n_ports; i++) {
2916 struct ata_port *ap = host->ports[i];
2917 struct Scsi_Host *shost;
2919 rc = -ENOMEM;
2920 shost = scsi_host_alloc(sht, sizeof(struct ata_port *));
2921 if (!shost)
2922 goto err_alloc;
2924 *(struct ata_port **)&shost->hostdata[0] = ap;
2925 ap->scsi_host = shost;
2927 shost->transportt = &ata_scsi_transport_template;
2928 shost->unique_id = ap->print_id;
2929 shost->max_id = 16;
2930 shost->max_lun = 1;
2931 shost->max_channel = 1;
2932 shost->max_cmd_len = 16;
2934 rc = scsi_add_host(ap->scsi_host, ap->host->dev);
2935 if (rc)
2936 goto err_add;
2939 return 0;
2941 err_add:
2942 scsi_host_put(host->ports[i]->scsi_host);
2943 err_alloc:
2944 while (--i >= 0) {
2945 struct Scsi_Host *shost = host->ports[i]->scsi_host;
2947 scsi_remove_host(shost);
2948 scsi_host_put(shost);
2950 return rc;
2953 void ata_scsi_scan_host(struct ata_port *ap)
2955 unsigned int i;
2957 if (ap->flags & ATA_FLAG_DISABLED)
2958 return;
2960 for (i = 0; i < ATA_MAX_DEVICES; i++) {
2961 struct ata_device *dev = &ap->device[i];
2962 struct scsi_device *sdev;
2964 if (!ata_dev_enabled(dev) || dev->sdev)
2965 continue;
2967 sdev = __scsi_add_device(ap->scsi_host, 0, i, 0, NULL);
2968 if (!IS_ERR(sdev)) {
2969 dev->sdev = sdev;
2970 scsi_device_put(sdev);
2976 * ata_scsi_offline_dev - offline attached SCSI device
2977 * @dev: ATA device to offline attached SCSI device for
2979 * This function is called from ata_eh_hotplug() and responsible
2980 * for taking the SCSI device attached to @dev offline. This
2981 * function is called with host lock which protects dev->sdev
2982 * against clearing.
2984 * LOCKING:
2985 * spin_lock_irqsave(host lock)
2987 * RETURNS:
2988 * 1 if attached SCSI device exists, 0 otherwise.
2990 int ata_scsi_offline_dev(struct ata_device *dev)
2992 if (dev->sdev) {
2993 scsi_device_set_state(dev->sdev, SDEV_OFFLINE);
2994 return 1;
2996 return 0;
3000 * ata_scsi_remove_dev - remove attached SCSI device
3001 * @dev: ATA device to remove attached SCSI device for
3003 * This function is called from ata_eh_scsi_hotplug() and
3004 * responsible for removing the SCSI device attached to @dev.
3006 * LOCKING:
3007 * Kernel thread context (may sleep).
3009 static void ata_scsi_remove_dev(struct ata_device *dev)
3011 struct ata_port *ap = dev->ap;
3012 struct scsi_device *sdev;
3013 unsigned long flags;
3015 /* Alas, we need to grab scan_mutex to ensure SCSI device
3016 * state doesn't change underneath us and thus
3017 * scsi_device_get() always succeeds. The mutex locking can
3018 * be removed if there is __scsi_device_get() interface which
3019 * increments reference counts regardless of device state.
3021 mutex_lock(&ap->scsi_host->scan_mutex);
3022 spin_lock_irqsave(ap->lock, flags);
3024 /* clearing dev->sdev is protected by host lock */
3025 sdev = dev->sdev;
3026 dev->sdev = NULL;
3028 if (sdev) {
3029 /* If user initiated unplug races with us, sdev can go
3030 * away underneath us after the host lock and
3031 * scan_mutex are released. Hold onto it.
3033 if (scsi_device_get(sdev) == 0) {
3034 /* The following ensures the attached sdev is
3035 * offline on return from ata_scsi_offline_dev()
3036 * regardless it wins or loses the race
3037 * against this function.
3039 scsi_device_set_state(sdev, SDEV_OFFLINE);
3040 } else {
3041 WARN_ON(1);
3042 sdev = NULL;
3046 spin_unlock_irqrestore(ap->lock, flags);
3047 mutex_unlock(&ap->scsi_host->scan_mutex);
3049 if (sdev) {
3050 ata_dev_printk(dev, KERN_INFO, "detaching (SCSI %s)\n",
3051 sdev->sdev_gendev.bus_id);
3053 scsi_remove_device(sdev);
3054 scsi_device_put(sdev);
3059 * ata_scsi_hotplug - SCSI part of hotplug
3060 * @work: Pointer to ATA port to perform SCSI hotplug on
3062 * Perform SCSI part of hotplug. It's executed from a separate
3063 * workqueue after EH completes. This is necessary because SCSI
3064 * hot plugging requires working EH and hot unplugging is
3065 * synchronized with hot plugging with a mutex.
3067 * LOCKING:
3068 * Kernel thread context (may sleep).
3070 void ata_scsi_hotplug(struct work_struct *work)
3072 struct ata_port *ap =
3073 container_of(work, struct ata_port, hotplug_task.work);
3074 int i;
3076 if (ap->pflags & ATA_PFLAG_UNLOADING) {
3077 DPRINTK("ENTER/EXIT - unloading\n");
3078 return;
3081 DPRINTK("ENTER\n");
3083 /* unplug detached devices */
3084 for (i = 0; i < ATA_MAX_DEVICES; i++) {
3085 struct ata_device *dev = &ap->device[i];
3086 unsigned long flags;
3088 if (!(dev->flags & ATA_DFLAG_DETACHED))
3089 continue;
3091 spin_lock_irqsave(ap->lock, flags);
3092 dev->flags &= ~ATA_DFLAG_DETACHED;
3093 spin_unlock_irqrestore(ap->lock, flags);
3095 ata_scsi_remove_dev(dev);
3098 /* scan for new ones */
3099 ata_scsi_scan_host(ap);
3101 /* If we scanned while EH was in progress, scan would have
3102 * failed silently. Requeue if there are enabled but
3103 * unattached devices.
3105 for (i = 0; i < ATA_MAX_DEVICES; i++) {
3106 struct ata_device *dev = &ap->device[i];
3107 if (ata_dev_enabled(dev) && !dev->sdev) {
3108 queue_delayed_work(ata_aux_wq, &ap->hotplug_task,
3109 round_jiffies_relative(HZ));
3110 break;
3114 DPRINTK("EXIT\n");
3118 * ata_scsi_user_scan - indication for user-initiated bus scan
3119 * @shost: SCSI host to scan
3120 * @channel: Channel to scan
3121 * @id: ID to scan
3122 * @lun: LUN to scan
3124 * This function is called when user explicitly requests bus
3125 * scan. Set probe pending flag and invoke EH.
3127 * LOCKING:
3128 * SCSI layer (we don't care)
3130 * RETURNS:
3131 * Zero.
3133 static int ata_scsi_user_scan(struct Scsi_Host *shost, unsigned int channel,
3134 unsigned int id, unsigned int lun)
3136 struct ata_port *ap = ata_shost_to_port(shost);
3137 unsigned long flags;
3138 int rc = 0;
3140 if (!ap->ops->error_handler)
3141 return -EOPNOTSUPP;
3143 if ((channel != SCAN_WILD_CARD && channel != 0) ||
3144 (lun != SCAN_WILD_CARD && lun != 0))
3145 return -EINVAL;
3147 spin_lock_irqsave(ap->lock, flags);
3149 if (id == SCAN_WILD_CARD) {
3150 ap->eh_info.probe_mask |= (1 << ATA_MAX_DEVICES) - 1;
3151 ap->eh_info.action |= ATA_EH_SOFTRESET;
3152 } else {
3153 struct ata_device *dev = ata_find_dev(ap, id);
3155 if (dev) {
3156 ap->eh_info.probe_mask |= 1 << dev->devno;
3157 ap->eh_info.action |= ATA_EH_SOFTRESET;
3158 ap->eh_info.flags |= ATA_EHI_RESUME_LINK;
3159 } else
3160 rc = -EINVAL;
3163 if (rc == 0) {
3164 ata_port_schedule_eh(ap);
3165 spin_unlock_irqrestore(ap->lock, flags);
3166 ata_port_wait_eh(ap);
3167 } else
3168 spin_unlock_irqrestore(ap->lock, flags);
3170 return rc;
3174 * ata_scsi_dev_rescan - initiate scsi_rescan_device()
3175 * @work: Pointer to ATA port to perform scsi_rescan_device()
3177 * After ATA pass thru (SAT) commands are executed successfully,
3178 * libata need to propagate the changes to SCSI layer. This
3179 * function must be executed from ata_aux_wq such that sdev
3180 * attach/detach don't race with rescan.
3182 * LOCKING:
3183 * Kernel thread context (may sleep).
3185 void ata_scsi_dev_rescan(struct work_struct *work)
3187 struct ata_port *ap =
3188 container_of(work, struct ata_port, scsi_rescan_task);
3189 unsigned long flags;
3190 unsigned int i;
3192 spin_lock_irqsave(ap->lock, flags);
3194 for (i = 0; i < ATA_MAX_DEVICES; i++) {
3195 struct ata_device *dev = &ap->device[i];
3196 struct scsi_device *sdev = dev->sdev;
3198 if (!ata_dev_enabled(dev) || !sdev)
3199 continue;
3200 if (scsi_device_get(sdev))
3201 continue;
3203 spin_unlock_irqrestore(ap->lock, flags);
3204 scsi_rescan_device(&(sdev->sdev_gendev));
3205 scsi_device_put(sdev);
3206 spin_lock_irqsave(ap->lock, flags);
3209 spin_unlock_irqrestore(ap->lock, flags);
3213 * ata_sas_port_alloc - Allocate port for a SAS attached SATA device
3214 * @host: ATA host container for all SAS ports
3215 * @port_info: Information from low-level host driver
3216 * @shost: SCSI host that the scsi device is attached to
3218 * LOCKING:
3219 * PCI/etc. bus probe sem.
3221 * RETURNS:
3222 * ata_port pointer on success / NULL on failure.
3225 struct ata_port *ata_sas_port_alloc(struct ata_host *host,
3226 struct ata_port_info *port_info,
3227 struct Scsi_Host *shost)
3229 struct ata_port *ap;
3231 ap = ata_port_alloc(host);
3232 if (!ap)
3233 return NULL;
3235 ap->port_no = 0;
3236 ap->lock = shost->host_lock;
3237 ap->pio_mask = port_info->pio_mask;
3238 ap->mwdma_mask = port_info->mwdma_mask;
3239 ap->udma_mask = port_info->udma_mask;
3240 ap->flags |= port_info->flags;
3241 ap->ops = port_info->port_ops;
3242 ap->cbl = ATA_CBL_SATA;
3244 return ap;
3246 EXPORT_SYMBOL_GPL(ata_sas_port_alloc);
3249 * ata_sas_port_start - Set port up for dma.
3250 * @ap: Port to initialize
3252 * Called just after data structures for each port are
3253 * initialized. Allocates DMA pad.
3255 * May be used as the port_start() entry in ata_port_operations.
3257 * LOCKING:
3258 * Inherited from caller.
3260 int ata_sas_port_start(struct ata_port *ap)
3262 return ata_pad_alloc(ap, ap->dev);
3264 EXPORT_SYMBOL_GPL(ata_sas_port_start);
3267 * ata_port_stop - Undo ata_sas_port_start()
3268 * @ap: Port to shut down
3270 * Frees the DMA pad.
3272 * May be used as the port_stop() entry in ata_port_operations.
3274 * LOCKING:
3275 * Inherited from caller.
3278 void ata_sas_port_stop(struct ata_port *ap)
3280 ata_pad_free(ap, ap->dev);
3282 EXPORT_SYMBOL_GPL(ata_sas_port_stop);
3285 * ata_sas_port_init - Initialize a SATA device
3286 * @ap: SATA port to initialize
3288 * LOCKING:
3289 * PCI/etc. bus probe sem.
3291 * RETURNS:
3292 * Zero on success, non-zero on error.
3295 int ata_sas_port_init(struct ata_port *ap)
3297 int rc = ap->ops->port_start(ap);
3299 if (!rc) {
3300 ap->print_id = ata_print_id++;
3301 rc = ata_bus_probe(ap);
3304 return rc;
3306 EXPORT_SYMBOL_GPL(ata_sas_port_init);
3309 * ata_sas_port_destroy - Destroy a SATA port allocated by ata_sas_port_alloc
3310 * @ap: SATA port to destroy
3314 void ata_sas_port_destroy(struct ata_port *ap)
3316 if (ap->ops->port_stop)
3317 ap->ops->port_stop(ap);
3318 kfree(ap);
3320 EXPORT_SYMBOL_GPL(ata_sas_port_destroy);
3323 * ata_sas_slave_configure - Default slave_config routine for libata devices
3324 * @sdev: SCSI device to configure
3325 * @ap: ATA port to which SCSI device is attached
3327 * RETURNS:
3328 * Zero.
3331 int ata_sas_slave_configure(struct scsi_device *sdev, struct ata_port *ap)
3333 ata_scsi_sdev_config(sdev);
3334 ata_scsi_dev_config(sdev, ap->device);
3335 return 0;
3337 EXPORT_SYMBOL_GPL(ata_sas_slave_configure);
3340 * ata_sas_queuecmd - Issue SCSI cdb to libata-managed device
3341 * @cmd: SCSI command to be sent
3342 * @done: Completion function, called when command is complete
3343 * @ap: ATA port to which the command is being sent
3345 * RETURNS:
3346 * Return value from __ata_scsi_queuecmd() if @cmd can be queued,
3347 * 0 otherwise.
3350 int ata_sas_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *),
3351 struct ata_port *ap)
3353 int rc = 0;
3355 ata_scsi_dump_cdb(ap, cmd);
3357 if (likely(ata_scsi_dev_enabled(ap->device)))
3358 rc = __ata_scsi_queuecmd(cmd, done, ap->device);
3359 else {
3360 cmd->result = (DID_BAD_TARGET << 16);
3361 done(cmd);
3363 return rc;
3365 EXPORT_SYMBOL_GPL(ata_sas_queuecmd);