ACPI: thinkpad-acpi: improve dock subdriver initialization
[linux-2.6/linux-acpi-2.6/ibm-acpi-2.6.git] / drivers / ata / libata-scsi.c
blobfc436f6162410c1eadca70104ee215f862aff59b
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 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_cmd_ioctl - Handler for HDIO_DRIVE_CMD ioctl
153 * @scsidev: Device to which we are issuing command
154 * @arg: User provided data for issuing command
156 * LOCKING:
157 * Defined by the SCSI layer. We don't really care.
159 * RETURNS:
160 * Zero on success, negative errno on error.
163 int ata_cmd_ioctl(struct scsi_device *scsidev, void __user *arg)
165 int rc = 0;
166 u8 scsi_cmd[MAX_COMMAND_SIZE];
167 u8 args[4], *argbuf = NULL, *sensebuf = NULL;
168 int argsize = 0;
169 enum dma_data_direction data_dir;
170 int cmd_result;
172 if (arg == NULL)
173 return -EINVAL;
175 if (copy_from_user(args, arg, sizeof(args)))
176 return -EFAULT;
178 sensebuf = kzalloc(SCSI_SENSE_BUFFERSIZE, GFP_NOIO);
179 if (!sensebuf)
180 return -ENOMEM;
182 memset(scsi_cmd, 0, sizeof(scsi_cmd));
184 if (args[3]) {
185 argsize = SECTOR_SIZE * args[3];
186 argbuf = kmalloc(argsize, GFP_KERNEL);
187 if (argbuf == NULL) {
188 rc = -ENOMEM;
189 goto error;
192 scsi_cmd[1] = (4 << 1); /* PIO Data-in */
193 scsi_cmd[2] = 0x0e; /* no off.line or cc, read from dev,
194 block count in sector count field */
195 data_dir = DMA_FROM_DEVICE;
196 } else {
197 scsi_cmd[1] = (3 << 1); /* Non-data */
198 scsi_cmd[2] = 0x20; /* cc but no off.line or data xfer */
199 data_dir = DMA_NONE;
202 scsi_cmd[0] = ATA_16;
204 scsi_cmd[4] = args[2];
205 if (args[0] == WIN_SMART) { /* hack -- ide driver does this too... */
206 scsi_cmd[6] = args[3];
207 scsi_cmd[8] = args[1];
208 scsi_cmd[10] = 0x4f;
209 scsi_cmd[12] = 0xc2;
210 } else {
211 scsi_cmd[6] = args[1];
213 scsi_cmd[14] = args[0];
215 /* Good values for timeout and retries? Values below
216 from scsi_ioctl_send_command() for default case... */
217 cmd_result = scsi_execute(scsidev, scsi_cmd, data_dir, argbuf, argsize,
218 sensebuf, (10*HZ), 5, 0);
220 if (driver_byte(cmd_result) == DRIVER_SENSE) {/* sense data available */
221 u8 *desc = sensebuf + 8;
222 cmd_result &= ~(0xFF<<24); /* DRIVER_SENSE is not an error */
224 /* If we set cc then ATA pass-through will cause a
225 * check condition even if no error. Filter that. */
226 if (cmd_result & SAM_STAT_CHECK_CONDITION) {
227 struct scsi_sense_hdr sshdr;
228 scsi_normalize_sense(sensebuf, SCSI_SENSE_BUFFERSIZE,
229 &sshdr);
230 if (sshdr.sense_key==0 &&
231 sshdr.asc==0 && sshdr.ascq==0)
232 cmd_result &= ~SAM_STAT_CHECK_CONDITION;
235 /* Send userspace a few ATA registers (same as drivers/ide) */
236 if (sensebuf[0] == 0x72 && /* format is "descriptor" */
237 desc[0] == 0x09 ) { /* code is "ATA Descriptor" */
238 args[0] = desc[13]; /* status */
239 args[1] = desc[3]; /* error */
240 args[2] = desc[5]; /* sector count (0:7) */
241 if (copy_to_user(arg, args, sizeof(args)))
242 rc = -EFAULT;
247 if (cmd_result) {
248 rc = -EIO;
249 goto error;
252 if ((argbuf)
253 && copy_to_user(arg + sizeof(args), argbuf, argsize))
254 rc = -EFAULT;
255 error:
256 kfree(sensebuf);
257 kfree(argbuf);
258 return rc;
262 * ata_task_ioctl - Handler for HDIO_DRIVE_TASK ioctl
263 * @scsidev: Device to which we are issuing command
264 * @arg: User provided data for issuing command
266 * LOCKING:
267 * Defined by the SCSI layer. We don't really care.
269 * RETURNS:
270 * Zero on success, negative errno on error.
272 int ata_task_ioctl(struct scsi_device *scsidev, void __user *arg)
274 int rc = 0;
275 u8 scsi_cmd[MAX_COMMAND_SIZE];
276 u8 args[7], *sensebuf = NULL;
277 int cmd_result;
279 if (arg == NULL)
280 return -EINVAL;
282 if (copy_from_user(args, arg, sizeof(args)))
283 return -EFAULT;
285 sensebuf = kzalloc(SCSI_SENSE_BUFFERSIZE, GFP_NOIO);
286 if (!sensebuf)
287 return -ENOMEM;
289 memset(scsi_cmd, 0, sizeof(scsi_cmd));
290 scsi_cmd[0] = ATA_16;
291 scsi_cmd[1] = (3 << 1); /* Non-data */
292 scsi_cmd[2] = 0x20; /* cc but no off.line or data xfer */
293 scsi_cmd[4] = args[1];
294 scsi_cmd[6] = args[2];
295 scsi_cmd[8] = args[3];
296 scsi_cmd[10] = args[4];
297 scsi_cmd[12] = args[5];
298 scsi_cmd[13] = args[6] & 0x4f;
299 scsi_cmd[14] = args[0];
301 /* Good values for timeout and retries? Values below
302 from scsi_ioctl_send_command() for default case... */
303 cmd_result = scsi_execute(scsidev, scsi_cmd, DMA_NONE, NULL, 0,
304 sensebuf, (10*HZ), 5, 0);
306 if (driver_byte(cmd_result) == DRIVER_SENSE) {/* sense data available */
307 u8 *desc = sensebuf + 8;
308 cmd_result &= ~(0xFF<<24); /* DRIVER_SENSE is not an error */
310 /* If we set cc then ATA pass-through will cause a
311 * check condition even if no error. Filter that. */
312 if (cmd_result & SAM_STAT_CHECK_CONDITION) {
313 struct scsi_sense_hdr sshdr;
314 scsi_normalize_sense(sensebuf, SCSI_SENSE_BUFFERSIZE,
315 &sshdr);
316 if (sshdr.sense_key==0 &&
317 sshdr.asc==0 && sshdr.ascq==0)
318 cmd_result &= ~SAM_STAT_CHECK_CONDITION;
321 /* Send userspace ATA registers */
322 if (sensebuf[0] == 0x72 && /* format is "descriptor" */
323 desc[0] == 0x09) {/* code is "ATA Descriptor" */
324 args[0] = desc[13]; /* status */
325 args[1] = desc[3]; /* error */
326 args[2] = desc[5]; /* sector count (0:7) */
327 args[3] = desc[7]; /* lbal */
328 args[4] = desc[9]; /* lbam */
329 args[5] = desc[11]; /* lbah */
330 args[6] = desc[12]; /* select */
331 if (copy_to_user(arg, args, sizeof(args)))
332 rc = -EFAULT;
336 if (cmd_result) {
337 rc = -EIO;
338 goto error;
341 error:
342 kfree(sensebuf);
343 return rc;
346 int ata_scsi_ioctl(struct scsi_device *scsidev, int cmd, void __user *arg)
348 int val = -EINVAL, rc = -EINVAL;
350 switch (cmd) {
351 case ATA_IOC_GET_IO32:
352 val = 0;
353 if (copy_to_user(arg, &val, 1))
354 return -EFAULT;
355 return 0;
357 case ATA_IOC_SET_IO32:
358 val = (unsigned long) arg;
359 if (val != 0)
360 return -EINVAL;
361 return 0;
363 case HDIO_DRIVE_CMD:
364 if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
365 return -EACCES;
366 return ata_cmd_ioctl(scsidev, arg);
368 case HDIO_DRIVE_TASK:
369 if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
370 return -EACCES;
371 return ata_task_ioctl(scsidev, arg);
373 default:
374 rc = -ENOTTY;
375 break;
378 return rc;
382 * ata_scsi_qc_new - acquire new ata_queued_cmd reference
383 * @dev: ATA device to which the new command is attached
384 * @cmd: SCSI command that originated this ATA command
385 * @done: SCSI command completion function
387 * Obtain a reference to an unused ata_queued_cmd structure,
388 * which is the basic libata structure representing a single
389 * ATA command sent to the hardware.
391 * If a command was available, fill in the SCSI-specific
392 * portions of the structure with information on the
393 * current command.
395 * LOCKING:
396 * spin_lock_irqsave(host lock)
398 * RETURNS:
399 * Command allocated, or %NULL if none available.
401 struct ata_queued_cmd *ata_scsi_qc_new(struct ata_device *dev,
402 struct scsi_cmnd *cmd,
403 void (*done)(struct scsi_cmnd *))
405 struct ata_queued_cmd *qc;
407 qc = ata_qc_new_init(dev);
408 if (qc) {
409 qc->scsicmd = cmd;
410 qc->scsidone = done;
412 if (cmd->use_sg) {
413 qc->__sg = (struct scatterlist *) cmd->request_buffer;
414 qc->n_elem = cmd->use_sg;
415 } else if (cmd->request_bufflen) {
416 qc->__sg = &qc->sgent;
417 qc->n_elem = 1;
419 } else {
420 cmd->result = (DID_OK << 16) | (QUEUE_FULL << 1);
421 done(cmd);
424 return qc;
428 * ata_dump_status - user friendly display of error info
429 * @id: id of the port in question
430 * @tf: ptr to filled out taskfile
432 * Decode and dump the ATA error/status registers for the user so
433 * that they have some idea what really happened at the non
434 * make-believe layer.
436 * LOCKING:
437 * inherited from caller
439 void ata_dump_status(unsigned id, struct ata_taskfile *tf)
441 u8 stat = tf->command, err = tf->feature;
443 printk(KERN_WARNING "ata%u: status=0x%02x { ", id, stat);
444 if (stat & ATA_BUSY) {
445 printk("Busy }\n"); /* Data is not valid in this case */
446 } else {
447 if (stat & 0x40) printk("DriveReady ");
448 if (stat & 0x20) printk("DeviceFault ");
449 if (stat & 0x10) printk("SeekComplete ");
450 if (stat & 0x08) printk("DataRequest ");
451 if (stat & 0x04) printk("CorrectedError ");
452 if (stat & 0x02) printk("Index ");
453 if (stat & 0x01) printk("Error ");
454 printk("}\n");
456 if (err) {
457 printk(KERN_WARNING "ata%u: error=0x%02x { ", id, err);
458 if (err & 0x04) printk("DriveStatusError ");
459 if (err & 0x80) {
460 if (err & 0x04) printk("BadCRC ");
461 else printk("Sector ");
463 if (err & 0x40) printk("UncorrectableError ");
464 if (err & 0x10) printk("SectorIdNotFound ");
465 if (err & 0x02) printk("TrackZeroNotFound ");
466 if (err & 0x01) printk("AddrMarkNotFound ");
467 printk("}\n");
473 * ata_scsi_device_suspend - suspend ATA device associated with sdev
474 * @sdev: the SCSI device to suspend
475 * @mesg: target power management message
477 * Request suspend EH action on the ATA device associated with
478 * @sdev and wait for the operation to complete.
480 * LOCKING:
481 * Kernel thread context (may sleep).
483 * RETURNS:
484 * 0 on success, -errno otherwise.
486 int ata_scsi_device_suspend(struct scsi_device *sdev, pm_message_t mesg)
488 struct ata_port *ap = ata_shost_to_port(sdev->host);
489 struct ata_device *dev = ata_scsi_find_dev(ap, sdev);
490 unsigned long flags;
491 unsigned int action;
492 int rc = 0;
494 if (!dev)
495 goto out;
497 spin_lock_irqsave(ap->lock, flags);
499 /* wait for the previous resume to complete */
500 while (dev->flags & ATA_DFLAG_SUSPENDED) {
501 spin_unlock_irqrestore(ap->lock, flags);
502 ata_port_wait_eh(ap);
503 spin_lock_irqsave(ap->lock, flags);
506 /* if @sdev is already detached, nothing to do */
507 if (sdev->sdev_state == SDEV_OFFLINE ||
508 sdev->sdev_state == SDEV_CANCEL || sdev->sdev_state == SDEV_DEL)
509 goto out_unlock;
511 /* request suspend */
512 action = ATA_EH_SUSPEND;
513 if (mesg.event != PM_EVENT_SUSPEND)
514 action |= ATA_EH_PM_FREEZE;
515 ap->eh_info.dev_action[dev->devno] |= action;
516 ap->eh_info.flags |= ATA_EHI_QUIET;
517 ata_port_schedule_eh(ap);
519 spin_unlock_irqrestore(ap->lock, flags);
521 /* wait for EH to do the job */
522 ata_port_wait_eh(ap);
524 spin_lock_irqsave(ap->lock, flags);
526 /* If @sdev is still attached but the associated ATA device
527 * isn't suspended, the operation failed.
529 if (sdev->sdev_state != SDEV_OFFLINE &&
530 sdev->sdev_state != SDEV_CANCEL && sdev->sdev_state != SDEV_DEL &&
531 !(dev->flags & ATA_DFLAG_SUSPENDED))
532 rc = -EIO;
534 out_unlock:
535 spin_unlock_irqrestore(ap->lock, flags);
536 out:
537 if (rc == 0)
538 sdev->sdev_gendev.power.power_state = mesg;
539 return rc;
543 * ata_scsi_device_resume - resume ATA device associated with sdev
544 * @sdev: the SCSI device to resume
546 * Request resume EH action on the ATA device associated with
547 * @sdev and return immediately. This enables parallel
548 * wakeup/spinup of devices.
550 * LOCKING:
551 * Kernel thread context (may sleep).
553 * RETURNS:
554 * 0.
556 int ata_scsi_device_resume(struct scsi_device *sdev)
558 struct ata_port *ap = ata_shost_to_port(sdev->host);
559 struct ata_device *dev = ata_scsi_find_dev(ap, sdev);
560 struct ata_eh_info *ehi = &ap->eh_info;
561 unsigned long flags;
562 unsigned int action;
564 if (!dev)
565 goto out;
567 spin_lock_irqsave(ap->lock, flags);
569 /* if @sdev is already detached, nothing to do */
570 if (sdev->sdev_state == SDEV_OFFLINE ||
571 sdev->sdev_state == SDEV_CANCEL || sdev->sdev_state == SDEV_DEL)
572 goto out_unlock;
574 /* request resume */
575 action = ATA_EH_RESUME;
576 if (sdev->sdev_gendev.power.power_state.event == PM_EVENT_SUSPEND)
577 __ata_ehi_hotplugged(ehi);
578 else
579 action |= ATA_EH_PM_FREEZE | ATA_EH_SOFTRESET;
580 ehi->dev_action[dev->devno] |= action;
582 /* We don't want autopsy and verbose EH messages. Disable
583 * those if we're the only device on this link.
585 if (ata_port_max_devices(ap) == 1)
586 ehi->flags |= ATA_EHI_NO_AUTOPSY | ATA_EHI_QUIET;
588 ata_port_schedule_eh(ap);
590 out_unlock:
591 spin_unlock_irqrestore(ap->lock, flags);
592 out:
593 sdev->sdev_gendev.power.power_state = PMSG_ON;
594 return 0;
598 * ata_to_sense_error - convert ATA error to SCSI error
599 * @id: ATA device number
600 * @drv_stat: value contained in ATA status register
601 * @drv_err: value contained in ATA error register
602 * @sk: the sense key we'll fill out
603 * @asc: the additional sense code we'll fill out
604 * @ascq: the additional sense code qualifier we'll fill out
605 * @verbose: be verbose
607 * Converts an ATA error into a SCSI error. Fill out pointers to
608 * SK, ASC, and ASCQ bytes for later use in fixed or descriptor
609 * format sense blocks.
611 * LOCKING:
612 * spin_lock_irqsave(host lock)
614 void ata_to_sense_error(unsigned id, u8 drv_stat, u8 drv_err, u8 *sk, u8 *asc,
615 u8 *ascq, int verbose)
617 int i;
619 /* Based on the 3ware driver translation table */
620 static const unsigned char sense_table[][4] = {
621 /* BBD|ECC|ID|MAR */
622 {0xd1, ABORTED_COMMAND, 0x00, 0x00}, // Device busy Aborted command
623 /* BBD|ECC|ID */
624 {0xd0, ABORTED_COMMAND, 0x00, 0x00}, // Device busy Aborted command
625 /* ECC|MC|MARK */
626 {0x61, HARDWARE_ERROR, 0x00, 0x00}, // Device fault Hardware error
627 /* ICRC|ABRT */ /* NB: ICRC & !ABRT is BBD */
628 {0x84, ABORTED_COMMAND, 0x47, 0x00}, // Data CRC error SCSI parity error
629 /* MC|ID|ABRT|TRK0|MARK */
630 {0x37, NOT_READY, 0x04, 0x00}, // Unit offline Not ready
631 /* MCR|MARK */
632 {0x09, NOT_READY, 0x04, 0x00}, // Unrecovered disk error Not ready
633 /* Bad address mark */
634 {0x01, MEDIUM_ERROR, 0x13, 0x00}, // Address mark not found Address mark not found for data field
635 /* TRK0 */
636 {0x02, HARDWARE_ERROR, 0x00, 0x00}, // Track 0 not found Hardware error
637 /* Abort & !ICRC */
638 {0x04, ABORTED_COMMAND, 0x00, 0x00}, // Aborted command Aborted command
639 /* Media change request */
640 {0x08, NOT_READY, 0x04, 0x00}, // Media change request FIXME: faking offline
641 /* SRV */
642 {0x10, ABORTED_COMMAND, 0x14, 0x00}, // ID not found Recorded entity not found
643 /* Media change */
644 {0x08, NOT_READY, 0x04, 0x00}, // Media change FIXME: faking offline
645 /* ECC */
646 {0x40, MEDIUM_ERROR, 0x11, 0x04}, // Uncorrectable ECC error Unrecovered read error
647 /* BBD - block marked bad */
648 {0x80, MEDIUM_ERROR, 0x11, 0x04}, // Block marked bad Medium error, unrecovered read error
649 {0xFF, 0xFF, 0xFF, 0xFF}, // END mark
651 static const unsigned char stat_table[][4] = {
652 /* Must be first because BUSY means no other bits valid */
653 {0x80, ABORTED_COMMAND, 0x47, 0x00}, // Busy, fake parity for now
654 {0x20, HARDWARE_ERROR, 0x00, 0x00}, // Device fault
655 {0x08, ABORTED_COMMAND, 0x47, 0x00}, // Timed out in xfer, fake parity for now
656 {0x04, RECOVERED_ERROR, 0x11, 0x00}, // Recovered ECC error Medium error, recovered
657 {0xFF, 0xFF, 0xFF, 0xFF}, // END mark
661 * Is this an error we can process/parse
663 if (drv_stat & ATA_BUSY) {
664 drv_err = 0; /* Ignore the err bits, they're invalid */
667 if (drv_err) {
668 /* Look for drv_err */
669 for (i = 0; sense_table[i][0] != 0xFF; i++) {
670 /* Look for best matches first */
671 if ((sense_table[i][0] & drv_err) ==
672 sense_table[i][0]) {
673 *sk = sense_table[i][1];
674 *asc = sense_table[i][2];
675 *ascq = sense_table[i][3];
676 goto translate_done;
679 /* No immediate match */
680 if (verbose)
681 printk(KERN_WARNING "ata%u: no sense translation for "
682 "error 0x%02x\n", id, drv_err);
685 /* Fall back to interpreting status bits */
686 for (i = 0; stat_table[i][0] != 0xFF; i++) {
687 if (stat_table[i][0] & drv_stat) {
688 *sk = stat_table[i][1];
689 *asc = stat_table[i][2];
690 *ascq = stat_table[i][3];
691 goto translate_done;
694 /* No error? Undecoded? */
695 if (verbose)
696 printk(KERN_WARNING "ata%u: no sense translation for "
697 "status: 0x%02x\n", id, drv_stat);
699 /* We need a sensible error return here, which is tricky, and one
700 that won't cause people to do things like return a disk wrongly */
701 *sk = ABORTED_COMMAND;
702 *asc = 0x00;
703 *ascq = 0x00;
705 translate_done:
706 if (verbose)
707 printk(KERN_ERR "ata%u: translated ATA stat/err 0x%02x/%02x "
708 "to SCSI SK/ASC/ASCQ 0x%x/%02x/%02x\n",
709 id, drv_stat, drv_err, *sk, *asc, *ascq);
710 return;
714 * ata_gen_passthru_sense - Generate check condition sense block.
715 * @qc: Command that completed.
717 * This function is specific to the ATA descriptor format sense
718 * block specified for the ATA pass through commands. Regardless
719 * of whether the command errored or not, return a sense
720 * block. Copy all controller registers into the sense
721 * block. Clear sense key, ASC & ASCQ if there is no error.
723 * LOCKING:
724 * None.
726 static void ata_gen_passthru_sense(struct ata_queued_cmd *qc)
728 struct scsi_cmnd *cmd = qc->scsicmd;
729 struct ata_taskfile *tf = &qc->result_tf;
730 unsigned char *sb = cmd->sense_buffer;
731 unsigned char *desc = sb + 8;
732 int verbose = qc->ap->ops->error_handler == NULL;
734 memset(sb, 0, SCSI_SENSE_BUFFERSIZE);
736 cmd->result = (DRIVER_SENSE << 24) | SAM_STAT_CHECK_CONDITION;
739 * Use ata_to_sense_error() to map status register bits
740 * onto sense key, asc & ascq.
742 if (qc->err_mask ||
743 tf->command & (ATA_BUSY | ATA_DF | ATA_ERR | ATA_DRQ)) {
744 ata_to_sense_error(qc->ap->id, tf->command, tf->feature,
745 &sb[1], &sb[2], &sb[3], verbose);
746 sb[1] &= 0x0f;
750 * Sense data is current and format is descriptor.
752 sb[0] = 0x72;
754 desc[0] = 0x09;
756 /* set length of additional sense data */
757 sb[7] = 14;
758 desc[1] = 12;
761 * Copy registers into sense buffer.
763 desc[2] = 0x00;
764 desc[3] = tf->feature; /* == error reg */
765 desc[5] = tf->nsect;
766 desc[7] = tf->lbal;
767 desc[9] = tf->lbam;
768 desc[11] = tf->lbah;
769 desc[12] = tf->device;
770 desc[13] = tf->command; /* == status reg */
773 * Fill in Extend bit, and the high order bytes
774 * if applicable.
776 if (tf->flags & ATA_TFLAG_LBA48) {
777 desc[2] |= 0x01;
778 desc[4] = tf->hob_nsect;
779 desc[6] = tf->hob_lbal;
780 desc[8] = tf->hob_lbam;
781 desc[10] = tf->hob_lbah;
786 * ata_gen_ata_sense - generate a SCSI fixed sense block
787 * @qc: Command that we are erroring out
789 * Generate sense block for a failed ATA command @qc. Descriptor
790 * format is used to accomodate LBA48 block address.
792 * LOCKING:
793 * None.
795 static void ata_gen_ata_sense(struct ata_queued_cmd *qc)
797 struct ata_device *dev = qc->dev;
798 struct scsi_cmnd *cmd = qc->scsicmd;
799 struct ata_taskfile *tf = &qc->result_tf;
800 unsigned char *sb = cmd->sense_buffer;
801 unsigned char *desc = sb + 8;
802 int verbose = qc->ap->ops->error_handler == NULL;
803 u64 block;
805 memset(sb, 0, SCSI_SENSE_BUFFERSIZE);
807 cmd->result = (DRIVER_SENSE << 24) | SAM_STAT_CHECK_CONDITION;
809 /* sense data is current and format is descriptor */
810 sb[0] = 0x72;
812 /* Use ata_to_sense_error() to map status register bits
813 * onto sense key, asc & ascq.
815 if (qc->err_mask ||
816 tf->command & (ATA_BUSY | ATA_DF | ATA_ERR | ATA_DRQ)) {
817 ata_to_sense_error(qc->ap->id, tf->command, tf->feature,
818 &sb[1], &sb[2], &sb[3], verbose);
819 sb[1] &= 0x0f;
822 block = ata_tf_read_block(&qc->result_tf, dev);
824 /* information sense data descriptor */
825 sb[7] = 12;
826 desc[0] = 0x00;
827 desc[1] = 10;
829 desc[2] |= 0x80; /* valid */
830 desc[6] = block >> 40;
831 desc[7] = block >> 32;
832 desc[8] = block >> 24;
833 desc[9] = block >> 16;
834 desc[10] = block >> 8;
835 desc[11] = block;
838 static void ata_scsi_sdev_config(struct scsi_device *sdev)
840 sdev->use_10_for_rw = 1;
841 sdev->use_10_for_ms = 1;
844 static void ata_scsi_dev_config(struct scsi_device *sdev,
845 struct ata_device *dev)
847 /* configure max sectors */
848 blk_queue_max_sectors(sdev->request_queue, dev->max_sectors);
850 /* SATA DMA transfers must be multiples of 4 byte, so
851 * we need to pad ATAPI transfers using an extra sg.
852 * Decrement max hw segments accordingly.
854 if (dev->class == ATA_DEV_ATAPI) {
855 request_queue_t *q = sdev->request_queue;
856 blk_queue_max_hw_segments(q, q->max_hw_segments - 1);
859 if (dev->flags & ATA_DFLAG_NCQ) {
860 int depth;
862 depth = min(sdev->host->can_queue, ata_id_queue_depth(dev->id));
863 depth = min(ATA_MAX_QUEUE - 1, depth);
864 scsi_adjust_queue_depth(sdev, MSG_SIMPLE_TAG, depth);
869 * ata_scsi_slave_config - Set SCSI device attributes
870 * @sdev: SCSI device to examine
872 * This is called before we actually start reading
873 * and writing to the device, to configure certain
874 * SCSI mid-layer behaviors.
876 * LOCKING:
877 * Defined by SCSI layer. We don't really care.
880 int ata_scsi_slave_config(struct scsi_device *sdev)
882 struct ata_port *ap = ata_shost_to_port(sdev->host);
883 struct ata_device *dev = __ata_scsi_find_dev(ap, sdev);
885 ata_scsi_sdev_config(sdev);
887 blk_queue_max_phys_segments(sdev->request_queue, LIBATA_MAX_PRD);
889 if (dev)
890 ata_scsi_dev_config(sdev, dev);
892 return 0; /* scsi layer doesn't check return value, sigh */
896 * ata_scsi_slave_destroy - SCSI device is about to be destroyed
897 * @sdev: SCSI device to be destroyed
899 * @sdev is about to be destroyed for hot/warm unplugging. If
900 * this unplugging was initiated by libata as indicated by NULL
901 * dev->sdev, this function doesn't have to do anything.
902 * Otherwise, SCSI layer initiated warm-unplug is in progress.
903 * Clear dev->sdev, schedule the device for ATA detach and invoke
904 * EH.
906 * LOCKING:
907 * Defined by SCSI layer. We don't really care.
909 void ata_scsi_slave_destroy(struct scsi_device *sdev)
911 struct ata_port *ap = ata_shost_to_port(sdev->host);
912 unsigned long flags;
913 struct ata_device *dev;
915 if (!ap->ops->error_handler)
916 return;
918 spin_lock_irqsave(ap->lock, flags);
919 dev = __ata_scsi_find_dev(ap, sdev);
920 if (dev && dev->sdev) {
921 /* SCSI device already in CANCEL state, no need to offline it */
922 dev->sdev = NULL;
923 dev->flags |= ATA_DFLAG_DETACH;
924 ata_port_schedule_eh(ap);
926 spin_unlock_irqrestore(ap->lock, flags);
930 * ata_scsi_change_queue_depth - SCSI callback for queue depth config
931 * @sdev: SCSI device to configure queue depth for
932 * @queue_depth: new queue depth
934 * This is libata standard hostt->change_queue_depth callback.
935 * SCSI will call into this callback when user tries to set queue
936 * depth via sysfs.
938 * LOCKING:
939 * SCSI layer (we don't care)
941 * RETURNS:
942 * Newly configured queue depth.
944 int ata_scsi_change_queue_depth(struct scsi_device *sdev, int queue_depth)
946 struct ata_port *ap = ata_shost_to_port(sdev->host);
947 struct ata_device *dev;
948 unsigned long flags;
949 int max_depth;
951 if (queue_depth < 1)
952 return sdev->queue_depth;
954 dev = ata_scsi_find_dev(ap, sdev);
955 if (!dev || !ata_dev_enabled(dev))
956 return sdev->queue_depth;
958 max_depth = min(sdev->host->can_queue, ata_id_queue_depth(dev->id));
959 max_depth = min(ATA_MAX_QUEUE - 1, max_depth);
960 if (queue_depth > max_depth)
961 queue_depth = max_depth;
963 scsi_adjust_queue_depth(sdev, MSG_SIMPLE_TAG, queue_depth);
965 spin_lock_irqsave(ap->lock, flags);
966 if (queue_depth > 1)
967 dev->flags &= ~ATA_DFLAG_NCQ_OFF;
968 else
969 dev->flags |= ATA_DFLAG_NCQ_OFF;
970 spin_unlock_irqrestore(ap->lock, flags);
972 return queue_depth;
976 * ata_scsi_start_stop_xlat - Translate SCSI START STOP UNIT command
977 * @qc: Storage for translated ATA taskfile
979 * Sets up an ATA taskfile to issue STANDBY (to stop) or READ VERIFY
980 * (to start). Perhaps these commands should be preceded by
981 * CHECK POWER MODE to see what power mode the device is already in.
982 * [See SAT revision 5 at www.t10.org]
984 * LOCKING:
985 * spin_lock_irqsave(host lock)
987 * RETURNS:
988 * Zero on success, non-zero on error.
990 static unsigned int ata_scsi_start_stop_xlat(struct ata_queued_cmd *qc)
992 struct scsi_cmnd *scmd = qc->scsicmd;
993 struct ata_taskfile *tf = &qc->tf;
994 const u8 *cdb = scmd->cmnd;
996 if (scmd->cmd_len < 5)
997 goto invalid_fld;
999 tf->flags |= ATA_TFLAG_DEVICE | ATA_TFLAG_ISADDR;
1000 tf->protocol = ATA_PROT_NODATA;
1001 if (cdb[1] & 0x1) {
1002 ; /* ignore IMMED bit, violates sat-r05 */
1004 if (cdb[4] & 0x2)
1005 goto invalid_fld; /* LOEJ bit set not supported */
1006 if (((cdb[4] >> 4) & 0xf) != 0)
1007 goto invalid_fld; /* power conditions not supported */
1008 if (cdb[4] & 0x1) {
1009 tf->nsect = 1; /* 1 sector, lba=0 */
1011 if (qc->dev->flags & ATA_DFLAG_LBA) {
1012 tf->flags |= ATA_TFLAG_LBA;
1014 tf->lbah = 0x0;
1015 tf->lbam = 0x0;
1016 tf->lbal = 0x0;
1017 tf->device |= ATA_LBA;
1018 } else {
1019 /* CHS */
1020 tf->lbal = 0x1; /* sect */
1021 tf->lbam = 0x0; /* cyl low */
1022 tf->lbah = 0x0; /* cyl high */
1025 tf->command = ATA_CMD_VERIFY; /* READ VERIFY */
1026 } else
1027 /* Issue ATA STANDBY IMMEDIATE command */
1028 tf->command = ATA_CMD_STANDBYNOW1;
1031 * Standby and Idle condition timers could be implemented but that
1032 * would require libata to implement the Power condition mode page
1033 * and allow the user to change it. Changing mode pages requires
1034 * MODE SELECT to be implemented.
1037 return 0;
1039 invalid_fld:
1040 ata_scsi_set_sense(scmd, ILLEGAL_REQUEST, 0x24, 0x0);
1041 /* "Invalid field in cbd" */
1042 return 1;
1047 * ata_scsi_flush_xlat - Translate SCSI SYNCHRONIZE CACHE command
1048 * @qc: Storage for translated ATA taskfile
1050 * Sets up an ATA taskfile to issue FLUSH CACHE or
1051 * FLUSH CACHE EXT.
1053 * LOCKING:
1054 * spin_lock_irqsave(host lock)
1056 * RETURNS:
1057 * Zero on success, non-zero on error.
1059 static unsigned int ata_scsi_flush_xlat(struct ata_queued_cmd *qc)
1061 struct ata_taskfile *tf = &qc->tf;
1063 tf->flags |= ATA_TFLAG_DEVICE;
1064 tf->protocol = ATA_PROT_NODATA;
1066 if (qc->dev->flags & ATA_DFLAG_FLUSH_EXT)
1067 tf->command = ATA_CMD_FLUSH_EXT;
1068 else
1069 tf->command = ATA_CMD_FLUSH;
1071 return 0;
1075 * scsi_6_lba_len - Get LBA and transfer length
1076 * @cdb: SCSI command to translate
1078 * Calculate LBA and transfer length for 6-byte commands.
1080 * RETURNS:
1081 * @plba: the LBA
1082 * @plen: the transfer length
1084 static void scsi_6_lba_len(const u8 *cdb, u64 *plba, u32 *plen)
1086 u64 lba = 0;
1087 u32 len = 0;
1089 VPRINTK("six-byte command\n");
1091 lba |= ((u64)cdb[2]) << 8;
1092 lba |= ((u64)cdb[3]);
1094 len |= ((u32)cdb[4]);
1096 *plba = lba;
1097 *plen = len;
1101 * scsi_10_lba_len - Get LBA and transfer length
1102 * @cdb: SCSI command to translate
1104 * Calculate LBA and transfer length for 10-byte commands.
1106 * RETURNS:
1107 * @plba: the LBA
1108 * @plen: the transfer length
1110 static void scsi_10_lba_len(const u8 *cdb, u64 *plba, u32 *plen)
1112 u64 lba = 0;
1113 u32 len = 0;
1115 VPRINTK("ten-byte command\n");
1117 lba |= ((u64)cdb[2]) << 24;
1118 lba |= ((u64)cdb[3]) << 16;
1119 lba |= ((u64)cdb[4]) << 8;
1120 lba |= ((u64)cdb[5]);
1122 len |= ((u32)cdb[7]) << 8;
1123 len |= ((u32)cdb[8]);
1125 *plba = lba;
1126 *plen = len;
1130 * scsi_16_lba_len - Get LBA and transfer length
1131 * @cdb: SCSI command to translate
1133 * Calculate LBA and transfer length for 16-byte commands.
1135 * RETURNS:
1136 * @plba: the LBA
1137 * @plen: the transfer length
1139 static void scsi_16_lba_len(const u8 *cdb, u64 *plba, u32 *plen)
1141 u64 lba = 0;
1142 u32 len = 0;
1144 VPRINTK("sixteen-byte command\n");
1146 lba |= ((u64)cdb[2]) << 56;
1147 lba |= ((u64)cdb[3]) << 48;
1148 lba |= ((u64)cdb[4]) << 40;
1149 lba |= ((u64)cdb[5]) << 32;
1150 lba |= ((u64)cdb[6]) << 24;
1151 lba |= ((u64)cdb[7]) << 16;
1152 lba |= ((u64)cdb[8]) << 8;
1153 lba |= ((u64)cdb[9]);
1155 len |= ((u32)cdb[10]) << 24;
1156 len |= ((u32)cdb[11]) << 16;
1157 len |= ((u32)cdb[12]) << 8;
1158 len |= ((u32)cdb[13]);
1160 *plba = lba;
1161 *plen = len;
1165 * ata_scsi_verify_xlat - Translate SCSI VERIFY command into an ATA one
1166 * @qc: Storage for translated ATA taskfile
1168 * Converts SCSI VERIFY command to an ATA READ VERIFY command.
1170 * LOCKING:
1171 * spin_lock_irqsave(host lock)
1173 * RETURNS:
1174 * Zero on success, non-zero on error.
1176 static unsigned int ata_scsi_verify_xlat(struct ata_queued_cmd *qc)
1178 struct scsi_cmnd *scmd = qc->scsicmd;
1179 struct ata_taskfile *tf = &qc->tf;
1180 struct ata_device *dev = qc->dev;
1181 u64 dev_sectors = qc->dev->n_sectors;
1182 const u8 *cdb = scmd->cmnd;
1183 u64 block;
1184 u32 n_block;
1186 tf->flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
1187 tf->protocol = ATA_PROT_NODATA;
1189 if (cdb[0] == VERIFY) {
1190 if (scmd->cmd_len < 10)
1191 goto invalid_fld;
1192 scsi_10_lba_len(cdb, &block, &n_block);
1193 } else if (cdb[0] == VERIFY_16) {
1194 if (scmd->cmd_len < 16)
1195 goto invalid_fld;
1196 scsi_16_lba_len(cdb, &block, &n_block);
1197 } else
1198 goto invalid_fld;
1200 if (!n_block)
1201 goto nothing_to_do;
1202 if (block >= dev_sectors)
1203 goto out_of_range;
1204 if ((block + n_block) > dev_sectors)
1205 goto out_of_range;
1207 if (dev->flags & ATA_DFLAG_LBA) {
1208 tf->flags |= ATA_TFLAG_LBA;
1210 if (lba_28_ok(block, n_block)) {
1211 /* use LBA28 */
1212 tf->command = ATA_CMD_VERIFY;
1213 tf->device |= (block >> 24) & 0xf;
1214 } else if (lba_48_ok(block, n_block)) {
1215 if (!(dev->flags & ATA_DFLAG_LBA48))
1216 goto out_of_range;
1218 /* use LBA48 */
1219 tf->flags |= ATA_TFLAG_LBA48;
1220 tf->command = ATA_CMD_VERIFY_EXT;
1222 tf->hob_nsect = (n_block >> 8) & 0xff;
1224 tf->hob_lbah = (block >> 40) & 0xff;
1225 tf->hob_lbam = (block >> 32) & 0xff;
1226 tf->hob_lbal = (block >> 24) & 0xff;
1227 } else
1228 /* request too large even for LBA48 */
1229 goto out_of_range;
1231 tf->nsect = n_block & 0xff;
1233 tf->lbah = (block >> 16) & 0xff;
1234 tf->lbam = (block >> 8) & 0xff;
1235 tf->lbal = block & 0xff;
1237 tf->device |= ATA_LBA;
1238 } else {
1239 /* CHS */
1240 u32 sect, head, cyl, track;
1242 if (!lba_28_ok(block, n_block))
1243 goto out_of_range;
1245 /* Convert LBA to CHS */
1246 track = (u32)block / dev->sectors;
1247 cyl = track / dev->heads;
1248 head = track % dev->heads;
1249 sect = (u32)block % dev->sectors + 1;
1251 DPRINTK("block %u track %u cyl %u head %u sect %u\n",
1252 (u32)block, track, cyl, head, sect);
1254 /* Check whether the converted CHS can fit.
1255 Cylinder: 0-65535
1256 Head: 0-15
1257 Sector: 1-255*/
1258 if ((cyl >> 16) || (head >> 4) || (sect >> 8) || (!sect))
1259 goto out_of_range;
1261 tf->command = ATA_CMD_VERIFY;
1262 tf->nsect = n_block & 0xff; /* Sector count 0 means 256 sectors */
1263 tf->lbal = sect;
1264 tf->lbam = cyl;
1265 tf->lbah = cyl >> 8;
1266 tf->device |= head;
1269 return 0;
1271 invalid_fld:
1272 ata_scsi_set_sense(scmd, ILLEGAL_REQUEST, 0x24, 0x0);
1273 /* "Invalid field in cbd" */
1274 return 1;
1276 out_of_range:
1277 ata_scsi_set_sense(scmd, ILLEGAL_REQUEST, 0x21, 0x0);
1278 /* "Logical Block Address out of range" */
1279 return 1;
1281 nothing_to_do:
1282 scmd->result = SAM_STAT_GOOD;
1283 return 1;
1287 * ata_scsi_rw_xlat - Translate SCSI r/w command into an ATA one
1288 * @qc: Storage for translated ATA taskfile
1290 * Converts any of six SCSI read/write commands into the
1291 * ATA counterpart, including starting sector (LBA),
1292 * sector count, and taking into account the device's LBA48
1293 * support.
1295 * Commands %READ_6, %READ_10, %READ_16, %WRITE_6, %WRITE_10, and
1296 * %WRITE_16 are currently supported.
1298 * LOCKING:
1299 * spin_lock_irqsave(host lock)
1301 * RETURNS:
1302 * Zero on success, non-zero on error.
1304 static unsigned int ata_scsi_rw_xlat(struct ata_queued_cmd *qc)
1306 struct scsi_cmnd *scmd = qc->scsicmd;
1307 const u8 *cdb = scmd->cmnd;
1308 unsigned int tf_flags = 0;
1309 u64 block;
1310 u32 n_block;
1311 int rc;
1313 if (cdb[0] == WRITE_10 || cdb[0] == WRITE_6 || cdb[0] == WRITE_16)
1314 tf_flags |= ATA_TFLAG_WRITE;
1316 /* Calculate the SCSI LBA, transfer length and FUA. */
1317 switch (cdb[0]) {
1318 case READ_10:
1319 case WRITE_10:
1320 if (unlikely(scmd->cmd_len < 10))
1321 goto invalid_fld;
1322 scsi_10_lba_len(cdb, &block, &n_block);
1323 if (unlikely(cdb[1] & (1 << 3)))
1324 tf_flags |= ATA_TFLAG_FUA;
1325 break;
1326 case READ_6:
1327 case WRITE_6:
1328 if (unlikely(scmd->cmd_len < 6))
1329 goto invalid_fld;
1330 scsi_6_lba_len(cdb, &block, &n_block);
1332 /* for 6-byte r/w commands, transfer length 0
1333 * means 256 blocks of data, not 0 block.
1335 if (!n_block)
1336 n_block = 256;
1337 break;
1338 case READ_16:
1339 case WRITE_16:
1340 if (unlikely(scmd->cmd_len < 16))
1341 goto invalid_fld;
1342 scsi_16_lba_len(cdb, &block, &n_block);
1343 if (unlikely(cdb[1] & (1 << 3)))
1344 tf_flags |= ATA_TFLAG_FUA;
1345 break;
1346 default:
1347 DPRINTK("no-byte command\n");
1348 goto invalid_fld;
1351 /* Check and compose ATA command */
1352 if (!n_block)
1353 /* For 10-byte and 16-byte SCSI R/W commands, transfer
1354 * length 0 means transfer 0 block of data.
1355 * However, for ATA R/W commands, sector count 0 means
1356 * 256 or 65536 sectors, not 0 sectors as in SCSI.
1358 * WARNING: one or two older ATA drives treat 0 as 0...
1360 goto nothing_to_do;
1362 qc->flags |= ATA_QCFLAG_IO;
1363 qc->nsect = n_block;
1365 rc = ata_build_rw_tf(&qc->tf, qc->dev, block, n_block, tf_flags,
1366 qc->tag);
1367 if (likely(rc == 0))
1368 return 0;
1370 if (rc == -ERANGE)
1371 goto out_of_range;
1372 /* treat all other errors as -EINVAL, fall through */
1373 invalid_fld:
1374 ata_scsi_set_sense(scmd, ILLEGAL_REQUEST, 0x24, 0x0);
1375 /* "Invalid field in cbd" */
1376 return 1;
1378 out_of_range:
1379 ata_scsi_set_sense(scmd, ILLEGAL_REQUEST, 0x21, 0x0);
1380 /* "Logical Block Address out of range" */
1381 return 1;
1383 nothing_to_do:
1384 scmd->result = SAM_STAT_GOOD;
1385 return 1;
1388 static void ata_scsi_qc_complete(struct ata_queued_cmd *qc)
1390 struct ata_port *ap = qc->ap;
1391 struct scsi_cmnd *cmd = qc->scsicmd;
1392 u8 *cdb = cmd->cmnd;
1393 int need_sense = (qc->err_mask != 0);
1395 /* We snoop the SET_FEATURES - Write Cache ON/OFF command, and
1396 * schedule EH_REVALIDATE operation to update the IDENTIFY DEVICE
1397 * cache
1399 if (ap->ops->error_handler &&
1400 !need_sense && (qc->tf.command == ATA_CMD_SET_FEATURES) &&
1401 ((qc->tf.feature == SETFEATURES_WC_ON) ||
1402 (qc->tf.feature == SETFEATURES_WC_OFF))) {
1403 ap->eh_info.action |= ATA_EH_REVALIDATE;
1404 ata_port_schedule_eh(ap);
1407 /* For ATA pass thru (SAT) commands, generate a sense block if
1408 * user mandated it or if there's an error. Note that if we
1409 * generate because the user forced us to, a check condition
1410 * is generated and the ATA register values are returned
1411 * whether the command completed successfully or not. If there
1412 * was no error, SK, ASC and ASCQ will all be zero.
1414 if (((cdb[0] == ATA_16) || (cdb[0] == ATA_12)) &&
1415 ((cdb[2] & 0x20) || need_sense)) {
1416 ata_gen_passthru_sense(qc);
1417 } else {
1418 if (!need_sense) {
1419 cmd->result = SAM_STAT_GOOD;
1420 } else {
1421 /* TODO: decide which descriptor format to use
1422 * for 48b LBA devices and call that here
1423 * instead of the fixed desc, which is only
1424 * good for smaller LBA (and maybe CHS?)
1425 * devices.
1427 ata_gen_ata_sense(qc);
1431 if (need_sense && !ap->ops->error_handler)
1432 ata_dump_status(ap->id, &qc->result_tf);
1434 qc->scsidone(cmd);
1436 ata_qc_free(qc);
1440 * ata_scmd_need_defer - Check whether we need to defer scmd
1441 * @dev: ATA device to which the command is addressed
1442 * @is_io: Is the command IO (and thus possibly NCQ)?
1444 * NCQ and non-NCQ commands cannot run together. As upper layer
1445 * only knows the queue depth, we are responsible for maintaining
1446 * exclusion. This function checks whether a new command can be
1447 * issued to @dev.
1449 * LOCKING:
1450 * spin_lock_irqsave(host lock)
1452 * RETURNS:
1453 * 1 if deferring is needed, 0 otherwise.
1455 static int ata_scmd_need_defer(struct ata_device *dev, int is_io)
1457 struct ata_port *ap = dev->ap;
1459 if (!(dev->flags & ATA_DFLAG_NCQ))
1460 return 0;
1462 if (is_io) {
1463 if (!ata_tag_valid(ap->active_tag))
1464 return 0;
1465 } else {
1466 if (!ata_tag_valid(ap->active_tag) && !ap->sactive)
1467 return 0;
1469 return 1;
1473 * ata_scsi_translate - Translate then issue SCSI command to ATA device
1474 * @dev: ATA device to which the command is addressed
1475 * @cmd: SCSI command to execute
1476 * @done: SCSI command completion function
1477 * @xlat_func: Actor which translates @cmd to an ATA taskfile
1479 * Our ->queuecommand() function has decided that the SCSI
1480 * command issued can be directly translated into an ATA
1481 * command, rather than handled internally.
1483 * This function sets up an ata_queued_cmd structure for the
1484 * SCSI command, and sends that ata_queued_cmd to the hardware.
1486 * The xlat_func argument (actor) returns 0 if ready to execute
1487 * ATA command, else 1 to finish translation. If 1 is returned
1488 * then cmd->result (and possibly cmd->sense_buffer) are assumed
1489 * to be set reflecting an error condition or clean (early)
1490 * termination.
1492 * LOCKING:
1493 * spin_lock_irqsave(host lock)
1495 * RETURNS:
1496 * 0 on success, SCSI_ML_QUEUE_DEVICE_BUSY if the command
1497 * needs to be deferred.
1499 static int ata_scsi_translate(struct ata_device *dev, struct scsi_cmnd *cmd,
1500 void (*done)(struct scsi_cmnd *),
1501 ata_xlat_func_t xlat_func)
1503 struct ata_queued_cmd *qc;
1504 int is_io = xlat_func == ata_scsi_rw_xlat;
1506 VPRINTK("ENTER\n");
1508 if (unlikely(ata_scmd_need_defer(dev, is_io)))
1509 goto defer;
1511 qc = ata_scsi_qc_new(dev, cmd, done);
1512 if (!qc)
1513 goto err_mem;
1515 /* data is present; dma-map it */
1516 if (cmd->sc_data_direction == DMA_FROM_DEVICE ||
1517 cmd->sc_data_direction == DMA_TO_DEVICE) {
1518 if (unlikely(cmd->request_bufflen < 1)) {
1519 ata_dev_printk(dev, KERN_WARNING,
1520 "WARNING: zero len r/w req\n");
1521 goto err_did;
1524 if (cmd->use_sg)
1525 ata_sg_init(qc, cmd->request_buffer, cmd->use_sg);
1526 else
1527 ata_sg_init_one(qc, cmd->request_buffer,
1528 cmd->request_bufflen);
1530 qc->dma_dir = cmd->sc_data_direction;
1533 qc->complete_fn = ata_scsi_qc_complete;
1535 if (xlat_func(qc))
1536 goto early_finish;
1538 /* select device, send command to hardware */
1539 ata_qc_issue(qc);
1541 VPRINTK("EXIT\n");
1542 return 0;
1544 early_finish:
1545 ata_qc_free(qc);
1546 done(cmd);
1547 DPRINTK("EXIT - early finish (good or error)\n");
1548 return 0;
1550 err_did:
1551 ata_qc_free(qc);
1552 cmd->result = (DID_ERROR << 16);
1553 done(cmd);
1554 err_mem:
1555 DPRINTK("EXIT - internal\n");
1556 return 0;
1558 defer:
1559 DPRINTK("EXIT - defer\n");
1560 return SCSI_MLQUEUE_DEVICE_BUSY;
1564 * ata_scsi_rbuf_get - Map response buffer.
1565 * @cmd: SCSI command containing buffer to be mapped.
1566 * @buf_out: Pointer to mapped area.
1568 * Maps buffer contained within SCSI command @cmd.
1570 * LOCKING:
1571 * spin_lock_irqsave(host lock)
1573 * RETURNS:
1574 * Length of response buffer.
1577 static unsigned int ata_scsi_rbuf_get(struct scsi_cmnd *cmd, u8 **buf_out)
1579 u8 *buf;
1580 unsigned int buflen;
1582 if (cmd->use_sg) {
1583 struct scatterlist *sg;
1585 sg = (struct scatterlist *) cmd->request_buffer;
1586 buf = kmap_atomic(sg->page, KM_IRQ0) + sg->offset;
1587 buflen = sg->length;
1588 } else {
1589 buf = cmd->request_buffer;
1590 buflen = cmd->request_bufflen;
1593 *buf_out = buf;
1594 return buflen;
1598 * ata_scsi_rbuf_put - Unmap response buffer.
1599 * @cmd: SCSI command containing buffer to be unmapped.
1600 * @buf: buffer to unmap
1602 * Unmaps response buffer contained within @cmd.
1604 * LOCKING:
1605 * spin_lock_irqsave(host lock)
1608 static inline void ata_scsi_rbuf_put(struct scsi_cmnd *cmd, u8 *buf)
1610 if (cmd->use_sg) {
1611 struct scatterlist *sg;
1613 sg = (struct scatterlist *) cmd->request_buffer;
1614 kunmap_atomic(buf - sg->offset, KM_IRQ0);
1619 * ata_scsi_rbuf_fill - wrapper for SCSI command simulators
1620 * @args: device IDENTIFY data / SCSI command of interest.
1621 * @actor: Callback hook for desired SCSI command simulator
1623 * Takes care of the hard work of simulating a SCSI command...
1624 * Mapping the response buffer, calling the command's handler,
1625 * and handling the handler's return value. This return value
1626 * indicates whether the handler wishes the SCSI command to be
1627 * completed successfully (0), or not (in which case cmd->result
1628 * and sense buffer are assumed to be set).
1630 * LOCKING:
1631 * spin_lock_irqsave(host lock)
1634 void ata_scsi_rbuf_fill(struct ata_scsi_args *args,
1635 unsigned int (*actor) (struct ata_scsi_args *args,
1636 u8 *rbuf, unsigned int buflen))
1638 u8 *rbuf;
1639 unsigned int buflen, rc;
1640 struct scsi_cmnd *cmd = args->cmd;
1642 buflen = ata_scsi_rbuf_get(cmd, &rbuf);
1643 memset(rbuf, 0, buflen);
1644 rc = actor(args, rbuf, buflen);
1645 ata_scsi_rbuf_put(cmd, rbuf);
1647 if (rc == 0)
1648 cmd->result = SAM_STAT_GOOD;
1649 args->done(cmd);
1653 * ATA_SCSI_RBUF_SET - helper to set values in SCSI response buffer
1654 * @idx: byte index into SCSI response buffer
1655 * @val: value to set
1657 * To be used by SCSI command simulator functions. This macros
1658 * expects two local variables, u8 *rbuf and unsigned int buflen,
1659 * are in scope.
1661 * LOCKING:
1662 * None.
1664 #define ATA_SCSI_RBUF_SET(idx, val) do { \
1665 if ((idx) < buflen) rbuf[(idx)] = (u8)(val); \
1666 } while (0)
1669 * ata_scsiop_inq_std - Simulate INQUIRY command
1670 * @args: device IDENTIFY data / SCSI command of interest.
1671 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1672 * @buflen: Response buffer length.
1674 * Returns standard device identification data associated
1675 * with non-VPD INQUIRY command output.
1677 * LOCKING:
1678 * spin_lock_irqsave(host lock)
1681 unsigned int ata_scsiop_inq_std(struct ata_scsi_args *args, u8 *rbuf,
1682 unsigned int buflen)
1684 u8 hdr[] = {
1685 TYPE_DISK,
1687 0x5, /* claim SPC-3 version compatibility */
1689 95 - 4
1692 /* set scsi removeable (RMB) bit per ata bit */
1693 if (ata_id_removeable(args->id))
1694 hdr[1] |= (1 << 7);
1696 VPRINTK("ENTER\n");
1698 memcpy(rbuf, hdr, sizeof(hdr));
1700 if (buflen > 35) {
1701 memcpy(&rbuf[8], "ATA ", 8);
1702 ata_id_string(args->id, &rbuf[16], ATA_ID_PROD_OFS, 16);
1703 ata_id_string(args->id, &rbuf[32], ATA_ID_FW_REV_OFS, 4);
1704 if (rbuf[32] == 0 || rbuf[32] == ' ')
1705 memcpy(&rbuf[32], "n/a ", 4);
1708 if (buflen > 63) {
1709 const u8 versions[] = {
1710 0x60, /* SAM-3 (no version claimed) */
1712 0x03,
1713 0x20, /* SBC-2 (no version claimed) */
1715 0x02,
1716 0x60 /* SPC-3 (no version claimed) */
1719 memcpy(rbuf + 59, versions, sizeof(versions));
1722 return 0;
1726 * ata_scsiop_inq_00 - Simulate INQUIRY VPD page 0, list of pages
1727 * @args: device IDENTIFY data / SCSI command of interest.
1728 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1729 * @buflen: Response buffer length.
1731 * Returns list of inquiry VPD pages available.
1733 * LOCKING:
1734 * spin_lock_irqsave(host lock)
1737 unsigned int ata_scsiop_inq_00(struct ata_scsi_args *args, u8 *rbuf,
1738 unsigned int buflen)
1740 const u8 pages[] = {
1741 0x00, /* page 0x00, this page */
1742 0x80, /* page 0x80, unit serial no page */
1743 0x83 /* page 0x83, device ident page */
1745 rbuf[3] = sizeof(pages); /* number of supported VPD pages */
1747 if (buflen > 6)
1748 memcpy(rbuf + 4, pages, sizeof(pages));
1750 return 0;
1754 * ata_scsiop_inq_80 - Simulate INQUIRY VPD page 80, device serial number
1755 * @args: device IDENTIFY data / SCSI command of interest.
1756 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1757 * @buflen: Response buffer length.
1759 * Returns ATA device serial number.
1761 * LOCKING:
1762 * spin_lock_irqsave(host lock)
1765 unsigned int ata_scsiop_inq_80(struct ata_scsi_args *args, u8 *rbuf,
1766 unsigned int buflen)
1768 const u8 hdr[] = {
1770 0x80, /* this page code */
1772 ATA_SERNO_LEN, /* page len */
1774 memcpy(rbuf, hdr, sizeof(hdr));
1776 if (buflen > (ATA_SERNO_LEN + 4 - 1))
1777 ata_id_string(args->id, (unsigned char *) &rbuf[4],
1778 ATA_ID_SERNO_OFS, ATA_SERNO_LEN);
1780 return 0;
1784 * ata_scsiop_inq_83 - Simulate INQUIRY VPD page 83, device identity
1785 * @args: device IDENTIFY data / SCSI command of interest.
1786 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1787 * @buflen: Response buffer length.
1789 * Yields two logical unit device identification designators:
1790 * - vendor specific ASCII containing the ATA serial number
1791 * - SAT defined "t10 vendor id based" containing ASCII vendor
1792 * name ("ATA "), model and serial numbers.
1794 * LOCKING:
1795 * spin_lock_irqsave(host lock)
1798 unsigned int ata_scsiop_inq_83(struct ata_scsi_args *args, u8 *rbuf,
1799 unsigned int buflen)
1801 int num;
1802 const int sat_model_serial_desc_len = 68;
1803 const int ata_model_byte_len = 40;
1805 rbuf[1] = 0x83; /* this page code */
1806 num = 4;
1808 if (buflen > (ATA_SERNO_LEN + num + 3)) {
1809 /* piv=0, assoc=lu, code_set=ACSII, designator=vendor */
1810 rbuf[num + 0] = 2;
1811 rbuf[num + 3] = ATA_SERNO_LEN;
1812 num += 4;
1813 ata_id_string(args->id, (unsigned char *) rbuf + num,
1814 ATA_ID_SERNO_OFS, ATA_SERNO_LEN);
1815 num += ATA_SERNO_LEN;
1817 if (buflen > (sat_model_serial_desc_len + num + 3)) {
1818 /* SAT defined lu model and serial numbers descriptor */
1819 /* piv=0, assoc=lu, code_set=ACSII, designator=t10 vendor id */
1820 rbuf[num + 0] = 2;
1821 rbuf[num + 1] = 1;
1822 rbuf[num + 3] = sat_model_serial_desc_len;
1823 num += 4;
1824 memcpy(rbuf + num, "ATA ", 8);
1825 num += 8;
1826 ata_id_string(args->id, (unsigned char *) rbuf + num,
1827 ATA_ID_PROD_OFS, ata_model_byte_len);
1828 num += ata_model_byte_len;
1829 ata_id_string(args->id, (unsigned char *) rbuf + num,
1830 ATA_ID_SERNO_OFS, ATA_SERNO_LEN);
1831 num += ATA_SERNO_LEN;
1833 rbuf[3] = num - 4; /* page len (assume less than 256 bytes) */
1834 return 0;
1838 * ata_scsiop_noop - Command handler that simply returns success.
1839 * @args: device IDENTIFY data / SCSI command of interest.
1840 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1841 * @buflen: Response buffer length.
1843 * No operation. Simply returns success to caller, to indicate
1844 * that the caller should successfully complete this SCSI command.
1846 * LOCKING:
1847 * spin_lock_irqsave(host lock)
1850 unsigned int ata_scsiop_noop(struct ata_scsi_args *args, u8 *rbuf,
1851 unsigned int buflen)
1853 VPRINTK("ENTER\n");
1854 return 0;
1858 * ata_msense_push - Push data onto MODE SENSE data output buffer
1859 * @ptr_io: (input/output) Location to store more output data
1860 * @last: End of output data buffer
1861 * @buf: Pointer to BLOB being added to output buffer
1862 * @buflen: Length of BLOB
1864 * Store MODE SENSE data on an output buffer.
1866 * LOCKING:
1867 * None.
1870 static void ata_msense_push(u8 **ptr_io, const u8 *last,
1871 const u8 *buf, unsigned int buflen)
1873 u8 *ptr = *ptr_io;
1875 if ((ptr + buflen - 1) > last)
1876 return;
1878 memcpy(ptr, buf, buflen);
1880 ptr += buflen;
1882 *ptr_io = ptr;
1886 * ata_msense_caching - Simulate MODE SENSE caching info page
1887 * @id: device IDENTIFY data
1888 * @ptr_io: (input/output) Location to store more output data
1889 * @last: End of output data buffer
1891 * Generate a caching info page, which conditionally indicates
1892 * write caching to the SCSI layer, depending on device
1893 * capabilities.
1895 * LOCKING:
1896 * None.
1899 static unsigned int ata_msense_caching(u16 *id, u8 **ptr_io,
1900 const u8 *last)
1902 u8 page[CACHE_MPAGE_LEN];
1904 memcpy(page, def_cache_mpage, sizeof(page));
1905 if (ata_id_wcache_enabled(id))
1906 page[2] |= (1 << 2); /* write cache enable */
1907 if (!ata_id_rahead_enabled(id))
1908 page[12] |= (1 << 5); /* disable read ahead */
1910 ata_msense_push(ptr_io, last, page, sizeof(page));
1911 return sizeof(page);
1915 * ata_msense_ctl_mode - Simulate MODE SENSE control mode page
1916 * @dev: Device associated with this MODE SENSE command
1917 * @ptr_io: (input/output) Location to store more output data
1918 * @last: End of output data buffer
1920 * Generate a generic MODE SENSE control mode page.
1922 * LOCKING:
1923 * None.
1926 static unsigned int ata_msense_ctl_mode(u8 **ptr_io, const u8 *last)
1928 ata_msense_push(ptr_io, last, def_control_mpage,
1929 sizeof(def_control_mpage));
1930 return sizeof(def_control_mpage);
1934 * ata_msense_rw_recovery - Simulate MODE SENSE r/w error recovery page
1935 * @dev: Device associated with this MODE SENSE command
1936 * @ptr_io: (input/output) Location to store more output data
1937 * @last: End of output data buffer
1939 * Generate a generic MODE SENSE r/w error recovery page.
1941 * LOCKING:
1942 * None.
1945 static unsigned int ata_msense_rw_recovery(u8 **ptr_io, const u8 *last)
1948 ata_msense_push(ptr_io, last, def_rw_recovery_mpage,
1949 sizeof(def_rw_recovery_mpage));
1950 return sizeof(def_rw_recovery_mpage);
1954 * We can turn this into a real blacklist if it's needed, for now just
1955 * blacklist any Maxtor BANC1G10 revision firmware
1957 static int ata_dev_supports_fua(u16 *id)
1959 unsigned char model[41], fw[9];
1961 if (!libata_fua)
1962 return 0;
1963 if (!ata_id_has_fua(id))
1964 return 0;
1966 ata_id_c_string(id, model, ATA_ID_PROD_OFS, sizeof(model));
1967 ata_id_c_string(id, fw, ATA_ID_FW_REV_OFS, sizeof(fw));
1969 if (strcmp(model, "Maxtor"))
1970 return 1;
1971 if (strcmp(fw, "BANC1G10"))
1972 return 1;
1974 return 0; /* blacklisted */
1978 * ata_scsiop_mode_sense - Simulate MODE SENSE 6, 10 commands
1979 * @args: device IDENTIFY data / SCSI command of interest.
1980 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1981 * @buflen: Response buffer length.
1983 * Simulate MODE SENSE commands. Assume this is invoked for direct
1984 * access devices (e.g. disks) only. There should be no block
1985 * descriptor for other device types.
1987 * LOCKING:
1988 * spin_lock_irqsave(host lock)
1991 unsigned int ata_scsiop_mode_sense(struct ata_scsi_args *args, u8 *rbuf,
1992 unsigned int buflen)
1994 struct ata_device *dev = args->dev;
1995 u8 *scsicmd = args->cmd->cmnd, *p, *last;
1996 const u8 sat_blk_desc[] = {
1997 0, 0, 0, 0, /* number of blocks: sat unspecified */
1999 0, 0x2, 0x0 /* block length: 512 bytes */
2001 u8 pg, spg;
2002 unsigned int ebd, page_control, six_byte, output_len, alloc_len, minlen;
2003 u8 dpofua;
2005 VPRINTK("ENTER\n");
2007 six_byte = (scsicmd[0] == MODE_SENSE);
2008 ebd = !(scsicmd[1] & 0x8); /* dbd bit inverted == edb */
2010 * LLBA bit in msense(10) ignored (compliant)
2013 page_control = scsicmd[2] >> 6;
2014 switch (page_control) {
2015 case 0: /* current */
2016 break; /* supported */
2017 case 3: /* saved */
2018 goto saving_not_supp;
2019 case 1: /* changeable */
2020 case 2: /* defaults */
2021 default:
2022 goto invalid_fld;
2025 if (six_byte) {
2026 output_len = 4 + (ebd ? 8 : 0);
2027 alloc_len = scsicmd[4];
2028 } else {
2029 output_len = 8 + (ebd ? 8 : 0);
2030 alloc_len = (scsicmd[7] << 8) + scsicmd[8];
2032 minlen = (alloc_len < buflen) ? alloc_len : buflen;
2034 p = rbuf + output_len;
2035 last = rbuf + minlen - 1;
2037 pg = scsicmd[2] & 0x3f;
2038 spg = scsicmd[3];
2040 * No mode subpages supported (yet) but asking for _all_
2041 * subpages may be valid
2043 if (spg && (spg != ALL_SUB_MPAGES))
2044 goto invalid_fld;
2046 switch(pg) {
2047 case RW_RECOVERY_MPAGE:
2048 output_len += ata_msense_rw_recovery(&p, last);
2049 break;
2051 case CACHE_MPAGE:
2052 output_len += ata_msense_caching(args->id, &p, last);
2053 break;
2055 case CONTROL_MPAGE: {
2056 output_len += ata_msense_ctl_mode(&p, last);
2057 break;
2060 case ALL_MPAGES:
2061 output_len += ata_msense_rw_recovery(&p, last);
2062 output_len += ata_msense_caching(args->id, &p, last);
2063 output_len += ata_msense_ctl_mode(&p, last);
2064 break;
2066 default: /* invalid page code */
2067 goto invalid_fld;
2070 if (minlen < 1)
2071 return 0;
2073 dpofua = 0;
2074 if (ata_dev_supports_fua(args->id) && (dev->flags & ATA_DFLAG_LBA48) &&
2075 (!(dev->flags & ATA_DFLAG_PIO) || dev->multi_count))
2076 dpofua = 1 << 4;
2078 if (six_byte) {
2079 output_len--;
2080 rbuf[0] = output_len;
2081 if (minlen > 2)
2082 rbuf[2] |= dpofua;
2083 if (ebd) {
2084 if (minlen > 3)
2085 rbuf[3] = sizeof(sat_blk_desc);
2086 if (minlen > 11)
2087 memcpy(rbuf + 4, sat_blk_desc,
2088 sizeof(sat_blk_desc));
2090 } else {
2091 output_len -= 2;
2092 rbuf[0] = output_len >> 8;
2093 if (minlen > 1)
2094 rbuf[1] = output_len;
2095 if (minlen > 3)
2096 rbuf[3] |= dpofua;
2097 if (ebd) {
2098 if (minlen > 7)
2099 rbuf[7] = sizeof(sat_blk_desc);
2100 if (minlen > 15)
2101 memcpy(rbuf + 8, sat_blk_desc,
2102 sizeof(sat_blk_desc));
2105 return 0;
2107 invalid_fld:
2108 ata_scsi_set_sense(args->cmd, ILLEGAL_REQUEST, 0x24, 0x0);
2109 /* "Invalid field in cbd" */
2110 return 1;
2112 saving_not_supp:
2113 ata_scsi_set_sense(args->cmd, ILLEGAL_REQUEST, 0x39, 0x0);
2114 /* "Saving parameters not supported" */
2115 return 1;
2119 * ata_scsiop_read_cap - Simulate READ CAPACITY[ 16] commands
2120 * @args: device IDENTIFY data / SCSI command of interest.
2121 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2122 * @buflen: Response buffer length.
2124 * Simulate READ CAPACITY commands.
2126 * LOCKING:
2127 * None.
2129 unsigned int ata_scsiop_read_cap(struct ata_scsi_args *args, u8 *rbuf,
2130 unsigned int buflen)
2132 u64 last_lba = args->dev->n_sectors - 1; /* LBA of the last block */
2134 VPRINTK("ENTER\n");
2136 if (args->cmd->cmnd[0] == READ_CAPACITY) {
2137 if (last_lba >= 0xffffffffULL)
2138 last_lba = 0xffffffff;
2140 /* sector count, 32-bit */
2141 ATA_SCSI_RBUF_SET(0, last_lba >> (8 * 3));
2142 ATA_SCSI_RBUF_SET(1, last_lba >> (8 * 2));
2143 ATA_SCSI_RBUF_SET(2, last_lba >> (8 * 1));
2144 ATA_SCSI_RBUF_SET(3, last_lba);
2146 /* sector size */
2147 ATA_SCSI_RBUF_SET(6, ATA_SECT_SIZE >> 8);
2148 ATA_SCSI_RBUF_SET(7, ATA_SECT_SIZE);
2149 } else {
2150 /* sector count, 64-bit */
2151 ATA_SCSI_RBUF_SET(0, last_lba >> (8 * 7));
2152 ATA_SCSI_RBUF_SET(1, last_lba >> (8 * 6));
2153 ATA_SCSI_RBUF_SET(2, last_lba >> (8 * 5));
2154 ATA_SCSI_RBUF_SET(3, last_lba >> (8 * 4));
2155 ATA_SCSI_RBUF_SET(4, last_lba >> (8 * 3));
2156 ATA_SCSI_RBUF_SET(5, last_lba >> (8 * 2));
2157 ATA_SCSI_RBUF_SET(6, last_lba >> (8 * 1));
2158 ATA_SCSI_RBUF_SET(7, last_lba);
2160 /* sector size */
2161 ATA_SCSI_RBUF_SET(10, ATA_SECT_SIZE >> 8);
2162 ATA_SCSI_RBUF_SET(11, ATA_SECT_SIZE);
2165 return 0;
2169 * ata_scsiop_report_luns - Simulate REPORT LUNS command
2170 * @args: device IDENTIFY data / SCSI command of interest.
2171 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2172 * @buflen: Response buffer length.
2174 * Simulate REPORT LUNS command.
2176 * LOCKING:
2177 * spin_lock_irqsave(host lock)
2180 unsigned int ata_scsiop_report_luns(struct ata_scsi_args *args, u8 *rbuf,
2181 unsigned int buflen)
2183 VPRINTK("ENTER\n");
2184 rbuf[3] = 8; /* just one lun, LUN 0, size 8 bytes */
2186 return 0;
2190 * ata_scsi_set_sense - Set SCSI sense data and status
2191 * @cmd: SCSI request to be handled
2192 * @sk: SCSI-defined sense key
2193 * @asc: SCSI-defined additional sense code
2194 * @ascq: SCSI-defined additional sense code qualifier
2196 * Helper function that builds a valid fixed format, current
2197 * response code and the given sense key (sk), additional sense
2198 * code (asc) and additional sense code qualifier (ascq) with
2199 * a SCSI command status of %SAM_STAT_CHECK_CONDITION and
2200 * DRIVER_SENSE set in the upper bits of scsi_cmnd::result .
2202 * LOCKING:
2203 * Not required
2206 void ata_scsi_set_sense(struct scsi_cmnd *cmd, u8 sk, u8 asc, u8 ascq)
2208 cmd->result = (DRIVER_SENSE << 24) | SAM_STAT_CHECK_CONDITION;
2210 cmd->sense_buffer[0] = 0x70; /* fixed format, current */
2211 cmd->sense_buffer[2] = sk;
2212 cmd->sense_buffer[7] = 18 - 8; /* additional sense length */
2213 cmd->sense_buffer[12] = asc;
2214 cmd->sense_buffer[13] = ascq;
2218 * ata_scsi_badcmd - End a SCSI request with an error
2219 * @cmd: SCSI request to be handled
2220 * @done: SCSI command completion function
2221 * @asc: SCSI-defined additional sense code
2222 * @ascq: SCSI-defined additional sense code qualifier
2224 * Helper function that completes a SCSI command with
2225 * %SAM_STAT_CHECK_CONDITION, with a sense key %ILLEGAL_REQUEST
2226 * and the specified additional sense codes.
2228 * LOCKING:
2229 * spin_lock_irqsave(host lock)
2232 void ata_scsi_badcmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *), u8 asc, u8 ascq)
2234 DPRINTK("ENTER\n");
2235 ata_scsi_set_sense(cmd, ILLEGAL_REQUEST, asc, ascq);
2237 done(cmd);
2240 static void atapi_sense_complete(struct ata_queued_cmd *qc)
2242 if (qc->err_mask && ((qc->err_mask & AC_ERR_DEV) == 0)) {
2243 /* FIXME: not quite right; we don't want the
2244 * translation of taskfile registers into
2245 * a sense descriptors, since that's only
2246 * correct for ATA, not ATAPI
2248 ata_gen_passthru_sense(qc);
2251 qc->scsidone(qc->scsicmd);
2252 ata_qc_free(qc);
2255 /* is it pointless to prefer PIO for "safety reasons"? */
2256 static inline int ata_pio_use_silly(struct ata_port *ap)
2258 return (ap->flags & ATA_FLAG_PIO_DMA);
2261 static void atapi_request_sense(struct ata_queued_cmd *qc)
2263 struct ata_port *ap = qc->ap;
2264 struct scsi_cmnd *cmd = qc->scsicmd;
2266 DPRINTK("ATAPI request sense\n");
2268 /* FIXME: is this needed? */
2269 memset(cmd->sense_buffer, 0, sizeof(cmd->sense_buffer));
2271 ap->ops->tf_read(ap, &qc->tf);
2273 /* fill these in, for the case where they are -not- overwritten */
2274 cmd->sense_buffer[0] = 0x70;
2275 cmd->sense_buffer[2] = qc->tf.feature >> 4;
2277 ata_qc_reinit(qc);
2279 ata_sg_init_one(qc, cmd->sense_buffer, sizeof(cmd->sense_buffer));
2280 qc->dma_dir = DMA_FROM_DEVICE;
2282 memset(&qc->cdb, 0, qc->dev->cdb_len);
2283 qc->cdb[0] = REQUEST_SENSE;
2284 qc->cdb[4] = SCSI_SENSE_BUFFERSIZE;
2286 qc->tf.flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
2287 qc->tf.command = ATA_CMD_PACKET;
2289 if (ata_pio_use_silly(ap)) {
2290 qc->tf.protocol = ATA_PROT_ATAPI_DMA;
2291 qc->tf.feature |= ATAPI_PKT_DMA;
2292 } else {
2293 qc->tf.protocol = ATA_PROT_ATAPI;
2294 qc->tf.lbam = (8 * 1024) & 0xff;
2295 qc->tf.lbah = (8 * 1024) >> 8;
2297 qc->nbytes = SCSI_SENSE_BUFFERSIZE;
2299 qc->complete_fn = atapi_sense_complete;
2301 ata_qc_issue(qc);
2303 DPRINTK("EXIT\n");
2306 static void atapi_qc_complete(struct ata_queued_cmd *qc)
2308 struct scsi_cmnd *cmd = qc->scsicmd;
2309 unsigned int err_mask = qc->err_mask;
2311 VPRINTK("ENTER, err_mask 0x%X\n", err_mask);
2313 /* handle completion from new EH */
2314 if (unlikely(qc->ap->ops->error_handler &&
2315 (err_mask || qc->flags & ATA_QCFLAG_SENSE_VALID))) {
2317 if (!(qc->flags & ATA_QCFLAG_SENSE_VALID)) {
2318 /* FIXME: not quite right; we don't want the
2319 * translation of taskfile registers into a
2320 * sense descriptors, since that's only
2321 * correct for ATA, not ATAPI
2323 ata_gen_passthru_sense(qc);
2326 /* SCSI EH automatically locks door if sdev->locked is
2327 * set. Sometimes door lock request continues to
2328 * fail, for example, when no media is present. This
2329 * creates a loop - SCSI EH issues door lock which
2330 * fails and gets invoked again to acquire sense data
2331 * for the failed command.
2333 * If door lock fails, always clear sdev->locked to
2334 * avoid this infinite loop.
2336 if (qc->cdb[0] == ALLOW_MEDIUM_REMOVAL)
2337 qc->dev->sdev->locked = 0;
2339 qc->scsicmd->result = SAM_STAT_CHECK_CONDITION;
2340 qc->scsidone(cmd);
2341 ata_qc_free(qc);
2342 return;
2345 /* successful completion or old EH failure path */
2346 if (unlikely(err_mask & AC_ERR_DEV)) {
2347 cmd->result = SAM_STAT_CHECK_CONDITION;
2348 atapi_request_sense(qc);
2349 return;
2350 } else if (unlikely(err_mask)) {
2351 /* FIXME: not quite right; we don't want the
2352 * translation of taskfile registers into
2353 * a sense descriptors, since that's only
2354 * correct for ATA, not ATAPI
2356 ata_gen_passthru_sense(qc);
2357 } else {
2358 u8 *scsicmd = cmd->cmnd;
2360 if ((scsicmd[0] == INQUIRY) && ((scsicmd[1] & 0x03) == 0)) {
2361 u8 *buf = NULL;
2362 unsigned int buflen;
2364 buflen = ata_scsi_rbuf_get(cmd, &buf);
2366 /* ATAPI devices typically report zero for their SCSI version,
2367 * and sometimes deviate from the spec WRT response data
2368 * format. If SCSI version is reported as zero like normal,
2369 * then we make the following fixups: 1) Fake MMC-5 version,
2370 * to indicate to the Linux scsi midlayer this is a modern
2371 * device. 2) Ensure response data format / ATAPI information
2372 * are always correct.
2374 if (buf[2] == 0) {
2375 buf[2] = 0x5;
2376 buf[3] = 0x32;
2379 ata_scsi_rbuf_put(cmd, buf);
2382 cmd->result = SAM_STAT_GOOD;
2385 qc->scsidone(cmd);
2386 ata_qc_free(qc);
2389 * atapi_xlat - Initialize PACKET taskfile
2390 * @qc: command structure to be initialized
2392 * LOCKING:
2393 * spin_lock_irqsave(host lock)
2395 * RETURNS:
2396 * Zero on success, non-zero on failure.
2398 static unsigned int atapi_xlat(struct ata_queued_cmd *qc)
2400 struct scsi_cmnd *scmd = qc->scsicmd;
2401 struct ata_device *dev = qc->dev;
2402 int using_pio = (dev->flags & ATA_DFLAG_PIO);
2403 int nodata = (scmd->sc_data_direction == DMA_NONE);
2405 if (!using_pio)
2406 /* Check whether ATAPI DMA is safe */
2407 if (ata_check_atapi_dma(qc))
2408 using_pio = 1;
2410 memset(qc->cdb, 0, dev->cdb_len);
2411 memcpy(qc->cdb, scmd->cmnd, scmd->cmd_len);
2413 qc->complete_fn = atapi_qc_complete;
2415 qc->tf.flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
2416 if (scmd->sc_data_direction == DMA_TO_DEVICE) {
2417 qc->tf.flags |= ATA_TFLAG_WRITE;
2418 DPRINTK("direction: write\n");
2421 qc->tf.command = ATA_CMD_PACKET;
2423 /* no data, or PIO data xfer */
2424 if (using_pio || nodata) {
2425 if (nodata)
2426 qc->tf.protocol = ATA_PROT_ATAPI_NODATA;
2427 else
2428 qc->tf.protocol = ATA_PROT_ATAPI;
2429 qc->tf.lbam = (8 * 1024) & 0xff;
2430 qc->tf.lbah = (8 * 1024) >> 8;
2433 /* DMA data xfer */
2434 else {
2435 qc->tf.protocol = ATA_PROT_ATAPI_DMA;
2436 qc->tf.feature |= ATAPI_PKT_DMA;
2438 if (atapi_dmadir && (scmd->sc_data_direction != DMA_TO_DEVICE))
2439 /* some SATA bridges need us to indicate data xfer direction */
2440 qc->tf.feature |= ATAPI_DMADIR;
2443 qc->nbytes = scmd->request_bufflen;
2445 return 0;
2448 static struct ata_device * ata_find_dev(struct ata_port *ap, int id)
2450 if (likely(id < ATA_MAX_DEVICES))
2451 return &ap->device[id];
2452 return NULL;
2455 static struct ata_device * __ata_scsi_find_dev(struct ata_port *ap,
2456 const struct scsi_device *scsidev)
2458 /* skip commands not addressed to targets we simulate */
2459 if (unlikely(scsidev->channel || scsidev->lun))
2460 return NULL;
2462 return ata_find_dev(ap, scsidev->id);
2466 * ata_scsi_dev_enabled - determine if device is enabled
2467 * @dev: ATA device
2469 * Determine if commands should be sent to the specified device.
2471 * LOCKING:
2472 * spin_lock_irqsave(host lock)
2474 * RETURNS:
2475 * 0 if commands are not allowed / 1 if commands are allowed
2478 static int ata_scsi_dev_enabled(struct ata_device *dev)
2480 if (unlikely(!ata_dev_enabled(dev)))
2481 return 0;
2483 if (!atapi_enabled || (dev->ap->flags & ATA_FLAG_NO_ATAPI)) {
2484 if (unlikely(dev->class == ATA_DEV_ATAPI)) {
2485 ata_dev_printk(dev, KERN_WARNING,
2486 "WARNING: ATAPI is %s, device ignored.\n",
2487 atapi_enabled ? "not supported with this driver" : "disabled");
2488 return 0;
2492 return 1;
2496 * ata_scsi_find_dev - lookup ata_device from scsi_cmnd
2497 * @ap: ATA port to which the device is attached
2498 * @scsidev: SCSI device from which we derive the ATA device
2500 * Given various information provided in struct scsi_cmnd,
2501 * map that onto an ATA bus, and using that mapping
2502 * determine which ata_device is associated with the
2503 * SCSI command to be sent.
2505 * LOCKING:
2506 * spin_lock_irqsave(host lock)
2508 * RETURNS:
2509 * Associated ATA device, or %NULL if not found.
2511 static struct ata_device *
2512 ata_scsi_find_dev(struct ata_port *ap, const struct scsi_device *scsidev)
2514 struct ata_device *dev = __ata_scsi_find_dev(ap, scsidev);
2516 if (unlikely(!dev || !ata_scsi_dev_enabled(dev)))
2517 return NULL;
2519 return dev;
2523 * ata_scsi_map_proto - Map pass-thru protocol value to taskfile value.
2524 * @byte1: Byte 1 from pass-thru CDB.
2526 * RETURNS:
2527 * ATA_PROT_UNKNOWN if mapping failed/unimplemented, protocol otherwise.
2529 static u8
2530 ata_scsi_map_proto(u8 byte1)
2532 switch((byte1 & 0x1e) >> 1) {
2533 case 3: /* Non-data */
2534 return ATA_PROT_NODATA;
2536 case 6: /* DMA */
2537 return ATA_PROT_DMA;
2539 case 4: /* PIO Data-in */
2540 case 5: /* PIO Data-out */
2541 return ATA_PROT_PIO;
2543 case 10: /* Device Reset */
2544 case 0: /* Hard Reset */
2545 case 1: /* SRST */
2546 case 2: /* Bus Idle */
2547 case 7: /* Packet */
2548 case 8: /* DMA Queued */
2549 case 9: /* Device Diagnostic */
2550 case 11: /* UDMA Data-in */
2551 case 12: /* UDMA Data-Out */
2552 case 13: /* FPDMA */
2553 default: /* Reserved */
2554 break;
2557 return ATA_PROT_UNKNOWN;
2561 * ata_scsi_pass_thru - convert ATA pass-thru CDB to taskfile
2562 * @qc: command structure to be initialized
2564 * Handles either 12 or 16-byte versions of the CDB.
2566 * RETURNS:
2567 * Zero on success, non-zero on failure.
2569 static unsigned int ata_scsi_pass_thru(struct ata_queued_cmd *qc)
2571 struct ata_taskfile *tf = &(qc->tf);
2572 struct scsi_cmnd *scmd = qc->scsicmd;
2573 struct ata_device *dev = qc->dev;
2574 const u8 *cdb = scmd->cmnd;
2576 if ((tf->protocol = ata_scsi_map_proto(cdb[1])) == ATA_PROT_UNKNOWN)
2577 goto invalid_fld;
2579 /* We may not issue DMA commands if no DMA mode is set */
2580 if (tf->protocol == ATA_PROT_DMA && dev->dma_mode == 0)
2581 goto invalid_fld;
2583 if (cdb[1] & 0xe0)
2584 /* PIO multi not supported yet */
2585 goto invalid_fld;
2588 * 12 and 16 byte CDBs use different offsets to
2589 * provide the various register values.
2591 if (cdb[0] == ATA_16) {
2593 * 16-byte CDB - may contain extended commands.
2595 * If that is the case, copy the upper byte register values.
2597 if (cdb[1] & 0x01) {
2598 tf->hob_feature = cdb[3];
2599 tf->hob_nsect = cdb[5];
2600 tf->hob_lbal = cdb[7];
2601 tf->hob_lbam = cdb[9];
2602 tf->hob_lbah = cdb[11];
2603 tf->flags |= ATA_TFLAG_LBA48;
2604 } else
2605 tf->flags &= ~ATA_TFLAG_LBA48;
2608 * Always copy low byte, device and command registers.
2610 tf->feature = cdb[4];
2611 tf->nsect = cdb[6];
2612 tf->lbal = cdb[8];
2613 tf->lbam = cdb[10];
2614 tf->lbah = cdb[12];
2615 tf->device = cdb[13];
2616 tf->command = cdb[14];
2617 } else {
2619 * 12-byte CDB - incapable of extended commands.
2621 tf->flags &= ~ATA_TFLAG_LBA48;
2623 tf->feature = cdb[3];
2624 tf->nsect = cdb[4];
2625 tf->lbal = cdb[5];
2626 tf->lbam = cdb[6];
2627 tf->lbah = cdb[7];
2628 tf->device = cdb[8];
2629 tf->command = cdb[9];
2632 * If slave is possible, enforce correct master/slave bit
2634 if (qc->ap->flags & ATA_FLAG_SLAVE_POSS)
2635 tf->device = qc->dev->devno ?
2636 tf->device | ATA_DEV1 : tf->device & ~ATA_DEV1;
2639 * Filter SET_FEATURES - XFER MODE command -- otherwise,
2640 * SET_FEATURES - XFER MODE must be preceded/succeeded
2641 * by an update to hardware-specific registers for each
2642 * controller (i.e. the reason for ->set_piomode(),
2643 * ->set_dmamode(), and ->post_set_mode() hooks).
2645 if ((tf->command == ATA_CMD_SET_FEATURES)
2646 && (tf->feature == SETFEATURES_XFER))
2647 goto invalid_fld;
2650 * Set flags so that all registers will be written,
2651 * and pass on write indication (used for PIO/DMA
2652 * setup.)
2654 tf->flags |= (ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE);
2656 if (scmd->sc_data_direction == DMA_TO_DEVICE)
2657 tf->flags |= ATA_TFLAG_WRITE;
2660 * Set transfer length.
2662 * TODO: find out if we need to do more here to
2663 * cover scatter/gather case.
2665 qc->nsect = scmd->request_bufflen / ATA_SECT_SIZE;
2667 /* request result TF */
2668 qc->flags |= ATA_QCFLAG_RESULT_TF;
2670 return 0;
2672 invalid_fld:
2673 ata_scsi_set_sense(scmd, ILLEGAL_REQUEST, 0x24, 0x00);
2674 /* "Invalid field in cdb" */
2675 return 1;
2679 * ata_get_xlat_func - check if SCSI to ATA translation is possible
2680 * @dev: ATA device
2681 * @cmd: SCSI command opcode to consider
2683 * Look up the SCSI command given, and determine whether the
2684 * SCSI command is to be translated or simulated.
2686 * RETURNS:
2687 * Pointer to translation function if possible, %NULL if not.
2690 static inline ata_xlat_func_t ata_get_xlat_func(struct ata_device *dev, u8 cmd)
2692 switch (cmd) {
2693 case READ_6:
2694 case READ_10:
2695 case READ_16:
2697 case WRITE_6:
2698 case WRITE_10:
2699 case WRITE_16:
2700 return ata_scsi_rw_xlat;
2702 case SYNCHRONIZE_CACHE:
2703 if (ata_try_flush_cache(dev))
2704 return ata_scsi_flush_xlat;
2705 break;
2707 case VERIFY:
2708 case VERIFY_16:
2709 return ata_scsi_verify_xlat;
2711 case ATA_12:
2712 case ATA_16:
2713 return ata_scsi_pass_thru;
2715 case START_STOP:
2716 return ata_scsi_start_stop_xlat;
2719 return NULL;
2723 * ata_scsi_dump_cdb - dump SCSI command contents to dmesg
2724 * @ap: ATA port to which the command was being sent
2725 * @cmd: SCSI command to dump
2727 * Prints the contents of a SCSI command via printk().
2730 static inline void ata_scsi_dump_cdb(struct ata_port *ap,
2731 struct scsi_cmnd *cmd)
2733 #ifdef ATA_DEBUG
2734 struct scsi_device *scsidev = cmd->device;
2735 u8 *scsicmd = cmd->cmnd;
2737 DPRINTK("CDB (%u:%d,%d,%d) %02x %02x %02x %02x %02x %02x %02x %02x %02x\n",
2738 ap->id,
2739 scsidev->channel, scsidev->id, scsidev->lun,
2740 scsicmd[0], scsicmd[1], scsicmd[2], scsicmd[3],
2741 scsicmd[4], scsicmd[5], scsicmd[6], scsicmd[7],
2742 scsicmd[8]);
2743 #endif
2746 static inline int __ata_scsi_queuecmd(struct scsi_cmnd *scmd,
2747 void (*done)(struct scsi_cmnd *),
2748 struct ata_device *dev)
2750 int rc = 0;
2752 if (unlikely(!scmd->cmd_len)) {
2753 ata_dev_printk(dev, KERN_WARNING, "WARNING: zero len CDB\n");
2754 scmd->result = DID_ERROR << 16;
2755 done(scmd);
2756 return 0;
2759 if (dev->class == ATA_DEV_ATA) {
2760 ata_xlat_func_t xlat_func = ata_get_xlat_func(dev,
2761 scmd->cmnd[0]);
2763 if (xlat_func)
2764 rc = ata_scsi_translate(dev, scmd, done, xlat_func);
2765 else
2766 ata_scsi_simulate(dev, scmd, done);
2767 } else
2768 rc = ata_scsi_translate(dev, scmd, done, atapi_xlat);
2770 return rc;
2774 * ata_scsi_queuecmd - Issue SCSI cdb to libata-managed device
2775 * @cmd: SCSI command to be sent
2776 * @done: Completion function, called when command is complete
2778 * In some cases, this function translates SCSI commands into
2779 * ATA taskfiles, and queues the taskfiles to be sent to
2780 * hardware. In other cases, this function simulates a
2781 * SCSI device by evaluating and responding to certain
2782 * SCSI commands. This creates the overall effect of
2783 * ATA and ATAPI devices appearing as SCSI devices.
2785 * LOCKING:
2786 * Releases scsi-layer-held lock, and obtains host lock.
2788 * RETURNS:
2789 * Return value from __ata_scsi_queuecmd() if @cmd can be queued,
2790 * 0 otherwise.
2792 int ata_scsi_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *))
2794 struct ata_port *ap;
2795 struct ata_device *dev;
2796 struct scsi_device *scsidev = cmd->device;
2797 struct Scsi_Host *shost = scsidev->host;
2798 int rc = 0;
2800 ap = ata_shost_to_port(shost);
2802 spin_unlock(shost->host_lock);
2803 spin_lock(ap->lock);
2805 ata_scsi_dump_cdb(ap, cmd);
2807 dev = ata_scsi_find_dev(ap, scsidev);
2808 if (likely(dev))
2809 rc = __ata_scsi_queuecmd(cmd, done, dev);
2810 else {
2811 cmd->result = (DID_BAD_TARGET << 16);
2812 done(cmd);
2815 spin_unlock(ap->lock);
2816 spin_lock(shost->host_lock);
2817 return rc;
2821 * ata_scsi_simulate - simulate SCSI command on ATA device
2822 * @dev: the target device
2823 * @cmd: SCSI command being sent to device.
2824 * @done: SCSI command completion function.
2826 * Interprets and directly executes a select list of SCSI commands
2827 * that can be handled internally.
2829 * LOCKING:
2830 * spin_lock_irqsave(host lock)
2833 void ata_scsi_simulate(struct ata_device *dev, struct scsi_cmnd *cmd,
2834 void (*done)(struct scsi_cmnd *))
2836 struct ata_scsi_args args;
2837 const u8 *scsicmd = cmd->cmnd;
2839 args.dev = dev;
2840 args.id = dev->id;
2841 args.cmd = cmd;
2842 args.done = done;
2844 switch(scsicmd[0]) {
2845 /* no-op's, complete with success */
2846 case SYNCHRONIZE_CACHE:
2847 case REZERO_UNIT:
2848 case SEEK_6:
2849 case SEEK_10:
2850 case TEST_UNIT_READY:
2851 case FORMAT_UNIT: /* FIXME: correct? */
2852 case SEND_DIAGNOSTIC: /* FIXME: correct? */
2853 ata_scsi_rbuf_fill(&args, ata_scsiop_noop);
2854 break;
2856 case INQUIRY:
2857 if (scsicmd[1] & 2) /* is CmdDt set? */
2858 ata_scsi_invalid_field(cmd, done);
2859 else if ((scsicmd[1] & 1) == 0) /* is EVPD clear? */
2860 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_std);
2861 else if (scsicmd[2] == 0x00)
2862 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_00);
2863 else if (scsicmd[2] == 0x80)
2864 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_80);
2865 else if (scsicmd[2] == 0x83)
2866 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_83);
2867 else
2868 ata_scsi_invalid_field(cmd, done);
2869 break;
2871 case MODE_SENSE:
2872 case MODE_SENSE_10:
2873 ata_scsi_rbuf_fill(&args, ata_scsiop_mode_sense);
2874 break;
2876 case MODE_SELECT: /* unconditionally return */
2877 case MODE_SELECT_10: /* bad-field-in-cdb */
2878 ata_scsi_invalid_field(cmd, done);
2879 break;
2881 case READ_CAPACITY:
2882 ata_scsi_rbuf_fill(&args, ata_scsiop_read_cap);
2883 break;
2885 case SERVICE_ACTION_IN:
2886 if ((scsicmd[1] & 0x1f) == SAI_READ_CAPACITY_16)
2887 ata_scsi_rbuf_fill(&args, ata_scsiop_read_cap);
2888 else
2889 ata_scsi_invalid_field(cmd, done);
2890 break;
2892 case REPORT_LUNS:
2893 ata_scsi_rbuf_fill(&args, ata_scsiop_report_luns);
2894 break;
2896 /* mandatory commands we haven't implemented yet */
2897 case REQUEST_SENSE:
2899 /* all other commands */
2900 default:
2901 ata_scsi_set_sense(cmd, ILLEGAL_REQUEST, 0x20, 0x0);
2902 /* "Invalid command operation code" */
2903 done(cmd);
2904 break;
2908 void ata_scsi_scan_host(struct ata_port *ap)
2910 unsigned int i;
2912 if (ap->flags & ATA_FLAG_DISABLED)
2913 return;
2915 for (i = 0; i < ATA_MAX_DEVICES; i++) {
2916 struct ata_device *dev = &ap->device[i];
2917 struct scsi_device *sdev;
2919 if (!ata_dev_enabled(dev) || dev->sdev)
2920 continue;
2922 sdev = __scsi_add_device(ap->scsi_host, 0, i, 0, NULL);
2923 if (!IS_ERR(sdev)) {
2924 dev->sdev = sdev;
2925 scsi_device_put(sdev);
2931 * ata_scsi_offline_dev - offline attached SCSI device
2932 * @dev: ATA device to offline attached SCSI device for
2934 * This function is called from ata_eh_hotplug() and responsible
2935 * for taking the SCSI device attached to @dev offline. This
2936 * function is called with host lock which protects dev->sdev
2937 * against clearing.
2939 * LOCKING:
2940 * spin_lock_irqsave(host lock)
2942 * RETURNS:
2943 * 1 if attached SCSI device exists, 0 otherwise.
2945 int ata_scsi_offline_dev(struct ata_device *dev)
2947 if (dev->sdev) {
2948 scsi_device_set_state(dev->sdev, SDEV_OFFLINE);
2949 return 1;
2951 return 0;
2955 * ata_scsi_remove_dev - remove attached SCSI device
2956 * @dev: ATA device to remove attached SCSI device for
2958 * This function is called from ata_eh_scsi_hotplug() and
2959 * responsible for removing the SCSI device attached to @dev.
2961 * LOCKING:
2962 * Kernel thread context (may sleep).
2964 static void ata_scsi_remove_dev(struct ata_device *dev)
2966 struct ata_port *ap = dev->ap;
2967 struct scsi_device *sdev;
2968 unsigned long flags;
2970 /* Alas, we need to grab scan_mutex to ensure SCSI device
2971 * state doesn't change underneath us and thus
2972 * scsi_device_get() always succeeds. The mutex locking can
2973 * be removed if there is __scsi_device_get() interface which
2974 * increments reference counts regardless of device state.
2976 mutex_lock(&ap->scsi_host->scan_mutex);
2977 spin_lock_irqsave(ap->lock, flags);
2979 /* clearing dev->sdev is protected by host lock */
2980 sdev = dev->sdev;
2981 dev->sdev = NULL;
2983 if (sdev) {
2984 /* If user initiated unplug races with us, sdev can go
2985 * away underneath us after the host lock and
2986 * scan_mutex are released. Hold onto it.
2988 if (scsi_device_get(sdev) == 0) {
2989 /* The following ensures the attached sdev is
2990 * offline on return from ata_scsi_offline_dev()
2991 * regardless it wins or loses the race
2992 * against this function.
2994 scsi_device_set_state(sdev, SDEV_OFFLINE);
2995 } else {
2996 WARN_ON(1);
2997 sdev = NULL;
3001 spin_unlock_irqrestore(ap->lock, flags);
3002 mutex_unlock(&ap->scsi_host->scan_mutex);
3004 if (sdev) {
3005 ata_dev_printk(dev, KERN_INFO, "detaching (SCSI %s)\n",
3006 sdev->sdev_gendev.bus_id);
3008 scsi_remove_device(sdev);
3009 scsi_device_put(sdev);
3014 * ata_scsi_hotplug - SCSI part of hotplug
3015 * @work: Pointer to ATA port to perform SCSI hotplug on
3017 * Perform SCSI part of hotplug. It's executed from a separate
3018 * workqueue after EH completes. This is necessary because SCSI
3019 * hot plugging requires working EH and hot unplugging is
3020 * synchronized with hot plugging with a mutex.
3022 * LOCKING:
3023 * Kernel thread context (may sleep).
3025 void ata_scsi_hotplug(struct work_struct *work)
3027 struct ata_port *ap =
3028 container_of(work, struct ata_port, hotplug_task.work);
3029 int i;
3031 if (ap->pflags & ATA_PFLAG_UNLOADING) {
3032 DPRINTK("ENTER/EXIT - unloading\n");
3033 return;
3036 DPRINTK("ENTER\n");
3038 /* unplug detached devices */
3039 for (i = 0; i < ATA_MAX_DEVICES; i++) {
3040 struct ata_device *dev = &ap->device[i];
3041 unsigned long flags;
3043 if (!(dev->flags & ATA_DFLAG_DETACHED))
3044 continue;
3046 spin_lock_irqsave(ap->lock, flags);
3047 dev->flags &= ~ATA_DFLAG_DETACHED;
3048 spin_unlock_irqrestore(ap->lock, flags);
3050 ata_scsi_remove_dev(dev);
3053 /* scan for new ones */
3054 ata_scsi_scan_host(ap);
3056 /* If we scanned while EH was in progress, scan would have
3057 * failed silently. Requeue if there are enabled but
3058 * unattached devices.
3060 for (i = 0; i < ATA_MAX_DEVICES; i++) {
3061 struct ata_device *dev = &ap->device[i];
3062 if (ata_dev_enabled(dev) && !dev->sdev) {
3063 queue_delayed_work(ata_aux_wq, &ap->hotplug_task, HZ);
3064 break;
3068 DPRINTK("EXIT\n");
3072 * ata_scsi_user_scan - indication for user-initiated bus scan
3073 * @shost: SCSI host to scan
3074 * @channel: Channel to scan
3075 * @id: ID to scan
3076 * @lun: LUN to scan
3078 * This function is called when user explicitly requests bus
3079 * scan. Set probe pending flag and invoke EH.
3081 * LOCKING:
3082 * SCSI layer (we don't care)
3084 * RETURNS:
3085 * Zero.
3087 static int ata_scsi_user_scan(struct Scsi_Host *shost, unsigned int channel,
3088 unsigned int id, unsigned int lun)
3090 struct ata_port *ap = ata_shost_to_port(shost);
3091 unsigned long flags;
3092 int rc = 0;
3094 if (!ap->ops->error_handler)
3095 return -EOPNOTSUPP;
3097 if ((channel != SCAN_WILD_CARD && channel != 0) ||
3098 (lun != SCAN_WILD_CARD && lun != 0))
3099 return -EINVAL;
3101 spin_lock_irqsave(ap->lock, flags);
3103 if (id == SCAN_WILD_CARD) {
3104 ap->eh_info.probe_mask |= (1 << ATA_MAX_DEVICES) - 1;
3105 ap->eh_info.action |= ATA_EH_SOFTRESET;
3106 } else {
3107 struct ata_device *dev = ata_find_dev(ap, id);
3109 if (dev) {
3110 ap->eh_info.probe_mask |= 1 << dev->devno;
3111 ap->eh_info.action |= ATA_EH_SOFTRESET;
3112 ap->eh_info.flags |= ATA_EHI_RESUME_LINK;
3113 } else
3114 rc = -EINVAL;
3117 if (rc == 0) {
3118 ata_port_schedule_eh(ap);
3119 spin_unlock_irqrestore(ap->lock, flags);
3120 ata_port_wait_eh(ap);
3121 } else
3122 spin_unlock_irqrestore(ap->lock, flags);
3124 return rc;
3128 * ata_scsi_dev_rescan - initiate scsi_rescan_device()
3129 * @work: Pointer to ATA port to perform scsi_rescan_device()
3131 * After ATA pass thru (SAT) commands are executed successfully,
3132 * libata need to propagate the changes to SCSI layer. This
3133 * function must be executed from ata_aux_wq such that sdev
3134 * attach/detach don't race with rescan.
3136 * LOCKING:
3137 * Kernel thread context (may sleep).
3139 void ata_scsi_dev_rescan(struct work_struct *work)
3141 struct ata_port *ap =
3142 container_of(work, struct ata_port, scsi_rescan_task);
3143 unsigned long flags;
3144 unsigned int i;
3146 spin_lock_irqsave(ap->lock, flags);
3148 for (i = 0; i < ATA_MAX_DEVICES; i++) {
3149 struct ata_device *dev = &ap->device[i];
3150 struct scsi_device *sdev = dev->sdev;
3152 if (!ata_dev_enabled(dev) || !sdev)
3153 continue;
3154 if (scsi_device_get(sdev))
3155 continue;
3157 spin_unlock_irqrestore(ap->lock, flags);
3158 scsi_rescan_device(&(sdev->sdev_gendev));
3159 scsi_device_put(sdev);
3160 spin_lock_irqsave(ap->lock, flags);
3163 spin_unlock_irqrestore(ap->lock, flags);
3167 * ata_sas_port_alloc - Allocate port for a SAS attached SATA device
3168 * @host: ATA host container for all SAS ports
3169 * @port_info: Information from low-level host driver
3170 * @shost: SCSI host that the scsi device is attached to
3172 * LOCKING:
3173 * PCI/etc. bus probe sem.
3175 * RETURNS:
3176 * ata_port pointer on success / NULL on failure.
3179 struct ata_port *ata_sas_port_alloc(struct ata_host *host,
3180 struct ata_port_info *port_info,
3181 struct Scsi_Host *shost)
3183 struct ata_port *ap = kzalloc(sizeof(*ap), GFP_KERNEL);
3184 struct ata_probe_ent *ent;
3186 if (!ap)
3187 return NULL;
3189 ent = ata_probe_ent_alloc(host->dev, port_info);
3190 if (!ent) {
3191 kfree(ap);
3192 return NULL;
3195 ata_port_init(ap, host, ent, 0);
3196 ap->lock = shost->host_lock;
3197 kfree(ent);
3198 return ap;
3200 EXPORT_SYMBOL_GPL(ata_sas_port_alloc);
3203 * ata_sas_port_start - Set port up for dma.
3204 * @ap: Port to initialize
3206 * Called just after data structures for each port are
3207 * initialized. Allocates DMA pad.
3209 * May be used as the port_start() entry in ata_port_operations.
3211 * LOCKING:
3212 * Inherited from caller.
3214 int ata_sas_port_start(struct ata_port *ap)
3216 return ata_pad_alloc(ap, ap->dev);
3218 EXPORT_SYMBOL_GPL(ata_sas_port_start);
3221 * ata_port_stop - Undo ata_sas_port_start()
3222 * @ap: Port to shut down
3224 * Frees the DMA pad.
3226 * May be used as the port_stop() entry in ata_port_operations.
3228 * LOCKING:
3229 * Inherited from caller.
3232 void ata_sas_port_stop(struct ata_port *ap)
3234 ata_pad_free(ap, ap->dev);
3236 EXPORT_SYMBOL_GPL(ata_sas_port_stop);
3239 * ata_sas_port_init - Initialize a SATA device
3240 * @ap: SATA port to initialize
3242 * LOCKING:
3243 * PCI/etc. bus probe sem.
3245 * RETURNS:
3246 * Zero on success, non-zero on error.
3249 int ata_sas_port_init(struct ata_port *ap)
3251 int rc = ap->ops->port_start(ap);
3253 if (!rc)
3254 rc = ata_bus_probe(ap);
3256 return rc;
3258 EXPORT_SYMBOL_GPL(ata_sas_port_init);
3261 * ata_sas_port_destroy - Destroy a SATA port allocated by ata_sas_port_alloc
3262 * @ap: SATA port to destroy
3266 void ata_sas_port_destroy(struct ata_port *ap)
3268 ap->ops->port_stop(ap);
3269 kfree(ap);
3271 EXPORT_SYMBOL_GPL(ata_sas_port_destroy);
3274 * ata_sas_slave_configure - Default slave_config routine for libata devices
3275 * @sdev: SCSI device to configure
3276 * @ap: ATA port to which SCSI device is attached
3278 * RETURNS:
3279 * Zero.
3282 int ata_sas_slave_configure(struct scsi_device *sdev, struct ata_port *ap)
3284 ata_scsi_sdev_config(sdev);
3285 ata_scsi_dev_config(sdev, ap->device);
3286 return 0;
3288 EXPORT_SYMBOL_GPL(ata_sas_slave_configure);
3291 * ata_sas_queuecmd - Issue SCSI cdb to libata-managed device
3292 * @cmd: SCSI command to be sent
3293 * @done: Completion function, called when command is complete
3294 * @ap: ATA port to which the command is being sent
3296 * RETURNS:
3297 * Return value from __ata_scsi_queuecmd() if @cmd can be queued,
3298 * 0 otherwise.
3301 int ata_sas_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *),
3302 struct ata_port *ap)
3304 int rc = 0;
3306 ata_scsi_dump_cdb(ap, cmd);
3308 if (likely(ata_scsi_dev_enabled(ap->device)))
3309 rc = __ata_scsi_queuecmd(cmd, done, ap->device);
3310 else {
3311 cmd->result = (DID_BAD_TARGET << 16);
3312 done(cmd);
3314 return rc;
3316 EXPORT_SYMBOL_GPL(ata_sas_queuecmd);