V4L/DVB (5057): Pvrusb2: Stream configuration cleanups
[linux-2.6/linux-loongson.git] / drivers / ata / libata-scsi.c
blob0009818a4306e7fb5e18c717f81d57256ebda337
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_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[14] = args[0];
338 /* Good values for timeout and retries? Values below
339 from scsi_ioctl_send_command() for default case... */
340 cmd_result = scsi_execute(scsidev, scsi_cmd, DMA_NONE, NULL, 0,
341 sensebuf, (10*HZ), 5, 0);
343 if (driver_byte(cmd_result) == DRIVER_SENSE) {/* sense data available */
344 u8 *desc = sensebuf + 8;
345 cmd_result &= ~(0xFF<<24); /* DRIVER_SENSE is not an error */
347 /* If we set cc then ATA pass-through will cause a
348 * check condition even if no error. Filter that. */
349 if (cmd_result & SAM_STAT_CHECK_CONDITION) {
350 struct scsi_sense_hdr sshdr;
351 scsi_normalize_sense(sensebuf, SCSI_SENSE_BUFFERSIZE,
352 &sshdr);
353 if (sshdr.sense_key==0 &&
354 sshdr.asc==0 && sshdr.ascq==0)
355 cmd_result &= ~SAM_STAT_CHECK_CONDITION;
358 /* Send userspace ATA registers */
359 if (sensebuf[0] == 0x72 && /* format is "descriptor" */
360 desc[0] == 0x09) {/* code is "ATA Descriptor" */
361 args[0] = desc[13]; /* status */
362 args[1] = desc[3]; /* error */
363 args[2] = desc[5]; /* sector count (0:7) */
364 args[3] = desc[7]; /* lbal */
365 args[4] = desc[9]; /* lbam */
366 args[5] = desc[11]; /* lbah */
367 args[6] = desc[12]; /* select */
368 if (copy_to_user(arg, args, sizeof(args)))
369 rc = -EFAULT;
373 if (cmd_result) {
374 rc = -EIO;
375 goto error;
378 error:
379 kfree(sensebuf);
380 return rc;
383 int ata_scsi_ioctl(struct scsi_device *scsidev, int cmd, void __user *arg)
385 int val = -EINVAL, rc = -EINVAL;
387 switch (cmd) {
388 case ATA_IOC_GET_IO32:
389 val = 0;
390 if (copy_to_user(arg, &val, 1))
391 return -EFAULT;
392 return 0;
394 case ATA_IOC_SET_IO32:
395 val = (unsigned long) arg;
396 if (val != 0)
397 return -EINVAL;
398 return 0;
400 case HDIO_GET_IDENTITY:
401 return ata_get_identity(scsidev, arg);
403 case HDIO_DRIVE_CMD:
404 if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
405 return -EACCES;
406 return ata_cmd_ioctl(scsidev, arg);
408 case HDIO_DRIVE_TASK:
409 if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
410 return -EACCES;
411 return ata_task_ioctl(scsidev, arg);
413 default:
414 rc = -ENOTTY;
415 break;
418 return rc;
422 * ata_scsi_qc_new - acquire new ata_queued_cmd reference
423 * @dev: ATA device to which the new command is attached
424 * @cmd: SCSI command that originated this ATA command
425 * @done: SCSI command completion function
427 * Obtain a reference to an unused ata_queued_cmd structure,
428 * which is the basic libata structure representing a single
429 * ATA command sent to the hardware.
431 * If a command was available, fill in the SCSI-specific
432 * portions of the structure with information on the
433 * current command.
435 * LOCKING:
436 * spin_lock_irqsave(host lock)
438 * RETURNS:
439 * Command allocated, or %NULL if none available.
441 static struct ata_queued_cmd *ata_scsi_qc_new(struct ata_device *dev,
442 struct scsi_cmnd *cmd,
443 void (*done)(struct scsi_cmnd *))
445 struct ata_queued_cmd *qc;
447 qc = ata_qc_new_init(dev);
448 if (qc) {
449 qc->scsicmd = cmd;
450 qc->scsidone = done;
452 if (cmd->use_sg) {
453 qc->__sg = (struct scatterlist *) cmd->request_buffer;
454 qc->n_elem = cmd->use_sg;
455 } else if (cmd->request_bufflen) {
456 qc->__sg = &qc->sgent;
457 qc->n_elem = 1;
459 } else {
460 cmd->result = (DID_OK << 16) | (QUEUE_FULL << 1);
461 done(cmd);
464 return qc;
468 * ata_dump_status - user friendly display of error info
469 * @id: id of the port in question
470 * @tf: ptr to filled out taskfile
472 * Decode and dump the ATA error/status registers for the user so
473 * that they have some idea what really happened at the non
474 * make-believe layer.
476 * LOCKING:
477 * inherited from caller
479 static void ata_dump_status(unsigned id, struct ata_taskfile *tf)
481 u8 stat = tf->command, err = tf->feature;
483 printk(KERN_WARNING "ata%u: status=0x%02x { ", id, stat);
484 if (stat & ATA_BUSY) {
485 printk("Busy }\n"); /* Data is not valid in this case */
486 } else {
487 if (stat & 0x40) printk("DriveReady ");
488 if (stat & 0x20) printk("DeviceFault ");
489 if (stat & 0x10) printk("SeekComplete ");
490 if (stat & 0x08) printk("DataRequest ");
491 if (stat & 0x04) printk("CorrectedError ");
492 if (stat & 0x02) printk("Index ");
493 if (stat & 0x01) printk("Error ");
494 printk("}\n");
496 if (err) {
497 printk(KERN_WARNING "ata%u: error=0x%02x { ", id, err);
498 if (err & 0x04) printk("DriveStatusError ");
499 if (err & 0x80) {
500 if (err & 0x04) printk("BadCRC ");
501 else printk("Sector ");
503 if (err & 0x40) printk("UncorrectableError ");
504 if (err & 0x10) printk("SectorIdNotFound ");
505 if (err & 0x02) printk("TrackZeroNotFound ");
506 if (err & 0x01) printk("AddrMarkNotFound ");
507 printk("}\n");
513 * ata_scsi_device_suspend - suspend ATA device associated with sdev
514 * @sdev: the SCSI device to suspend
515 * @mesg: target power management message
517 * Request suspend EH action on the ATA device associated with
518 * @sdev and wait for the operation to complete.
520 * LOCKING:
521 * Kernel thread context (may sleep).
523 * RETURNS:
524 * 0 on success, -errno otherwise.
526 int ata_scsi_device_suspend(struct scsi_device *sdev, pm_message_t mesg)
528 struct ata_port *ap = ata_shost_to_port(sdev->host);
529 struct ata_device *dev = ata_scsi_find_dev(ap, sdev);
530 unsigned long flags;
531 unsigned int action;
532 int rc = 0;
534 if (!dev)
535 goto out;
537 spin_lock_irqsave(ap->lock, flags);
539 /* wait for the previous resume to complete */
540 while (dev->flags & ATA_DFLAG_SUSPENDED) {
541 spin_unlock_irqrestore(ap->lock, flags);
542 ata_port_wait_eh(ap);
543 spin_lock_irqsave(ap->lock, flags);
546 /* if @sdev is already detached, nothing to do */
547 if (sdev->sdev_state == SDEV_OFFLINE ||
548 sdev->sdev_state == SDEV_CANCEL || sdev->sdev_state == SDEV_DEL)
549 goto out_unlock;
551 /* request suspend */
552 action = ATA_EH_SUSPEND;
553 if (mesg.event != PM_EVENT_SUSPEND)
554 action |= ATA_EH_PM_FREEZE;
555 ap->eh_info.dev_action[dev->devno] |= action;
556 ap->eh_info.flags |= ATA_EHI_QUIET;
557 ata_port_schedule_eh(ap);
559 spin_unlock_irqrestore(ap->lock, flags);
561 /* wait for EH to do the job */
562 ata_port_wait_eh(ap);
564 spin_lock_irqsave(ap->lock, flags);
566 /* If @sdev is still attached but the associated ATA device
567 * isn't suspended, the operation failed.
569 if (sdev->sdev_state != SDEV_OFFLINE &&
570 sdev->sdev_state != SDEV_CANCEL && sdev->sdev_state != SDEV_DEL &&
571 !(dev->flags & ATA_DFLAG_SUSPENDED))
572 rc = -EIO;
574 out_unlock:
575 spin_unlock_irqrestore(ap->lock, flags);
576 out:
577 if (rc == 0)
578 sdev->sdev_gendev.power.power_state = mesg;
579 return rc;
583 * ata_scsi_device_resume - resume ATA device associated with sdev
584 * @sdev: the SCSI device to resume
586 * Request resume EH action on the ATA device associated with
587 * @sdev and return immediately. This enables parallel
588 * wakeup/spinup of devices.
590 * LOCKING:
591 * Kernel thread context (may sleep).
593 * RETURNS:
594 * 0.
596 int ata_scsi_device_resume(struct scsi_device *sdev)
598 struct ata_port *ap = ata_shost_to_port(sdev->host);
599 struct ata_device *dev = ata_scsi_find_dev(ap, sdev);
600 struct ata_eh_info *ehi = &ap->eh_info;
601 unsigned long flags;
602 unsigned int action;
604 if (!dev)
605 goto out;
607 spin_lock_irqsave(ap->lock, flags);
609 /* if @sdev is already detached, nothing to do */
610 if (sdev->sdev_state == SDEV_OFFLINE ||
611 sdev->sdev_state == SDEV_CANCEL || sdev->sdev_state == SDEV_DEL)
612 goto out_unlock;
614 /* request resume */
615 action = ATA_EH_RESUME;
616 if (sdev->sdev_gendev.power.power_state.event == PM_EVENT_SUSPEND)
617 __ata_ehi_hotplugged(ehi);
618 else
619 action |= ATA_EH_PM_FREEZE | ATA_EH_SOFTRESET;
620 ehi->dev_action[dev->devno] |= action;
622 /* We don't want autopsy and verbose EH messages. Disable
623 * those if we're the only device on this link.
625 if (ata_port_max_devices(ap) == 1)
626 ehi->flags |= ATA_EHI_NO_AUTOPSY | ATA_EHI_QUIET;
628 ata_port_schedule_eh(ap);
630 out_unlock:
631 spin_unlock_irqrestore(ap->lock, flags);
632 out:
633 sdev->sdev_gendev.power.power_state = PMSG_ON;
634 return 0;
638 * ata_to_sense_error - convert ATA error to SCSI error
639 * @id: ATA device number
640 * @drv_stat: value contained in ATA status register
641 * @drv_err: value contained in ATA error register
642 * @sk: the sense key we'll fill out
643 * @asc: the additional sense code we'll fill out
644 * @ascq: the additional sense code qualifier we'll fill out
645 * @verbose: be verbose
647 * Converts an ATA error into a SCSI error. Fill out pointers to
648 * SK, ASC, and ASCQ bytes for later use in fixed or descriptor
649 * format sense blocks.
651 * LOCKING:
652 * spin_lock_irqsave(host lock)
654 static void ata_to_sense_error(unsigned id, u8 drv_stat, u8 drv_err, u8 *sk,
655 u8 *asc, u8 *ascq, int verbose)
657 int i;
659 /* Based on the 3ware driver translation table */
660 static const unsigned char sense_table[][4] = {
661 /* BBD|ECC|ID|MAR */
662 {0xd1, ABORTED_COMMAND, 0x00, 0x00}, // Device busy Aborted command
663 /* BBD|ECC|ID */
664 {0xd0, ABORTED_COMMAND, 0x00, 0x00}, // Device busy Aborted command
665 /* ECC|MC|MARK */
666 {0x61, HARDWARE_ERROR, 0x00, 0x00}, // Device fault Hardware error
667 /* ICRC|ABRT */ /* NB: ICRC & !ABRT is BBD */
668 {0x84, ABORTED_COMMAND, 0x47, 0x00}, // Data CRC error SCSI parity error
669 /* MC|ID|ABRT|TRK0|MARK */
670 {0x37, NOT_READY, 0x04, 0x00}, // Unit offline Not ready
671 /* MCR|MARK */
672 {0x09, NOT_READY, 0x04, 0x00}, // Unrecovered disk error Not ready
673 /* Bad address mark */
674 {0x01, MEDIUM_ERROR, 0x13, 0x00}, // Address mark not found Address mark not found for data field
675 /* TRK0 */
676 {0x02, HARDWARE_ERROR, 0x00, 0x00}, // Track 0 not found Hardware error
677 /* Abort & !ICRC */
678 {0x04, ABORTED_COMMAND, 0x00, 0x00}, // Aborted command Aborted command
679 /* Media change request */
680 {0x08, NOT_READY, 0x04, 0x00}, // Media change request FIXME: faking offline
681 /* SRV */
682 {0x10, ABORTED_COMMAND, 0x14, 0x00}, // ID not found Recorded entity not found
683 /* Media change */
684 {0x08, NOT_READY, 0x04, 0x00}, // Media change FIXME: faking offline
685 /* ECC */
686 {0x40, MEDIUM_ERROR, 0x11, 0x04}, // Uncorrectable ECC error Unrecovered read error
687 /* BBD - block marked bad */
688 {0x80, MEDIUM_ERROR, 0x11, 0x04}, // Block marked bad Medium error, unrecovered read error
689 {0xFF, 0xFF, 0xFF, 0xFF}, // END mark
691 static const unsigned char stat_table[][4] = {
692 /* Must be first because BUSY means no other bits valid */
693 {0x80, ABORTED_COMMAND, 0x47, 0x00}, // Busy, fake parity for now
694 {0x20, HARDWARE_ERROR, 0x00, 0x00}, // Device fault
695 {0x08, ABORTED_COMMAND, 0x47, 0x00}, // Timed out in xfer, fake parity for now
696 {0x04, RECOVERED_ERROR, 0x11, 0x00}, // Recovered ECC error Medium error, recovered
697 {0xFF, 0xFF, 0xFF, 0xFF}, // END mark
701 * Is this an error we can process/parse
703 if (drv_stat & ATA_BUSY) {
704 drv_err = 0; /* Ignore the err bits, they're invalid */
707 if (drv_err) {
708 /* Look for drv_err */
709 for (i = 0; sense_table[i][0] != 0xFF; i++) {
710 /* Look for best matches first */
711 if ((sense_table[i][0] & drv_err) ==
712 sense_table[i][0]) {
713 *sk = sense_table[i][1];
714 *asc = sense_table[i][2];
715 *ascq = sense_table[i][3];
716 goto translate_done;
719 /* No immediate match */
720 if (verbose)
721 printk(KERN_WARNING "ata%u: no sense translation for "
722 "error 0x%02x\n", id, drv_err);
725 /* Fall back to interpreting status bits */
726 for (i = 0; stat_table[i][0] != 0xFF; i++) {
727 if (stat_table[i][0] & drv_stat) {
728 *sk = stat_table[i][1];
729 *asc = stat_table[i][2];
730 *ascq = stat_table[i][3];
731 goto translate_done;
734 /* No error? Undecoded? */
735 if (verbose)
736 printk(KERN_WARNING "ata%u: no sense translation for "
737 "status: 0x%02x\n", id, drv_stat);
739 /* We need a sensible error return here, which is tricky, and one
740 that won't cause people to do things like return a disk wrongly */
741 *sk = ABORTED_COMMAND;
742 *asc = 0x00;
743 *ascq = 0x00;
745 translate_done:
746 if (verbose)
747 printk(KERN_ERR "ata%u: translated ATA stat/err 0x%02x/%02x "
748 "to SCSI SK/ASC/ASCQ 0x%x/%02x/%02x\n",
749 id, drv_stat, drv_err, *sk, *asc, *ascq);
750 return;
754 * ata_gen_passthru_sense - Generate check condition sense block.
755 * @qc: Command that completed.
757 * This function is specific to the ATA descriptor format sense
758 * block specified for the ATA pass through commands. Regardless
759 * of whether the command errored or not, return a sense
760 * block. Copy all controller registers into the sense
761 * block. Clear sense key, ASC & ASCQ if there is no error.
763 * LOCKING:
764 * None.
766 static void ata_gen_passthru_sense(struct ata_queued_cmd *qc)
768 struct scsi_cmnd *cmd = qc->scsicmd;
769 struct ata_taskfile *tf = &qc->result_tf;
770 unsigned char *sb = cmd->sense_buffer;
771 unsigned char *desc = sb + 8;
772 int verbose = qc->ap->ops->error_handler == NULL;
774 memset(sb, 0, SCSI_SENSE_BUFFERSIZE);
776 cmd->result = (DRIVER_SENSE << 24) | SAM_STAT_CHECK_CONDITION;
779 * Use ata_to_sense_error() to map status register bits
780 * onto sense key, asc & ascq.
782 if (qc->err_mask ||
783 tf->command & (ATA_BUSY | ATA_DF | ATA_ERR | ATA_DRQ)) {
784 ata_to_sense_error(qc->ap->id, tf->command, tf->feature,
785 &sb[1], &sb[2], &sb[3], verbose);
786 sb[1] &= 0x0f;
790 * Sense data is current and format is descriptor.
792 sb[0] = 0x72;
794 desc[0] = 0x09;
796 /* set length of additional sense data */
797 sb[7] = 14;
798 desc[1] = 12;
801 * Copy registers into sense buffer.
803 desc[2] = 0x00;
804 desc[3] = tf->feature; /* == error reg */
805 desc[5] = tf->nsect;
806 desc[7] = tf->lbal;
807 desc[9] = tf->lbam;
808 desc[11] = tf->lbah;
809 desc[12] = tf->device;
810 desc[13] = tf->command; /* == status reg */
813 * Fill in Extend bit, and the high order bytes
814 * if applicable.
816 if (tf->flags & ATA_TFLAG_LBA48) {
817 desc[2] |= 0x01;
818 desc[4] = tf->hob_nsect;
819 desc[6] = tf->hob_lbal;
820 desc[8] = tf->hob_lbam;
821 desc[10] = tf->hob_lbah;
826 * ata_gen_ata_sense - generate a SCSI fixed sense block
827 * @qc: Command that we are erroring out
829 * Generate sense block for a failed ATA command @qc. Descriptor
830 * format is used to accomodate LBA48 block address.
832 * LOCKING:
833 * None.
835 static void ata_gen_ata_sense(struct ata_queued_cmd *qc)
837 struct ata_device *dev = qc->dev;
838 struct scsi_cmnd *cmd = qc->scsicmd;
839 struct ata_taskfile *tf = &qc->result_tf;
840 unsigned char *sb = cmd->sense_buffer;
841 unsigned char *desc = sb + 8;
842 int verbose = qc->ap->ops->error_handler == NULL;
843 u64 block;
845 memset(sb, 0, SCSI_SENSE_BUFFERSIZE);
847 cmd->result = (DRIVER_SENSE << 24) | SAM_STAT_CHECK_CONDITION;
849 /* sense data is current and format is descriptor */
850 sb[0] = 0x72;
852 /* Use ata_to_sense_error() to map status register bits
853 * onto sense key, asc & ascq.
855 if (qc->err_mask ||
856 tf->command & (ATA_BUSY | ATA_DF | ATA_ERR | ATA_DRQ)) {
857 ata_to_sense_error(qc->ap->id, tf->command, tf->feature,
858 &sb[1], &sb[2], &sb[3], verbose);
859 sb[1] &= 0x0f;
862 block = ata_tf_read_block(&qc->result_tf, dev);
864 /* information sense data descriptor */
865 sb[7] = 12;
866 desc[0] = 0x00;
867 desc[1] = 10;
869 desc[2] |= 0x80; /* valid */
870 desc[6] = block >> 40;
871 desc[7] = block >> 32;
872 desc[8] = block >> 24;
873 desc[9] = block >> 16;
874 desc[10] = block >> 8;
875 desc[11] = block;
878 static void ata_scsi_sdev_config(struct scsi_device *sdev)
880 sdev->use_10_for_rw = 1;
881 sdev->use_10_for_ms = 1;
884 static void ata_scsi_dev_config(struct scsi_device *sdev,
885 struct ata_device *dev)
887 /* configure max sectors */
888 blk_queue_max_sectors(sdev->request_queue, dev->max_sectors);
890 /* SATA DMA transfers must be multiples of 4 byte, so
891 * we need to pad ATAPI transfers using an extra sg.
892 * Decrement max hw segments accordingly.
894 if (dev->class == ATA_DEV_ATAPI) {
895 request_queue_t *q = sdev->request_queue;
896 blk_queue_max_hw_segments(q, q->max_hw_segments - 1);
899 if (dev->flags & ATA_DFLAG_NCQ) {
900 int depth;
902 depth = min(sdev->host->can_queue, ata_id_queue_depth(dev->id));
903 depth = min(ATA_MAX_QUEUE - 1, depth);
904 scsi_adjust_queue_depth(sdev, MSG_SIMPLE_TAG, depth);
909 * ata_scsi_slave_config - Set SCSI device attributes
910 * @sdev: SCSI device to examine
912 * This is called before we actually start reading
913 * and writing to the device, to configure certain
914 * SCSI mid-layer behaviors.
916 * LOCKING:
917 * Defined by SCSI layer. We don't really care.
920 int ata_scsi_slave_config(struct scsi_device *sdev)
922 struct ata_port *ap = ata_shost_to_port(sdev->host);
923 struct ata_device *dev = __ata_scsi_find_dev(ap, sdev);
925 ata_scsi_sdev_config(sdev);
927 blk_queue_max_phys_segments(sdev->request_queue, LIBATA_MAX_PRD);
929 if (dev)
930 ata_scsi_dev_config(sdev, dev);
932 return 0; /* scsi layer doesn't check return value, sigh */
936 * ata_scsi_slave_destroy - SCSI device is about to be destroyed
937 * @sdev: SCSI device to be destroyed
939 * @sdev is about to be destroyed for hot/warm unplugging. If
940 * this unplugging was initiated by libata as indicated by NULL
941 * dev->sdev, this function doesn't have to do anything.
942 * Otherwise, SCSI layer initiated warm-unplug is in progress.
943 * Clear dev->sdev, schedule the device for ATA detach and invoke
944 * EH.
946 * LOCKING:
947 * Defined by SCSI layer. We don't really care.
949 void ata_scsi_slave_destroy(struct scsi_device *sdev)
951 struct ata_port *ap = ata_shost_to_port(sdev->host);
952 unsigned long flags;
953 struct ata_device *dev;
955 if (!ap->ops->error_handler)
956 return;
958 spin_lock_irqsave(ap->lock, flags);
959 dev = __ata_scsi_find_dev(ap, sdev);
960 if (dev && dev->sdev) {
961 /* SCSI device already in CANCEL state, no need to offline it */
962 dev->sdev = NULL;
963 dev->flags |= ATA_DFLAG_DETACH;
964 ata_port_schedule_eh(ap);
966 spin_unlock_irqrestore(ap->lock, flags);
970 * ata_scsi_change_queue_depth - SCSI callback for queue depth config
971 * @sdev: SCSI device to configure queue depth for
972 * @queue_depth: new queue depth
974 * This is libata standard hostt->change_queue_depth callback.
975 * SCSI will call into this callback when user tries to set queue
976 * depth via sysfs.
978 * LOCKING:
979 * SCSI layer (we don't care)
981 * RETURNS:
982 * Newly configured queue depth.
984 int ata_scsi_change_queue_depth(struct scsi_device *sdev, int queue_depth)
986 struct ata_port *ap = ata_shost_to_port(sdev->host);
987 struct ata_device *dev;
988 unsigned long flags;
989 int max_depth;
991 if (queue_depth < 1)
992 return sdev->queue_depth;
994 dev = ata_scsi_find_dev(ap, sdev);
995 if (!dev || !ata_dev_enabled(dev))
996 return sdev->queue_depth;
998 max_depth = min(sdev->host->can_queue, ata_id_queue_depth(dev->id));
999 max_depth = min(ATA_MAX_QUEUE - 1, max_depth);
1000 if (queue_depth > max_depth)
1001 queue_depth = max_depth;
1003 scsi_adjust_queue_depth(sdev, MSG_SIMPLE_TAG, queue_depth);
1005 spin_lock_irqsave(ap->lock, flags);
1006 if (queue_depth > 1)
1007 dev->flags &= ~ATA_DFLAG_NCQ_OFF;
1008 else
1009 dev->flags |= ATA_DFLAG_NCQ_OFF;
1010 spin_unlock_irqrestore(ap->lock, flags);
1012 return queue_depth;
1016 * ata_scsi_start_stop_xlat - Translate SCSI START STOP UNIT command
1017 * @qc: Storage for translated ATA taskfile
1019 * Sets up an ATA taskfile to issue STANDBY (to stop) or READ VERIFY
1020 * (to start). Perhaps these commands should be preceded by
1021 * CHECK POWER MODE to see what power mode the device is already in.
1022 * [See SAT revision 5 at www.t10.org]
1024 * LOCKING:
1025 * spin_lock_irqsave(host lock)
1027 * RETURNS:
1028 * Zero on success, non-zero on error.
1030 static unsigned int ata_scsi_start_stop_xlat(struct ata_queued_cmd *qc)
1032 struct scsi_cmnd *scmd = qc->scsicmd;
1033 struct ata_taskfile *tf = &qc->tf;
1034 const u8 *cdb = scmd->cmnd;
1036 if (scmd->cmd_len < 5)
1037 goto invalid_fld;
1039 tf->flags |= ATA_TFLAG_DEVICE | ATA_TFLAG_ISADDR;
1040 tf->protocol = ATA_PROT_NODATA;
1041 if (cdb[1] & 0x1) {
1042 ; /* ignore IMMED bit, violates sat-r05 */
1044 if (cdb[4] & 0x2)
1045 goto invalid_fld; /* LOEJ bit set not supported */
1046 if (((cdb[4] >> 4) & 0xf) != 0)
1047 goto invalid_fld; /* power conditions not supported */
1048 if (cdb[4] & 0x1) {
1049 tf->nsect = 1; /* 1 sector, lba=0 */
1051 if (qc->dev->flags & ATA_DFLAG_LBA) {
1052 tf->flags |= ATA_TFLAG_LBA;
1054 tf->lbah = 0x0;
1055 tf->lbam = 0x0;
1056 tf->lbal = 0x0;
1057 tf->device |= ATA_LBA;
1058 } else {
1059 /* CHS */
1060 tf->lbal = 0x1; /* sect */
1061 tf->lbam = 0x0; /* cyl low */
1062 tf->lbah = 0x0; /* cyl high */
1065 tf->command = ATA_CMD_VERIFY; /* READ VERIFY */
1066 } else
1067 /* Issue ATA STANDBY IMMEDIATE command */
1068 tf->command = ATA_CMD_STANDBYNOW1;
1071 * Standby and Idle condition timers could be implemented but that
1072 * would require libata to implement the Power condition mode page
1073 * and allow the user to change it. Changing mode pages requires
1074 * MODE SELECT to be implemented.
1077 return 0;
1079 invalid_fld:
1080 ata_scsi_set_sense(scmd, ILLEGAL_REQUEST, 0x24, 0x0);
1081 /* "Invalid field in cbd" */
1082 return 1;
1087 * ata_scsi_flush_xlat - Translate SCSI SYNCHRONIZE CACHE command
1088 * @qc: Storage for translated ATA taskfile
1090 * Sets up an ATA taskfile to issue FLUSH CACHE or
1091 * FLUSH CACHE EXT.
1093 * LOCKING:
1094 * spin_lock_irqsave(host lock)
1096 * RETURNS:
1097 * Zero on success, non-zero on error.
1099 static unsigned int ata_scsi_flush_xlat(struct ata_queued_cmd *qc)
1101 struct ata_taskfile *tf = &qc->tf;
1103 tf->flags |= ATA_TFLAG_DEVICE;
1104 tf->protocol = ATA_PROT_NODATA;
1106 if (qc->dev->flags & ATA_DFLAG_FLUSH_EXT)
1107 tf->command = ATA_CMD_FLUSH_EXT;
1108 else
1109 tf->command = ATA_CMD_FLUSH;
1111 return 0;
1115 * scsi_6_lba_len - Get LBA and transfer length
1116 * @cdb: SCSI command to translate
1118 * Calculate LBA and transfer length for 6-byte commands.
1120 * RETURNS:
1121 * @plba: the LBA
1122 * @plen: the transfer length
1124 static void scsi_6_lba_len(const u8 *cdb, u64 *plba, u32 *plen)
1126 u64 lba = 0;
1127 u32 len = 0;
1129 VPRINTK("six-byte command\n");
1131 lba |= ((u64)cdb[2]) << 8;
1132 lba |= ((u64)cdb[3]);
1134 len |= ((u32)cdb[4]);
1136 *plba = lba;
1137 *plen = len;
1141 * scsi_10_lba_len - Get LBA and transfer length
1142 * @cdb: SCSI command to translate
1144 * Calculate LBA and transfer length for 10-byte commands.
1146 * RETURNS:
1147 * @plba: the LBA
1148 * @plen: the transfer length
1150 static void scsi_10_lba_len(const u8 *cdb, u64 *plba, u32 *plen)
1152 u64 lba = 0;
1153 u32 len = 0;
1155 VPRINTK("ten-byte command\n");
1157 lba |= ((u64)cdb[2]) << 24;
1158 lba |= ((u64)cdb[3]) << 16;
1159 lba |= ((u64)cdb[4]) << 8;
1160 lba |= ((u64)cdb[5]);
1162 len |= ((u32)cdb[7]) << 8;
1163 len |= ((u32)cdb[8]);
1165 *plba = lba;
1166 *plen = len;
1170 * scsi_16_lba_len - Get LBA and transfer length
1171 * @cdb: SCSI command to translate
1173 * Calculate LBA and transfer length for 16-byte commands.
1175 * RETURNS:
1176 * @plba: the LBA
1177 * @plen: the transfer length
1179 static void scsi_16_lba_len(const u8 *cdb, u64 *plba, u32 *plen)
1181 u64 lba = 0;
1182 u32 len = 0;
1184 VPRINTK("sixteen-byte command\n");
1186 lba |= ((u64)cdb[2]) << 56;
1187 lba |= ((u64)cdb[3]) << 48;
1188 lba |= ((u64)cdb[4]) << 40;
1189 lba |= ((u64)cdb[5]) << 32;
1190 lba |= ((u64)cdb[6]) << 24;
1191 lba |= ((u64)cdb[7]) << 16;
1192 lba |= ((u64)cdb[8]) << 8;
1193 lba |= ((u64)cdb[9]);
1195 len |= ((u32)cdb[10]) << 24;
1196 len |= ((u32)cdb[11]) << 16;
1197 len |= ((u32)cdb[12]) << 8;
1198 len |= ((u32)cdb[13]);
1200 *plba = lba;
1201 *plen = len;
1205 * ata_scsi_verify_xlat - Translate SCSI VERIFY command into an ATA one
1206 * @qc: Storage for translated ATA taskfile
1208 * Converts SCSI VERIFY command to an ATA READ VERIFY command.
1210 * LOCKING:
1211 * spin_lock_irqsave(host lock)
1213 * RETURNS:
1214 * Zero on success, non-zero on error.
1216 static unsigned int ata_scsi_verify_xlat(struct ata_queued_cmd *qc)
1218 struct scsi_cmnd *scmd = qc->scsicmd;
1219 struct ata_taskfile *tf = &qc->tf;
1220 struct ata_device *dev = qc->dev;
1221 u64 dev_sectors = qc->dev->n_sectors;
1222 const u8 *cdb = scmd->cmnd;
1223 u64 block;
1224 u32 n_block;
1226 tf->flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
1227 tf->protocol = ATA_PROT_NODATA;
1229 if (cdb[0] == VERIFY) {
1230 if (scmd->cmd_len < 10)
1231 goto invalid_fld;
1232 scsi_10_lba_len(cdb, &block, &n_block);
1233 } else if (cdb[0] == VERIFY_16) {
1234 if (scmd->cmd_len < 16)
1235 goto invalid_fld;
1236 scsi_16_lba_len(cdb, &block, &n_block);
1237 } else
1238 goto invalid_fld;
1240 if (!n_block)
1241 goto nothing_to_do;
1242 if (block >= dev_sectors)
1243 goto out_of_range;
1244 if ((block + n_block) > dev_sectors)
1245 goto out_of_range;
1247 if (dev->flags & ATA_DFLAG_LBA) {
1248 tf->flags |= ATA_TFLAG_LBA;
1250 if (lba_28_ok(block, n_block)) {
1251 /* use LBA28 */
1252 tf->command = ATA_CMD_VERIFY;
1253 tf->device |= (block >> 24) & 0xf;
1254 } else if (lba_48_ok(block, n_block)) {
1255 if (!(dev->flags & ATA_DFLAG_LBA48))
1256 goto out_of_range;
1258 /* use LBA48 */
1259 tf->flags |= ATA_TFLAG_LBA48;
1260 tf->command = ATA_CMD_VERIFY_EXT;
1262 tf->hob_nsect = (n_block >> 8) & 0xff;
1264 tf->hob_lbah = (block >> 40) & 0xff;
1265 tf->hob_lbam = (block >> 32) & 0xff;
1266 tf->hob_lbal = (block >> 24) & 0xff;
1267 } else
1268 /* request too large even for LBA48 */
1269 goto out_of_range;
1271 tf->nsect = n_block & 0xff;
1273 tf->lbah = (block >> 16) & 0xff;
1274 tf->lbam = (block >> 8) & 0xff;
1275 tf->lbal = block & 0xff;
1277 tf->device |= ATA_LBA;
1278 } else {
1279 /* CHS */
1280 u32 sect, head, cyl, track;
1282 if (!lba_28_ok(block, n_block))
1283 goto out_of_range;
1285 /* Convert LBA to CHS */
1286 track = (u32)block / dev->sectors;
1287 cyl = track / dev->heads;
1288 head = track % dev->heads;
1289 sect = (u32)block % dev->sectors + 1;
1291 DPRINTK("block %u track %u cyl %u head %u sect %u\n",
1292 (u32)block, track, cyl, head, sect);
1294 /* Check whether the converted CHS can fit.
1295 Cylinder: 0-65535
1296 Head: 0-15
1297 Sector: 1-255*/
1298 if ((cyl >> 16) || (head >> 4) || (sect >> 8) || (!sect))
1299 goto out_of_range;
1301 tf->command = ATA_CMD_VERIFY;
1302 tf->nsect = n_block & 0xff; /* Sector count 0 means 256 sectors */
1303 tf->lbal = sect;
1304 tf->lbam = cyl;
1305 tf->lbah = cyl >> 8;
1306 tf->device |= head;
1309 return 0;
1311 invalid_fld:
1312 ata_scsi_set_sense(scmd, ILLEGAL_REQUEST, 0x24, 0x0);
1313 /* "Invalid field in cbd" */
1314 return 1;
1316 out_of_range:
1317 ata_scsi_set_sense(scmd, ILLEGAL_REQUEST, 0x21, 0x0);
1318 /* "Logical Block Address out of range" */
1319 return 1;
1321 nothing_to_do:
1322 scmd->result = SAM_STAT_GOOD;
1323 return 1;
1327 * ata_scsi_rw_xlat - Translate SCSI r/w command into an ATA one
1328 * @qc: Storage for translated ATA taskfile
1330 * Converts any of six SCSI read/write commands into the
1331 * ATA counterpart, including starting sector (LBA),
1332 * sector count, and taking into account the device's LBA48
1333 * support.
1335 * Commands %READ_6, %READ_10, %READ_16, %WRITE_6, %WRITE_10, and
1336 * %WRITE_16 are currently supported.
1338 * LOCKING:
1339 * spin_lock_irqsave(host lock)
1341 * RETURNS:
1342 * Zero on success, non-zero on error.
1344 static unsigned int ata_scsi_rw_xlat(struct ata_queued_cmd *qc)
1346 struct scsi_cmnd *scmd = qc->scsicmd;
1347 const u8 *cdb = scmd->cmnd;
1348 unsigned int tf_flags = 0;
1349 u64 block;
1350 u32 n_block;
1351 int rc;
1353 if (cdb[0] == WRITE_10 || cdb[0] == WRITE_6 || cdb[0] == WRITE_16)
1354 tf_flags |= ATA_TFLAG_WRITE;
1356 /* Calculate the SCSI LBA, transfer length and FUA. */
1357 switch (cdb[0]) {
1358 case READ_10:
1359 case WRITE_10:
1360 if (unlikely(scmd->cmd_len < 10))
1361 goto invalid_fld;
1362 scsi_10_lba_len(cdb, &block, &n_block);
1363 if (unlikely(cdb[1] & (1 << 3)))
1364 tf_flags |= ATA_TFLAG_FUA;
1365 break;
1366 case READ_6:
1367 case WRITE_6:
1368 if (unlikely(scmd->cmd_len < 6))
1369 goto invalid_fld;
1370 scsi_6_lba_len(cdb, &block, &n_block);
1372 /* for 6-byte r/w commands, transfer length 0
1373 * means 256 blocks of data, not 0 block.
1375 if (!n_block)
1376 n_block = 256;
1377 break;
1378 case READ_16:
1379 case WRITE_16:
1380 if (unlikely(scmd->cmd_len < 16))
1381 goto invalid_fld;
1382 scsi_16_lba_len(cdb, &block, &n_block);
1383 if (unlikely(cdb[1] & (1 << 3)))
1384 tf_flags |= ATA_TFLAG_FUA;
1385 break;
1386 default:
1387 DPRINTK("no-byte command\n");
1388 goto invalid_fld;
1391 /* Check and compose ATA command */
1392 if (!n_block)
1393 /* For 10-byte and 16-byte SCSI R/W commands, transfer
1394 * length 0 means transfer 0 block of data.
1395 * However, for ATA R/W commands, sector count 0 means
1396 * 256 or 65536 sectors, not 0 sectors as in SCSI.
1398 * WARNING: one or two older ATA drives treat 0 as 0...
1400 goto nothing_to_do;
1402 qc->flags |= ATA_QCFLAG_IO;
1403 qc->nbytes = n_block * ATA_SECT_SIZE;
1405 rc = ata_build_rw_tf(&qc->tf, qc->dev, block, n_block, tf_flags,
1406 qc->tag);
1407 if (likely(rc == 0))
1408 return 0;
1410 if (rc == -ERANGE)
1411 goto out_of_range;
1412 /* treat all other errors as -EINVAL, fall through */
1413 invalid_fld:
1414 ata_scsi_set_sense(scmd, ILLEGAL_REQUEST, 0x24, 0x0);
1415 /* "Invalid field in cbd" */
1416 return 1;
1418 out_of_range:
1419 ata_scsi_set_sense(scmd, ILLEGAL_REQUEST, 0x21, 0x0);
1420 /* "Logical Block Address out of range" */
1421 return 1;
1423 nothing_to_do:
1424 scmd->result = SAM_STAT_GOOD;
1425 return 1;
1428 static void ata_scsi_qc_complete(struct ata_queued_cmd *qc)
1430 struct ata_port *ap = qc->ap;
1431 struct scsi_cmnd *cmd = qc->scsicmd;
1432 u8 *cdb = cmd->cmnd;
1433 int need_sense = (qc->err_mask != 0);
1435 /* We snoop the SET_FEATURES - Write Cache ON/OFF command, and
1436 * schedule EH_REVALIDATE operation to update the IDENTIFY DEVICE
1437 * cache
1439 if (ap->ops->error_handler &&
1440 !need_sense && (qc->tf.command == ATA_CMD_SET_FEATURES) &&
1441 ((qc->tf.feature == SETFEATURES_WC_ON) ||
1442 (qc->tf.feature == SETFEATURES_WC_OFF))) {
1443 ap->eh_info.action |= ATA_EH_REVALIDATE;
1444 ata_port_schedule_eh(ap);
1447 /* For ATA pass thru (SAT) commands, generate a sense block if
1448 * user mandated it or if there's an error. Note that if we
1449 * generate because the user forced us to, a check condition
1450 * is generated and the ATA register values are returned
1451 * whether the command completed successfully or not. If there
1452 * was no error, SK, ASC and ASCQ will all be zero.
1454 if (((cdb[0] == ATA_16) || (cdb[0] == ATA_12)) &&
1455 ((cdb[2] & 0x20) || need_sense)) {
1456 ata_gen_passthru_sense(qc);
1457 } else {
1458 if (!need_sense) {
1459 cmd->result = SAM_STAT_GOOD;
1460 } else {
1461 /* TODO: decide which descriptor format to use
1462 * for 48b LBA devices and call that here
1463 * instead of the fixed desc, which is only
1464 * good for smaller LBA (and maybe CHS?)
1465 * devices.
1467 ata_gen_ata_sense(qc);
1471 if (need_sense && !ap->ops->error_handler)
1472 ata_dump_status(ap->id, &qc->result_tf);
1474 qc->scsidone(cmd);
1476 ata_qc_free(qc);
1480 * ata_scmd_need_defer - Check whether we need to defer scmd
1481 * @dev: ATA device to which the command is addressed
1482 * @is_io: Is the command IO (and thus possibly NCQ)?
1484 * NCQ and non-NCQ commands cannot run together. As upper layer
1485 * only knows the queue depth, we are responsible for maintaining
1486 * exclusion. This function checks whether a new command can be
1487 * issued to @dev.
1489 * LOCKING:
1490 * spin_lock_irqsave(host lock)
1492 * RETURNS:
1493 * 1 if deferring is needed, 0 otherwise.
1495 static int ata_scmd_need_defer(struct ata_device *dev, int is_io)
1497 struct ata_port *ap = dev->ap;
1499 if (!(dev->flags & ATA_DFLAG_NCQ))
1500 return 0;
1502 if (is_io) {
1503 if (!ata_tag_valid(ap->active_tag))
1504 return 0;
1505 } else {
1506 if (!ata_tag_valid(ap->active_tag) && !ap->sactive)
1507 return 0;
1509 return 1;
1513 * ata_scsi_translate - Translate then issue SCSI command to ATA device
1514 * @dev: ATA device to which the command is addressed
1515 * @cmd: SCSI command to execute
1516 * @done: SCSI command completion function
1517 * @xlat_func: Actor which translates @cmd to an ATA taskfile
1519 * Our ->queuecommand() function has decided that the SCSI
1520 * command issued can be directly translated into an ATA
1521 * command, rather than handled internally.
1523 * This function sets up an ata_queued_cmd structure for the
1524 * SCSI command, and sends that ata_queued_cmd to the hardware.
1526 * The xlat_func argument (actor) returns 0 if ready to execute
1527 * ATA command, else 1 to finish translation. If 1 is returned
1528 * then cmd->result (and possibly cmd->sense_buffer) are assumed
1529 * to be set reflecting an error condition or clean (early)
1530 * termination.
1532 * LOCKING:
1533 * spin_lock_irqsave(host lock)
1535 * RETURNS:
1536 * 0 on success, SCSI_ML_QUEUE_DEVICE_BUSY if the command
1537 * needs to be deferred.
1539 static int ata_scsi_translate(struct ata_device *dev, struct scsi_cmnd *cmd,
1540 void (*done)(struct scsi_cmnd *),
1541 ata_xlat_func_t xlat_func)
1543 struct ata_queued_cmd *qc;
1544 int is_io = xlat_func == ata_scsi_rw_xlat;
1546 VPRINTK("ENTER\n");
1548 if (unlikely(ata_scmd_need_defer(dev, is_io)))
1549 goto defer;
1551 qc = ata_scsi_qc_new(dev, cmd, done);
1552 if (!qc)
1553 goto err_mem;
1555 /* data is present; dma-map it */
1556 if (cmd->sc_data_direction == DMA_FROM_DEVICE ||
1557 cmd->sc_data_direction == DMA_TO_DEVICE) {
1558 if (unlikely(cmd->request_bufflen < 1)) {
1559 ata_dev_printk(dev, KERN_WARNING,
1560 "WARNING: zero len r/w req\n");
1561 goto err_did;
1564 if (cmd->use_sg)
1565 ata_sg_init(qc, cmd->request_buffer, cmd->use_sg);
1566 else
1567 ata_sg_init_one(qc, cmd->request_buffer,
1568 cmd->request_bufflen);
1570 qc->dma_dir = cmd->sc_data_direction;
1573 qc->complete_fn = ata_scsi_qc_complete;
1575 if (xlat_func(qc))
1576 goto early_finish;
1578 /* select device, send command to hardware */
1579 ata_qc_issue(qc);
1581 VPRINTK("EXIT\n");
1582 return 0;
1584 early_finish:
1585 ata_qc_free(qc);
1586 done(cmd);
1587 DPRINTK("EXIT - early finish (good or error)\n");
1588 return 0;
1590 err_did:
1591 ata_qc_free(qc);
1592 cmd->result = (DID_ERROR << 16);
1593 done(cmd);
1594 err_mem:
1595 DPRINTK("EXIT - internal\n");
1596 return 0;
1598 defer:
1599 DPRINTK("EXIT - defer\n");
1600 return SCSI_MLQUEUE_DEVICE_BUSY;
1604 * ata_scsi_rbuf_get - Map response buffer.
1605 * @cmd: SCSI command containing buffer to be mapped.
1606 * @buf_out: Pointer to mapped area.
1608 * Maps buffer contained within SCSI command @cmd.
1610 * LOCKING:
1611 * spin_lock_irqsave(host lock)
1613 * RETURNS:
1614 * Length of response buffer.
1617 static unsigned int ata_scsi_rbuf_get(struct scsi_cmnd *cmd, u8 **buf_out)
1619 u8 *buf;
1620 unsigned int buflen;
1622 if (cmd->use_sg) {
1623 struct scatterlist *sg;
1625 sg = (struct scatterlist *) cmd->request_buffer;
1626 buf = kmap_atomic(sg->page, KM_IRQ0) + sg->offset;
1627 buflen = sg->length;
1628 } else {
1629 buf = cmd->request_buffer;
1630 buflen = cmd->request_bufflen;
1633 *buf_out = buf;
1634 return buflen;
1638 * ata_scsi_rbuf_put - Unmap response buffer.
1639 * @cmd: SCSI command containing buffer to be unmapped.
1640 * @buf: buffer to unmap
1642 * Unmaps response buffer contained within @cmd.
1644 * LOCKING:
1645 * spin_lock_irqsave(host lock)
1648 static inline void ata_scsi_rbuf_put(struct scsi_cmnd *cmd, u8 *buf)
1650 if (cmd->use_sg) {
1651 struct scatterlist *sg;
1653 sg = (struct scatterlist *) cmd->request_buffer;
1654 kunmap_atomic(buf - sg->offset, KM_IRQ0);
1659 * ata_scsi_rbuf_fill - wrapper for SCSI command simulators
1660 * @args: device IDENTIFY data / SCSI command of interest.
1661 * @actor: Callback hook for desired SCSI command simulator
1663 * Takes care of the hard work of simulating a SCSI command...
1664 * Mapping the response buffer, calling the command's handler,
1665 * and handling the handler's return value. This return value
1666 * indicates whether the handler wishes the SCSI command to be
1667 * completed successfully (0), or not (in which case cmd->result
1668 * and sense buffer are assumed to be set).
1670 * LOCKING:
1671 * spin_lock_irqsave(host lock)
1674 void ata_scsi_rbuf_fill(struct ata_scsi_args *args,
1675 unsigned int (*actor) (struct ata_scsi_args *args,
1676 u8 *rbuf, unsigned int buflen))
1678 u8 *rbuf;
1679 unsigned int buflen, rc;
1680 struct scsi_cmnd *cmd = args->cmd;
1682 buflen = ata_scsi_rbuf_get(cmd, &rbuf);
1683 memset(rbuf, 0, buflen);
1684 rc = actor(args, rbuf, buflen);
1685 ata_scsi_rbuf_put(cmd, rbuf);
1687 if (rc == 0)
1688 cmd->result = SAM_STAT_GOOD;
1689 args->done(cmd);
1693 * ATA_SCSI_RBUF_SET - helper to set values in SCSI response buffer
1694 * @idx: byte index into SCSI response buffer
1695 * @val: value to set
1697 * To be used by SCSI command simulator functions. This macros
1698 * expects two local variables, u8 *rbuf and unsigned int buflen,
1699 * are in scope.
1701 * LOCKING:
1702 * None.
1704 #define ATA_SCSI_RBUF_SET(idx, val) do { \
1705 if ((idx) < buflen) rbuf[(idx)] = (u8)(val); \
1706 } while (0)
1709 * ata_scsiop_inq_std - Simulate INQUIRY command
1710 * @args: device IDENTIFY data / SCSI command of interest.
1711 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1712 * @buflen: Response buffer length.
1714 * Returns standard device identification data associated
1715 * with non-VPD INQUIRY command output.
1717 * LOCKING:
1718 * spin_lock_irqsave(host lock)
1721 unsigned int ata_scsiop_inq_std(struct ata_scsi_args *args, u8 *rbuf,
1722 unsigned int buflen)
1724 u8 hdr[] = {
1725 TYPE_DISK,
1727 0x5, /* claim SPC-3 version compatibility */
1729 95 - 4
1732 /* set scsi removeable (RMB) bit per ata bit */
1733 if (ata_id_removeable(args->id))
1734 hdr[1] |= (1 << 7);
1736 VPRINTK("ENTER\n");
1738 memcpy(rbuf, hdr, sizeof(hdr));
1740 if (buflen > 35) {
1741 memcpy(&rbuf[8], "ATA ", 8);
1742 ata_id_string(args->id, &rbuf[16], ATA_ID_PROD, 16);
1743 ata_id_string(args->id, &rbuf[32], ATA_ID_FW_REV, 4);
1744 if (rbuf[32] == 0 || rbuf[32] == ' ')
1745 memcpy(&rbuf[32], "n/a ", 4);
1748 if (buflen > 63) {
1749 const u8 versions[] = {
1750 0x60, /* SAM-3 (no version claimed) */
1752 0x03,
1753 0x20, /* SBC-2 (no version claimed) */
1755 0x02,
1756 0x60 /* SPC-3 (no version claimed) */
1759 memcpy(rbuf + 59, versions, sizeof(versions));
1762 return 0;
1766 * ata_scsiop_inq_00 - Simulate INQUIRY VPD page 0, list of pages
1767 * @args: device IDENTIFY data / SCSI command of interest.
1768 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1769 * @buflen: Response buffer length.
1771 * Returns list of inquiry VPD pages available.
1773 * LOCKING:
1774 * spin_lock_irqsave(host lock)
1777 unsigned int ata_scsiop_inq_00(struct ata_scsi_args *args, u8 *rbuf,
1778 unsigned int buflen)
1780 const u8 pages[] = {
1781 0x00, /* page 0x00, this page */
1782 0x80, /* page 0x80, unit serial no page */
1783 0x83 /* page 0x83, device ident page */
1785 rbuf[3] = sizeof(pages); /* number of supported VPD pages */
1787 if (buflen > 6)
1788 memcpy(rbuf + 4, pages, sizeof(pages));
1790 return 0;
1794 * ata_scsiop_inq_80 - Simulate INQUIRY VPD page 80, device serial number
1795 * @args: device IDENTIFY data / SCSI command of interest.
1796 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1797 * @buflen: Response buffer length.
1799 * Returns ATA device serial number.
1801 * LOCKING:
1802 * spin_lock_irqsave(host lock)
1805 unsigned int ata_scsiop_inq_80(struct ata_scsi_args *args, u8 *rbuf,
1806 unsigned int buflen)
1808 const u8 hdr[] = {
1810 0x80, /* this page code */
1812 ATA_ID_SERNO_LEN, /* page len */
1814 memcpy(rbuf, hdr, sizeof(hdr));
1816 if (buflen > (ATA_ID_SERNO_LEN + 4 - 1))
1817 ata_id_string(args->id, (unsigned char *) &rbuf[4],
1818 ATA_ID_SERNO, ATA_ID_SERNO_LEN);
1820 return 0;
1824 * ata_scsiop_inq_83 - Simulate INQUIRY VPD page 83, device identity
1825 * @args: device IDENTIFY data / SCSI command of interest.
1826 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1827 * @buflen: Response buffer length.
1829 * Yields two logical unit device identification designators:
1830 * - vendor specific ASCII containing the ATA serial number
1831 * - SAT defined "t10 vendor id based" containing ASCII vendor
1832 * name ("ATA "), model and serial numbers.
1834 * LOCKING:
1835 * spin_lock_irqsave(host lock)
1838 unsigned int ata_scsiop_inq_83(struct ata_scsi_args *args, u8 *rbuf,
1839 unsigned int buflen)
1841 int num;
1842 const int sat_model_serial_desc_len = 68;
1844 rbuf[1] = 0x83; /* this page code */
1845 num = 4;
1847 if (buflen > (ATA_ID_SERNO_LEN + num + 3)) {
1848 /* piv=0, assoc=lu, code_set=ACSII, designator=vendor */
1849 rbuf[num + 0] = 2;
1850 rbuf[num + 3] = ATA_ID_SERNO_LEN;
1851 num += 4;
1852 ata_id_string(args->id, (unsigned char *) rbuf + num,
1853 ATA_ID_SERNO, ATA_ID_SERNO_LEN);
1854 num += ATA_ID_SERNO_LEN;
1856 if (buflen > (sat_model_serial_desc_len + num + 3)) {
1857 /* SAT defined lu model and serial numbers descriptor */
1858 /* piv=0, assoc=lu, code_set=ACSII, designator=t10 vendor id */
1859 rbuf[num + 0] = 2;
1860 rbuf[num + 1] = 1;
1861 rbuf[num + 3] = sat_model_serial_desc_len;
1862 num += 4;
1863 memcpy(rbuf + num, "ATA ", 8);
1864 num += 8;
1865 ata_id_string(args->id, (unsigned char *) rbuf + num,
1866 ATA_ID_PROD, ATA_ID_PROD_LEN);
1867 num += ATA_ID_PROD_LEN;
1868 ata_id_string(args->id, (unsigned char *) rbuf + num,
1869 ATA_ID_SERNO, ATA_ID_SERNO_LEN);
1870 num += ATA_ID_SERNO_LEN;
1872 rbuf[3] = num - 4; /* page len (assume less than 256 bytes) */
1873 return 0;
1877 * ata_scsiop_noop - Command handler that simply returns success.
1878 * @args: device IDENTIFY data / SCSI command of interest.
1879 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1880 * @buflen: Response buffer length.
1882 * No operation. Simply returns success to caller, to indicate
1883 * that the caller should successfully complete this SCSI command.
1885 * LOCKING:
1886 * spin_lock_irqsave(host lock)
1889 unsigned int ata_scsiop_noop(struct ata_scsi_args *args, u8 *rbuf,
1890 unsigned int buflen)
1892 VPRINTK("ENTER\n");
1893 return 0;
1897 * ata_msense_push - Push data onto MODE SENSE data output buffer
1898 * @ptr_io: (input/output) Location to store more output data
1899 * @last: End of output data buffer
1900 * @buf: Pointer to BLOB being added to output buffer
1901 * @buflen: Length of BLOB
1903 * Store MODE SENSE data on an output buffer.
1905 * LOCKING:
1906 * None.
1909 static void ata_msense_push(u8 **ptr_io, const u8 *last,
1910 const u8 *buf, unsigned int buflen)
1912 u8 *ptr = *ptr_io;
1914 if ((ptr + buflen - 1) > last)
1915 return;
1917 memcpy(ptr, buf, buflen);
1919 ptr += buflen;
1921 *ptr_io = ptr;
1925 * ata_msense_caching - Simulate MODE SENSE caching info page
1926 * @id: device IDENTIFY data
1927 * @ptr_io: (input/output) Location to store more output data
1928 * @last: End of output data buffer
1930 * Generate a caching info page, which conditionally indicates
1931 * write caching to the SCSI layer, depending on device
1932 * capabilities.
1934 * LOCKING:
1935 * None.
1938 static unsigned int ata_msense_caching(u16 *id, u8 **ptr_io,
1939 const u8 *last)
1941 u8 page[CACHE_MPAGE_LEN];
1943 memcpy(page, def_cache_mpage, sizeof(page));
1944 if (ata_id_wcache_enabled(id))
1945 page[2] |= (1 << 2); /* write cache enable */
1946 if (!ata_id_rahead_enabled(id))
1947 page[12] |= (1 << 5); /* disable read ahead */
1949 ata_msense_push(ptr_io, last, page, sizeof(page));
1950 return sizeof(page);
1954 * ata_msense_ctl_mode - Simulate MODE SENSE control mode page
1955 * @dev: Device associated with this MODE SENSE command
1956 * @ptr_io: (input/output) Location to store more output data
1957 * @last: End of output data buffer
1959 * Generate a generic MODE SENSE control mode page.
1961 * LOCKING:
1962 * None.
1965 static unsigned int ata_msense_ctl_mode(u8 **ptr_io, const u8 *last)
1967 ata_msense_push(ptr_io, last, def_control_mpage,
1968 sizeof(def_control_mpage));
1969 return sizeof(def_control_mpage);
1973 * ata_msense_rw_recovery - Simulate MODE SENSE r/w error recovery page
1974 * @dev: Device associated with this MODE SENSE command
1975 * @ptr_io: (input/output) Location to store more output data
1976 * @last: End of output data buffer
1978 * Generate a generic MODE SENSE r/w error recovery page.
1980 * LOCKING:
1981 * None.
1984 static unsigned int ata_msense_rw_recovery(u8 **ptr_io, const u8 *last)
1987 ata_msense_push(ptr_io, last, def_rw_recovery_mpage,
1988 sizeof(def_rw_recovery_mpage));
1989 return sizeof(def_rw_recovery_mpage);
1993 * We can turn this into a real blacklist if it's needed, for now just
1994 * blacklist any Maxtor BANC1G10 revision firmware
1996 static int ata_dev_supports_fua(u16 *id)
1998 unsigned char model[ATA_ID_PROD_LEN + 1], fw[ATA_ID_FW_REV_LEN + 1];
2000 if (!libata_fua)
2001 return 0;
2002 if (!ata_id_has_fua(id))
2003 return 0;
2005 ata_id_c_string(id, model, ATA_ID_PROD, sizeof(model));
2006 ata_id_c_string(id, fw, ATA_ID_FW_REV, sizeof(fw));
2008 if (strcmp(model, "Maxtor"))
2009 return 1;
2010 if (strcmp(fw, "BANC1G10"))
2011 return 1;
2013 return 0; /* blacklisted */
2017 * ata_scsiop_mode_sense - Simulate MODE SENSE 6, 10 commands
2018 * @args: device IDENTIFY data / SCSI command of interest.
2019 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2020 * @buflen: Response buffer length.
2022 * Simulate MODE SENSE commands. Assume this is invoked for direct
2023 * access devices (e.g. disks) only. There should be no block
2024 * descriptor for other device types.
2026 * LOCKING:
2027 * spin_lock_irqsave(host lock)
2030 unsigned int ata_scsiop_mode_sense(struct ata_scsi_args *args, u8 *rbuf,
2031 unsigned int buflen)
2033 struct ata_device *dev = args->dev;
2034 u8 *scsicmd = args->cmd->cmnd, *p, *last;
2035 const u8 sat_blk_desc[] = {
2036 0, 0, 0, 0, /* number of blocks: sat unspecified */
2038 0, 0x2, 0x0 /* block length: 512 bytes */
2040 u8 pg, spg;
2041 unsigned int ebd, page_control, six_byte, output_len, alloc_len, minlen;
2042 u8 dpofua;
2044 VPRINTK("ENTER\n");
2046 six_byte = (scsicmd[0] == MODE_SENSE);
2047 ebd = !(scsicmd[1] & 0x8); /* dbd bit inverted == edb */
2049 * LLBA bit in msense(10) ignored (compliant)
2052 page_control = scsicmd[2] >> 6;
2053 switch (page_control) {
2054 case 0: /* current */
2055 break; /* supported */
2056 case 3: /* saved */
2057 goto saving_not_supp;
2058 case 1: /* changeable */
2059 case 2: /* defaults */
2060 default:
2061 goto invalid_fld;
2064 if (six_byte) {
2065 output_len = 4 + (ebd ? 8 : 0);
2066 alloc_len = scsicmd[4];
2067 } else {
2068 output_len = 8 + (ebd ? 8 : 0);
2069 alloc_len = (scsicmd[7] << 8) + scsicmd[8];
2071 minlen = (alloc_len < buflen) ? alloc_len : buflen;
2073 p = rbuf + output_len;
2074 last = rbuf + minlen - 1;
2076 pg = scsicmd[2] & 0x3f;
2077 spg = scsicmd[3];
2079 * No mode subpages supported (yet) but asking for _all_
2080 * subpages may be valid
2082 if (spg && (spg != ALL_SUB_MPAGES))
2083 goto invalid_fld;
2085 switch(pg) {
2086 case RW_RECOVERY_MPAGE:
2087 output_len += ata_msense_rw_recovery(&p, last);
2088 break;
2090 case CACHE_MPAGE:
2091 output_len += ata_msense_caching(args->id, &p, last);
2092 break;
2094 case CONTROL_MPAGE: {
2095 output_len += ata_msense_ctl_mode(&p, last);
2096 break;
2099 case ALL_MPAGES:
2100 output_len += ata_msense_rw_recovery(&p, last);
2101 output_len += ata_msense_caching(args->id, &p, last);
2102 output_len += ata_msense_ctl_mode(&p, last);
2103 break;
2105 default: /* invalid page code */
2106 goto invalid_fld;
2109 if (minlen < 1)
2110 return 0;
2112 dpofua = 0;
2113 if (ata_dev_supports_fua(args->id) && (dev->flags & ATA_DFLAG_LBA48) &&
2114 (!(dev->flags & ATA_DFLAG_PIO) || dev->multi_count))
2115 dpofua = 1 << 4;
2117 if (six_byte) {
2118 output_len--;
2119 rbuf[0] = output_len;
2120 if (minlen > 2)
2121 rbuf[2] |= dpofua;
2122 if (ebd) {
2123 if (minlen > 3)
2124 rbuf[3] = sizeof(sat_blk_desc);
2125 if (minlen > 11)
2126 memcpy(rbuf + 4, sat_blk_desc,
2127 sizeof(sat_blk_desc));
2129 } else {
2130 output_len -= 2;
2131 rbuf[0] = output_len >> 8;
2132 if (minlen > 1)
2133 rbuf[1] = output_len;
2134 if (minlen > 3)
2135 rbuf[3] |= dpofua;
2136 if (ebd) {
2137 if (minlen > 7)
2138 rbuf[7] = sizeof(sat_blk_desc);
2139 if (minlen > 15)
2140 memcpy(rbuf + 8, sat_blk_desc,
2141 sizeof(sat_blk_desc));
2144 return 0;
2146 invalid_fld:
2147 ata_scsi_set_sense(args->cmd, ILLEGAL_REQUEST, 0x24, 0x0);
2148 /* "Invalid field in cbd" */
2149 return 1;
2151 saving_not_supp:
2152 ata_scsi_set_sense(args->cmd, ILLEGAL_REQUEST, 0x39, 0x0);
2153 /* "Saving parameters not supported" */
2154 return 1;
2158 * ata_scsiop_read_cap - Simulate READ CAPACITY[ 16] commands
2159 * @args: device IDENTIFY data / SCSI command of interest.
2160 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2161 * @buflen: Response buffer length.
2163 * Simulate READ CAPACITY commands.
2165 * LOCKING:
2166 * None.
2168 unsigned int ata_scsiop_read_cap(struct ata_scsi_args *args, u8 *rbuf,
2169 unsigned int buflen)
2171 u64 last_lba = args->dev->n_sectors - 1; /* LBA of the last block */
2173 VPRINTK("ENTER\n");
2175 if (args->cmd->cmnd[0] == READ_CAPACITY) {
2176 if (last_lba >= 0xffffffffULL)
2177 last_lba = 0xffffffff;
2179 /* sector count, 32-bit */
2180 ATA_SCSI_RBUF_SET(0, last_lba >> (8 * 3));
2181 ATA_SCSI_RBUF_SET(1, last_lba >> (8 * 2));
2182 ATA_SCSI_RBUF_SET(2, last_lba >> (8 * 1));
2183 ATA_SCSI_RBUF_SET(3, last_lba);
2185 /* sector size */
2186 ATA_SCSI_RBUF_SET(6, ATA_SECT_SIZE >> 8);
2187 ATA_SCSI_RBUF_SET(7, ATA_SECT_SIZE);
2188 } else {
2189 /* sector count, 64-bit */
2190 ATA_SCSI_RBUF_SET(0, last_lba >> (8 * 7));
2191 ATA_SCSI_RBUF_SET(1, last_lba >> (8 * 6));
2192 ATA_SCSI_RBUF_SET(2, last_lba >> (8 * 5));
2193 ATA_SCSI_RBUF_SET(3, last_lba >> (8 * 4));
2194 ATA_SCSI_RBUF_SET(4, last_lba >> (8 * 3));
2195 ATA_SCSI_RBUF_SET(5, last_lba >> (8 * 2));
2196 ATA_SCSI_RBUF_SET(6, last_lba >> (8 * 1));
2197 ATA_SCSI_RBUF_SET(7, last_lba);
2199 /* sector size */
2200 ATA_SCSI_RBUF_SET(10, ATA_SECT_SIZE >> 8);
2201 ATA_SCSI_RBUF_SET(11, ATA_SECT_SIZE);
2204 return 0;
2208 * ata_scsiop_report_luns - Simulate REPORT LUNS command
2209 * @args: device IDENTIFY data / SCSI command of interest.
2210 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2211 * @buflen: Response buffer length.
2213 * Simulate REPORT LUNS command.
2215 * LOCKING:
2216 * spin_lock_irqsave(host lock)
2219 unsigned int ata_scsiop_report_luns(struct ata_scsi_args *args, u8 *rbuf,
2220 unsigned int buflen)
2222 VPRINTK("ENTER\n");
2223 rbuf[3] = 8; /* just one lun, LUN 0, size 8 bytes */
2225 return 0;
2229 * ata_scsi_set_sense - Set SCSI sense data and status
2230 * @cmd: SCSI request to be handled
2231 * @sk: SCSI-defined sense key
2232 * @asc: SCSI-defined additional sense code
2233 * @ascq: SCSI-defined additional sense code qualifier
2235 * Helper function that builds a valid fixed format, current
2236 * response code and the given sense key (sk), additional sense
2237 * code (asc) and additional sense code qualifier (ascq) with
2238 * a SCSI command status of %SAM_STAT_CHECK_CONDITION and
2239 * DRIVER_SENSE set in the upper bits of scsi_cmnd::result .
2241 * LOCKING:
2242 * Not required
2245 void ata_scsi_set_sense(struct scsi_cmnd *cmd, u8 sk, u8 asc, u8 ascq)
2247 cmd->result = (DRIVER_SENSE << 24) | SAM_STAT_CHECK_CONDITION;
2249 cmd->sense_buffer[0] = 0x70; /* fixed format, current */
2250 cmd->sense_buffer[2] = sk;
2251 cmd->sense_buffer[7] = 18 - 8; /* additional sense length */
2252 cmd->sense_buffer[12] = asc;
2253 cmd->sense_buffer[13] = ascq;
2257 * ata_scsi_badcmd - End a SCSI request with an error
2258 * @cmd: SCSI request to be handled
2259 * @done: SCSI command completion function
2260 * @asc: SCSI-defined additional sense code
2261 * @ascq: SCSI-defined additional sense code qualifier
2263 * Helper function that completes a SCSI command with
2264 * %SAM_STAT_CHECK_CONDITION, with a sense key %ILLEGAL_REQUEST
2265 * and the specified additional sense codes.
2267 * LOCKING:
2268 * spin_lock_irqsave(host lock)
2271 void ata_scsi_badcmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *), u8 asc, u8 ascq)
2273 DPRINTK("ENTER\n");
2274 ata_scsi_set_sense(cmd, ILLEGAL_REQUEST, asc, ascq);
2276 done(cmd);
2279 static void atapi_sense_complete(struct ata_queued_cmd *qc)
2281 if (qc->err_mask && ((qc->err_mask & AC_ERR_DEV) == 0)) {
2282 /* FIXME: not quite right; we don't want the
2283 * translation of taskfile registers into
2284 * a sense descriptors, since that's only
2285 * correct for ATA, not ATAPI
2287 ata_gen_passthru_sense(qc);
2290 qc->scsidone(qc->scsicmd);
2291 ata_qc_free(qc);
2294 /* is it pointless to prefer PIO for "safety reasons"? */
2295 static inline int ata_pio_use_silly(struct ata_port *ap)
2297 return (ap->flags & ATA_FLAG_PIO_DMA);
2300 static void atapi_request_sense(struct ata_queued_cmd *qc)
2302 struct ata_port *ap = qc->ap;
2303 struct scsi_cmnd *cmd = qc->scsicmd;
2305 DPRINTK("ATAPI request sense\n");
2307 /* FIXME: is this needed? */
2308 memset(cmd->sense_buffer, 0, sizeof(cmd->sense_buffer));
2310 ap->ops->tf_read(ap, &qc->tf);
2312 /* fill these in, for the case where they are -not- overwritten */
2313 cmd->sense_buffer[0] = 0x70;
2314 cmd->sense_buffer[2] = qc->tf.feature >> 4;
2316 ata_qc_reinit(qc);
2318 ata_sg_init_one(qc, cmd->sense_buffer, sizeof(cmd->sense_buffer));
2319 qc->dma_dir = DMA_FROM_DEVICE;
2321 memset(&qc->cdb, 0, qc->dev->cdb_len);
2322 qc->cdb[0] = REQUEST_SENSE;
2323 qc->cdb[4] = SCSI_SENSE_BUFFERSIZE;
2325 qc->tf.flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
2326 qc->tf.command = ATA_CMD_PACKET;
2328 if (ata_pio_use_silly(ap)) {
2329 qc->tf.protocol = ATA_PROT_ATAPI_DMA;
2330 qc->tf.feature |= ATAPI_PKT_DMA;
2331 } else {
2332 qc->tf.protocol = ATA_PROT_ATAPI;
2333 qc->tf.lbam = (8 * 1024) & 0xff;
2334 qc->tf.lbah = (8 * 1024) >> 8;
2336 qc->nbytes = SCSI_SENSE_BUFFERSIZE;
2338 qc->complete_fn = atapi_sense_complete;
2340 ata_qc_issue(qc);
2342 DPRINTK("EXIT\n");
2345 static void atapi_qc_complete(struct ata_queued_cmd *qc)
2347 struct scsi_cmnd *cmd = qc->scsicmd;
2348 unsigned int err_mask = qc->err_mask;
2350 VPRINTK("ENTER, err_mask 0x%X\n", err_mask);
2352 /* handle completion from new EH */
2353 if (unlikely(qc->ap->ops->error_handler &&
2354 (err_mask || qc->flags & ATA_QCFLAG_SENSE_VALID))) {
2356 if (!(qc->flags & ATA_QCFLAG_SENSE_VALID)) {
2357 /* FIXME: not quite right; we don't want the
2358 * translation of taskfile registers into a
2359 * sense descriptors, since that's only
2360 * correct for ATA, not ATAPI
2362 ata_gen_passthru_sense(qc);
2365 /* SCSI EH automatically locks door if sdev->locked is
2366 * set. Sometimes door lock request continues to
2367 * fail, for example, when no media is present. This
2368 * creates a loop - SCSI EH issues door lock which
2369 * fails and gets invoked again to acquire sense data
2370 * for the failed command.
2372 * If door lock fails, always clear sdev->locked to
2373 * avoid this infinite loop.
2375 if (qc->cdb[0] == ALLOW_MEDIUM_REMOVAL)
2376 qc->dev->sdev->locked = 0;
2378 qc->scsicmd->result = SAM_STAT_CHECK_CONDITION;
2379 qc->scsidone(cmd);
2380 ata_qc_free(qc);
2381 return;
2384 /* successful completion or old EH failure path */
2385 if (unlikely(err_mask & AC_ERR_DEV)) {
2386 cmd->result = SAM_STAT_CHECK_CONDITION;
2387 atapi_request_sense(qc);
2388 return;
2389 } else if (unlikely(err_mask)) {
2390 /* FIXME: not quite right; we don't want the
2391 * translation of taskfile registers into
2392 * a sense descriptors, since that's only
2393 * correct for ATA, not ATAPI
2395 ata_gen_passthru_sense(qc);
2396 } else {
2397 u8 *scsicmd = cmd->cmnd;
2399 if ((scsicmd[0] == INQUIRY) && ((scsicmd[1] & 0x03) == 0)) {
2400 u8 *buf = NULL;
2401 unsigned int buflen;
2403 buflen = ata_scsi_rbuf_get(cmd, &buf);
2405 /* ATAPI devices typically report zero for their SCSI version,
2406 * and sometimes deviate from the spec WRT response data
2407 * format. If SCSI version is reported as zero like normal,
2408 * then we make the following fixups: 1) Fake MMC-5 version,
2409 * to indicate to the Linux scsi midlayer this is a modern
2410 * device. 2) Ensure response data format / ATAPI information
2411 * are always correct.
2413 if (buf[2] == 0) {
2414 buf[2] = 0x5;
2415 buf[3] = 0x32;
2418 ata_scsi_rbuf_put(cmd, buf);
2421 cmd->result = SAM_STAT_GOOD;
2424 qc->scsidone(cmd);
2425 ata_qc_free(qc);
2428 * atapi_xlat - Initialize PACKET taskfile
2429 * @qc: command structure to be initialized
2431 * LOCKING:
2432 * spin_lock_irqsave(host lock)
2434 * RETURNS:
2435 * Zero on success, non-zero on failure.
2437 static unsigned int atapi_xlat(struct ata_queued_cmd *qc)
2439 struct scsi_cmnd *scmd = qc->scsicmd;
2440 struct ata_device *dev = qc->dev;
2441 int using_pio = (dev->flags & ATA_DFLAG_PIO);
2442 int nodata = (scmd->sc_data_direction == DMA_NONE);
2444 if (!using_pio)
2445 /* Check whether ATAPI DMA is safe */
2446 if (ata_check_atapi_dma(qc))
2447 using_pio = 1;
2449 memset(qc->cdb, 0, dev->cdb_len);
2450 memcpy(qc->cdb, scmd->cmnd, scmd->cmd_len);
2452 qc->complete_fn = atapi_qc_complete;
2454 qc->tf.flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
2455 if (scmd->sc_data_direction == DMA_TO_DEVICE) {
2456 qc->tf.flags |= ATA_TFLAG_WRITE;
2457 DPRINTK("direction: write\n");
2460 qc->tf.command = ATA_CMD_PACKET;
2462 /* no data, or PIO data xfer */
2463 if (using_pio || nodata) {
2464 if (nodata)
2465 qc->tf.protocol = ATA_PROT_ATAPI_NODATA;
2466 else
2467 qc->tf.protocol = ATA_PROT_ATAPI;
2468 qc->tf.lbam = (8 * 1024) & 0xff;
2469 qc->tf.lbah = (8 * 1024) >> 8;
2472 /* DMA data xfer */
2473 else {
2474 qc->tf.protocol = ATA_PROT_ATAPI_DMA;
2475 qc->tf.feature |= ATAPI_PKT_DMA;
2477 if (atapi_dmadir && (scmd->sc_data_direction != DMA_TO_DEVICE))
2478 /* some SATA bridges need us to indicate data xfer direction */
2479 qc->tf.feature |= ATAPI_DMADIR;
2482 qc->nbytes = scmd->request_bufflen;
2484 return 0;
2487 static struct ata_device * ata_find_dev(struct ata_port *ap, int id)
2489 if (likely(id < ATA_MAX_DEVICES))
2490 return &ap->device[id];
2491 return NULL;
2494 static struct ata_device * __ata_scsi_find_dev(struct ata_port *ap,
2495 const struct scsi_device *scsidev)
2497 /* skip commands not addressed to targets we simulate */
2498 if (unlikely(scsidev->channel || scsidev->lun))
2499 return NULL;
2501 return ata_find_dev(ap, scsidev->id);
2505 * ata_scsi_dev_enabled - determine if device is enabled
2506 * @dev: ATA device
2508 * Determine if commands should be sent to the specified device.
2510 * LOCKING:
2511 * spin_lock_irqsave(host lock)
2513 * RETURNS:
2514 * 0 if commands are not allowed / 1 if commands are allowed
2517 static int ata_scsi_dev_enabled(struct ata_device *dev)
2519 if (unlikely(!ata_dev_enabled(dev)))
2520 return 0;
2522 if (!atapi_enabled || (dev->ap->flags & ATA_FLAG_NO_ATAPI)) {
2523 if (unlikely(dev->class == ATA_DEV_ATAPI)) {
2524 ata_dev_printk(dev, KERN_WARNING,
2525 "WARNING: ATAPI is %s, device ignored.\n",
2526 atapi_enabled ? "not supported with this driver" : "disabled");
2527 return 0;
2531 return 1;
2535 * ata_scsi_find_dev - lookup ata_device from scsi_cmnd
2536 * @ap: ATA port to which the device is attached
2537 * @scsidev: SCSI device from which we derive the ATA device
2539 * Given various information provided in struct scsi_cmnd,
2540 * map that onto an ATA bus, and using that mapping
2541 * determine which ata_device is associated with the
2542 * SCSI command to be sent.
2544 * LOCKING:
2545 * spin_lock_irqsave(host lock)
2547 * RETURNS:
2548 * Associated ATA device, or %NULL if not found.
2550 static struct ata_device *
2551 ata_scsi_find_dev(struct ata_port *ap, const struct scsi_device *scsidev)
2553 struct ata_device *dev = __ata_scsi_find_dev(ap, scsidev);
2555 if (unlikely(!dev || !ata_scsi_dev_enabled(dev)))
2556 return NULL;
2558 return dev;
2562 * ata_scsi_map_proto - Map pass-thru protocol value to taskfile value.
2563 * @byte1: Byte 1 from pass-thru CDB.
2565 * RETURNS:
2566 * ATA_PROT_UNKNOWN if mapping failed/unimplemented, protocol otherwise.
2568 static u8
2569 ata_scsi_map_proto(u8 byte1)
2571 switch((byte1 & 0x1e) >> 1) {
2572 case 3: /* Non-data */
2573 return ATA_PROT_NODATA;
2575 case 6: /* DMA */
2576 return ATA_PROT_DMA;
2578 case 4: /* PIO Data-in */
2579 case 5: /* PIO Data-out */
2580 return ATA_PROT_PIO;
2582 case 10: /* Device Reset */
2583 case 0: /* Hard Reset */
2584 case 1: /* SRST */
2585 case 2: /* Bus Idle */
2586 case 7: /* Packet */
2587 case 8: /* DMA Queued */
2588 case 9: /* Device Diagnostic */
2589 case 11: /* UDMA Data-in */
2590 case 12: /* UDMA Data-Out */
2591 case 13: /* FPDMA */
2592 default: /* Reserved */
2593 break;
2596 return ATA_PROT_UNKNOWN;
2600 * ata_scsi_pass_thru - convert ATA pass-thru CDB to taskfile
2601 * @qc: command structure to be initialized
2603 * Handles either 12 or 16-byte versions of the CDB.
2605 * RETURNS:
2606 * Zero on success, non-zero on failure.
2608 static unsigned int ata_scsi_pass_thru(struct ata_queued_cmd *qc)
2610 struct ata_taskfile *tf = &(qc->tf);
2611 struct scsi_cmnd *scmd = qc->scsicmd;
2612 struct ata_device *dev = qc->dev;
2613 const u8 *cdb = scmd->cmnd;
2615 if ((tf->protocol = ata_scsi_map_proto(cdb[1])) == ATA_PROT_UNKNOWN)
2616 goto invalid_fld;
2618 /* We may not issue DMA commands if no DMA mode is set */
2619 if (tf->protocol == ATA_PROT_DMA && dev->dma_mode == 0)
2620 goto invalid_fld;
2622 if (cdb[1] & 0xe0)
2623 /* PIO multi not supported yet */
2624 goto invalid_fld;
2627 * 12 and 16 byte CDBs use different offsets to
2628 * provide the various register values.
2630 if (cdb[0] == ATA_16) {
2632 * 16-byte CDB - may contain extended commands.
2634 * If that is the case, copy the upper byte register values.
2636 if (cdb[1] & 0x01) {
2637 tf->hob_feature = cdb[3];
2638 tf->hob_nsect = cdb[5];
2639 tf->hob_lbal = cdb[7];
2640 tf->hob_lbam = cdb[9];
2641 tf->hob_lbah = cdb[11];
2642 tf->flags |= ATA_TFLAG_LBA48;
2643 } else
2644 tf->flags &= ~ATA_TFLAG_LBA48;
2647 * Always copy low byte, device and command registers.
2649 tf->feature = cdb[4];
2650 tf->nsect = cdb[6];
2651 tf->lbal = cdb[8];
2652 tf->lbam = cdb[10];
2653 tf->lbah = cdb[12];
2654 tf->device = cdb[13];
2655 tf->command = cdb[14];
2656 } else {
2658 * 12-byte CDB - incapable of extended commands.
2660 tf->flags &= ~ATA_TFLAG_LBA48;
2662 tf->feature = cdb[3];
2663 tf->nsect = cdb[4];
2664 tf->lbal = cdb[5];
2665 tf->lbam = cdb[6];
2666 tf->lbah = cdb[7];
2667 tf->device = cdb[8];
2668 tf->command = cdb[9];
2671 * If slave is possible, enforce correct master/slave bit
2673 if (qc->ap->flags & ATA_FLAG_SLAVE_POSS)
2674 tf->device = qc->dev->devno ?
2675 tf->device | ATA_DEV1 : tf->device & ~ATA_DEV1;
2678 * Filter SET_FEATURES - XFER MODE command -- otherwise,
2679 * SET_FEATURES - XFER MODE must be preceded/succeeded
2680 * by an update to hardware-specific registers for each
2681 * controller (i.e. the reason for ->set_piomode(),
2682 * ->set_dmamode(), and ->post_set_mode() hooks).
2684 if ((tf->command == ATA_CMD_SET_FEATURES)
2685 && (tf->feature == SETFEATURES_XFER))
2686 goto invalid_fld;
2689 * Set flags so that all registers will be written,
2690 * and pass on write indication (used for PIO/DMA
2691 * setup.)
2693 tf->flags |= (ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE);
2695 if (scmd->sc_data_direction == DMA_TO_DEVICE)
2696 tf->flags |= ATA_TFLAG_WRITE;
2699 * Set transfer length.
2701 * TODO: find out if we need to do more here to
2702 * cover scatter/gather case.
2704 qc->nbytes = scmd->request_bufflen;
2706 /* request result TF */
2707 qc->flags |= ATA_QCFLAG_RESULT_TF;
2709 return 0;
2711 invalid_fld:
2712 ata_scsi_set_sense(scmd, ILLEGAL_REQUEST, 0x24, 0x00);
2713 /* "Invalid field in cdb" */
2714 return 1;
2718 * ata_get_xlat_func - check if SCSI to ATA translation is possible
2719 * @dev: ATA device
2720 * @cmd: SCSI command opcode to consider
2722 * Look up the SCSI command given, and determine whether the
2723 * SCSI command is to be translated or simulated.
2725 * RETURNS:
2726 * Pointer to translation function if possible, %NULL if not.
2729 static inline ata_xlat_func_t ata_get_xlat_func(struct ata_device *dev, u8 cmd)
2731 switch (cmd) {
2732 case READ_6:
2733 case READ_10:
2734 case READ_16:
2736 case WRITE_6:
2737 case WRITE_10:
2738 case WRITE_16:
2739 return ata_scsi_rw_xlat;
2741 case SYNCHRONIZE_CACHE:
2742 if (ata_try_flush_cache(dev))
2743 return ata_scsi_flush_xlat;
2744 break;
2746 case VERIFY:
2747 case VERIFY_16:
2748 return ata_scsi_verify_xlat;
2750 case ATA_12:
2751 case ATA_16:
2752 return ata_scsi_pass_thru;
2754 case START_STOP:
2755 return ata_scsi_start_stop_xlat;
2758 return NULL;
2762 * ata_scsi_dump_cdb - dump SCSI command contents to dmesg
2763 * @ap: ATA port to which the command was being sent
2764 * @cmd: SCSI command to dump
2766 * Prints the contents of a SCSI command via printk().
2769 static inline void ata_scsi_dump_cdb(struct ata_port *ap,
2770 struct scsi_cmnd *cmd)
2772 #ifdef ATA_DEBUG
2773 struct scsi_device *scsidev = cmd->device;
2774 u8 *scsicmd = cmd->cmnd;
2776 DPRINTK("CDB (%u:%d,%d,%d) %02x %02x %02x %02x %02x %02x %02x %02x %02x\n",
2777 ap->id,
2778 scsidev->channel, scsidev->id, scsidev->lun,
2779 scsicmd[0], scsicmd[1], scsicmd[2], scsicmd[3],
2780 scsicmd[4], scsicmd[5], scsicmd[6], scsicmd[7],
2781 scsicmd[8]);
2782 #endif
2785 static inline int __ata_scsi_queuecmd(struct scsi_cmnd *scmd,
2786 void (*done)(struct scsi_cmnd *),
2787 struct ata_device *dev)
2789 int rc = 0;
2791 if (unlikely(!scmd->cmd_len)) {
2792 ata_dev_printk(dev, KERN_WARNING, "WARNING: zero len CDB\n");
2793 scmd->result = DID_ERROR << 16;
2794 done(scmd);
2795 return 0;
2798 if (dev->class == ATA_DEV_ATA) {
2799 ata_xlat_func_t xlat_func = ata_get_xlat_func(dev,
2800 scmd->cmnd[0]);
2802 if (xlat_func)
2803 rc = ata_scsi_translate(dev, scmd, done, xlat_func);
2804 else
2805 ata_scsi_simulate(dev, scmd, done);
2806 } else
2807 rc = ata_scsi_translate(dev, scmd, done, atapi_xlat);
2809 return rc;
2813 * ata_scsi_queuecmd - Issue SCSI cdb to libata-managed device
2814 * @cmd: SCSI command to be sent
2815 * @done: Completion function, called when command is complete
2817 * In some cases, this function translates SCSI commands into
2818 * ATA taskfiles, and queues the taskfiles to be sent to
2819 * hardware. In other cases, this function simulates a
2820 * SCSI device by evaluating and responding to certain
2821 * SCSI commands. This creates the overall effect of
2822 * ATA and ATAPI devices appearing as SCSI devices.
2824 * LOCKING:
2825 * Releases scsi-layer-held lock, and obtains host lock.
2827 * RETURNS:
2828 * Return value from __ata_scsi_queuecmd() if @cmd can be queued,
2829 * 0 otherwise.
2831 int ata_scsi_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *))
2833 struct ata_port *ap;
2834 struct ata_device *dev;
2835 struct scsi_device *scsidev = cmd->device;
2836 struct Scsi_Host *shost = scsidev->host;
2837 int rc = 0;
2839 ap = ata_shost_to_port(shost);
2841 spin_unlock(shost->host_lock);
2842 spin_lock(ap->lock);
2844 ata_scsi_dump_cdb(ap, cmd);
2846 dev = ata_scsi_find_dev(ap, scsidev);
2847 if (likely(dev))
2848 rc = __ata_scsi_queuecmd(cmd, done, dev);
2849 else {
2850 cmd->result = (DID_BAD_TARGET << 16);
2851 done(cmd);
2854 spin_unlock(ap->lock);
2855 spin_lock(shost->host_lock);
2856 return rc;
2860 * ata_scsi_simulate - simulate SCSI command on ATA device
2861 * @dev: the target device
2862 * @cmd: SCSI command being sent to device.
2863 * @done: SCSI command completion function.
2865 * Interprets and directly executes a select list of SCSI commands
2866 * that can be handled internally.
2868 * LOCKING:
2869 * spin_lock_irqsave(host lock)
2872 void ata_scsi_simulate(struct ata_device *dev, struct scsi_cmnd *cmd,
2873 void (*done)(struct scsi_cmnd *))
2875 struct ata_scsi_args args;
2876 const u8 *scsicmd = cmd->cmnd;
2878 args.dev = dev;
2879 args.id = dev->id;
2880 args.cmd = cmd;
2881 args.done = done;
2883 switch(scsicmd[0]) {
2884 /* no-op's, complete with success */
2885 case SYNCHRONIZE_CACHE:
2886 case REZERO_UNIT:
2887 case SEEK_6:
2888 case SEEK_10:
2889 case TEST_UNIT_READY:
2890 case FORMAT_UNIT: /* FIXME: correct? */
2891 case SEND_DIAGNOSTIC: /* FIXME: correct? */
2892 ata_scsi_rbuf_fill(&args, ata_scsiop_noop);
2893 break;
2895 case INQUIRY:
2896 if (scsicmd[1] & 2) /* is CmdDt set? */
2897 ata_scsi_invalid_field(cmd, done);
2898 else if ((scsicmd[1] & 1) == 0) /* is EVPD clear? */
2899 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_std);
2900 else if (scsicmd[2] == 0x00)
2901 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_00);
2902 else if (scsicmd[2] == 0x80)
2903 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_80);
2904 else if (scsicmd[2] == 0x83)
2905 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_83);
2906 else
2907 ata_scsi_invalid_field(cmd, done);
2908 break;
2910 case MODE_SENSE:
2911 case MODE_SENSE_10:
2912 ata_scsi_rbuf_fill(&args, ata_scsiop_mode_sense);
2913 break;
2915 case MODE_SELECT: /* unconditionally return */
2916 case MODE_SELECT_10: /* bad-field-in-cdb */
2917 ata_scsi_invalid_field(cmd, done);
2918 break;
2920 case READ_CAPACITY:
2921 ata_scsi_rbuf_fill(&args, ata_scsiop_read_cap);
2922 break;
2924 case SERVICE_ACTION_IN:
2925 if ((scsicmd[1] & 0x1f) == SAI_READ_CAPACITY_16)
2926 ata_scsi_rbuf_fill(&args, ata_scsiop_read_cap);
2927 else
2928 ata_scsi_invalid_field(cmd, done);
2929 break;
2931 case REPORT_LUNS:
2932 ata_scsi_rbuf_fill(&args, ata_scsiop_report_luns);
2933 break;
2935 /* mandatory commands we haven't implemented yet */
2936 case REQUEST_SENSE:
2938 /* all other commands */
2939 default:
2940 ata_scsi_set_sense(cmd, ILLEGAL_REQUEST, 0x20, 0x0);
2941 /* "Invalid command operation code" */
2942 done(cmd);
2943 break;
2947 void ata_scsi_scan_host(struct ata_port *ap)
2949 unsigned int i;
2951 if (ap->flags & ATA_FLAG_DISABLED)
2952 return;
2954 for (i = 0; i < ATA_MAX_DEVICES; i++) {
2955 struct ata_device *dev = &ap->device[i];
2956 struct scsi_device *sdev;
2958 if (!ata_dev_enabled(dev) || dev->sdev)
2959 continue;
2961 sdev = __scsi_add_device(ap->scsi_host, 0, i, 0, NULL);
2962 if (!IS_ERR(sdev)) {
2963 dev->sdev = sdev;
2964 scsi_device_put(sdev);
2970 * ata_scsi_offline_dev - offline attached SCSI device
2971 * @dev: ATA device to offline attached SCSI device for
2973 * This function is called from ata_eh_hotplug() and responsible
2974 * for taking the SCSI device attached to @dev offline. This
2975 * function is called with host lock which protects dev->sdev
2976 * against clearing.
2978 * LOCKING:
2979 * spin_lock_irqsave(host lock)
2981 * RETURNS:
2982 * 1 if attached SCSI device exists, 0 otherwise.
2984 int ata_scsi_offline_dev(struct ata_device *dev)
2986 if (dev->sdev) {
2987 scsi_device_set_state(dev->sdev, SDEV_OFFLINE);
2988 return 1;
2990 return 0;
2994 * ata_scsi_remove_dev - remove attached SCSI device
2995 * @dev: ATA device to remove attached SCSI device for
2997 * This function is called from ata_eh_scsi_hotplug() and
2998 * responsible for removing the SCSI device attached to @dev.
3000 * LOCKING:
3001 * Kernel thread context (may sleep).
3003 static void ata_scsi_remove_dev(struct ata_device *dev)
3005 struct ata_port *ap = dev->ap;
3006 struct scsi_device *sdev;
3007 unsigned long flags;
3009 /* Alas, we need to grab scan_mutex to ensure SCSI device
3010 * state doesn't change underneath us and thus
3011 * scsi_device_get() always succeeds. The mutex locking can
3012 * be removed if there is __scsi_device_get() interface which
3013 * increments reference counts regardless of device state.
3015 mutex_lock(&ap->scsi_host->scan_mutex);
3016 spin_lock_irqsave(ap->lock, flags);
3018 /* clearing dev->sdev is protected by host lock */
3019 sdev = dev->sdev;
3020 dev->sdev = NULL;
3022 if (sdev) {
3023 /* If user initiated unplug races with us, sdev can go
3024 * away underneath us after the host lock and
3025 * scan_mutex are released. Hold onto it.
3027 if (scsi_device_get(sdev) == 0) {
3028 /* The following ensures the attached sdev is
3029 * offline on return from ata_scsi_offline_dev()
3030 * regardless it wins or loses the race
3031 * against this function.
3033 scsi_device_set_state(sdev, SDEV_OFFLINE);
3034 } else {
3035 WARN_ON(1);
3036 sdev = NULL;
3040 spin_unlock_irqrestore(ap->lock, flags);
3041 mutex_unlock(&ap->scsi_host->scan_mutex);
3043 if (sdev) {
3044 ata_dev_printk(dev, KERN_INFO, "detaching (SCSI %s)\n",
3045 sdev->sdev_gendev.bus_id);
3047 scsi_remove_device(sdev);
3048 scsi_device_put(sdev);
3053 * ata_scsi_hotplug - SCSI part of hotplug
3054 * @work: Pointer to ATA port to perform SCSI hotplug on
3056 * Perform SCSI part of hotplug. It's executed from a separate
3057 * workqueue after EH completes. This is necessary because SCSI
3058 * hot plugging requires working EH and hot unplugging is
3059 * synchronized with hot plugging with a mutex.
3061 * LOCKING:
3062 * Kernel thread context (may sleep).
3064 void ata_scsi_hotplug(struct work_struct *work)
3066 struct ata_port *ap =
3067 container_of(work, struct ata_port, hotplug_task.work);
3068 int i;
3070 if (ap->pflags & ATA_PFLAG_UNLOADING) {
3071 DPRINTK("ENTER/EXIT - unloading\n");
3072 return;
3075 DPRINTK("ENTER\n");
3077 /* unplug detached devices */
3078 for (i = 0; i < ATA_MAX_DEVICES; i++) {
3079 struct ata_device *dev = &ap->device[i];
3080 unsigned long flags;
3082 if (!(dev->flags & ATA_DFLAG_DETACHED))
3083 continue;
3085 spin_lock_irqsave(ap->lock, flags);
3086 dev->flags &= ~ATA_DFLAG_DETACHED;
3087 spin_unlock_irqrestore(ap->lock, flags);
3089 ata_scsi_remove_dev(dev);
3092 /* scan for new ones */
3093 ata_scsi_scan_host(ap);
3095 /* If we scanned while EH was in progress, scan would have
3096 * failed silently. Requeue if there are enabled but
3097 * unattached devices.
3099 for (i = 0; i < ATA_MAX_DEVICES; i++) {
3100 struct ata_device *dev = &ap->device[i];
3101 if (ata_dev_enabled(dev) && !dev->sdev) {
3102 queue_delayed_work(ata_aux_wq, &ap->hotplug_task,
3103 round_jiffies_relative(HZ));
3104 break;
3108 DPRINTK("EXIT\n");
3112 * ata_scsi_user_scan - indication for user-initiated bus scan
3113 * @shost: SCSI host to scan
3114 * @channel: Channel to scan
3115 * @id: ID to scan
3116 * @lun: LUN to scan
3118 * This function is called when user explicitly requests bus
3119 * scan. Set probe pending flag and invoke EH.
3121 * LOCKING:
3122 * SCSI layer (we don't care)
3124 * RETURNS:
3125 * Zero.
3127 static int ata_scsi_user_scan(struct Scsi_Host *shost, unsigned int channel,
3128 unsigned int id, unsigned int lun)
3130 struct ata_port *ap = ata_shost_to_port(shost);
3131 unsigned long flags;
3132 int rc = 0;
3134 if (!ap->ops->error_handler)
3135 return -EOPNOTSUPP;
3137 if ((channel != SCAN_WILD_CARD && channel != 0) ||
3138 (lun != SCAN_WILD_CARD && lun != 0))
3139 return -EINVAL;
3141 spin_lock_irqsave(ap->lock, flags);
3143 if (id == SCAN_WILD_CARD) {
3144 ap->eh_info.probe_mask |= (1 << ATA_MAX_DEVICES) - 1;
3145 ap->eh_info.action |= ATA_EH_SOFTRESET;
3146 } else {
3147 struct ata_device *dev = ata_find_dev(ap, id);
3149 if (dev) {
3150 ap->eh_info.probe_mask |= 1 << dev->devno;
3151 ap->eh_info.action |= ATA_EH_SOFTRESET;
3152 ap->eh_info.flags |= ATA_EHI_RESUME_LINK;
3153 } else
3154 rc = -EINVAL;
3157 if (rc == 0) {
3158 ata_port_schedule_eh(ap);
3159 spin_unlock_irqrestore(ap->lock, flags);
3160 ata_port_wait_eh(ap);
3161 } else
3162 spin_unlock_irqrestore(ap->lock, flags);
3164 return rc;
3168 * ata_scsi_dev_rescan - initiate scsi_rescan_device()
3169 * @work: Pointer to ATA port to perform scsi_rescan_device()
3171 * After ATA pass thru (SAT) commands are executed successfully,
3172 * libata need to propagate the changes to SCSI layer. This
3173 * function must be executed from ata_aux_wq such that sdev
3174 * attach/detach don't race with rescan.
3176 * LOCKING:
3177 * Kernel thread context (may sleep).
3179 void ata_scsi_dev_rescan(struct work_struct *work)
3181 struct ata_port *ap =
3182 container_of(work, struct ata_port, scsi_rescan_task);
3183 unsigned long flags;
3184 unsigned int i;
3186 spin_lock_irqsave(ap->lock, flags);
3188 for (i = 0; i < ATA_MAX_DEVICES; i++) {
3189 struct ata_device *dev = &ap->device[i];
3190 struct scsi_device *sdev = dev->sdev;
3192 if (!ata_dev_enabled(dev) || !sdev)
3193 continue;
3194 if (scsi_device_get(sdev))
3195 continue;
3197 spin_unlock_irqrestore(ap->lock, flags);
3198 scsi_rescan_device(&(sdev->sdev_gendev));
3199 scsi_device_put(sdev);
3200 spin_lock_irqsave(ap->lock, flags);
3203 spin_unlock_irqrestore(ap->lock, flags);
3207 * ata_sas_port_alloc - Allocate port for a SAS attached SATA device
3208 * @host: ATA host container for all SAS ports
3209 * @port_info: Information from low-level host driver
3210 * @shost: SCSI host that the scsi device is attached to
3212 * LOCKING:
3213 * PCI/etc. bus probe sem.
3215 * RETURNS:
3216 * ata_port pointer on success / NULL on failure.
3219 struct ata_port *ata_sas_port_alloc(struct ata_host *host,
3220 struct ata_port_info *port_info,
3221 struct Scsi_Host *shost)
3223 struct ata_port *ap = kzalloc(sizeof(*ap), GFP_KERNEL);
3224 struct ata_probe_ent *ent;
3226 if (!ap)
3227 return NULL;
3229 ent = ata_probe_ent_alloc(host->dev, port_info);
3230 if (!ent) {
3231 kfree(ap);
3232 return NULL;
3235 ata_port_init(ap, host, ent, 0);
3236 ap->lock = shost->host_lock;
3237 kfree(ent);
3238 return ap;
3240 EXPORT_SYMBOL_GPL(ata_sas_port_alloc);
3243 * ata_sas_port_start - Set port up for dma.
3244 * @ap: Port to initialize
3246 * Called just after data structures for each port are
3247 * initialized. Allocates DMA pad.
3249 * May be used as the port_start() entry in ata_port_operations.
3251 * LOCKING:
3252 * Inherited from caller.
3254 int ata_sas_port_start(struct ata_port *ap)
3256 return ata_pad_alloc(ap, ap->dev);
3258 EXPORT_SYMBOL_GPL(ata_sas_port_start);
3261 * ata_port_stop - Undo ata_sas_port_start()
3262 * @ap: Port to shut down
3264 * Frees the DMA pad.
3266 * May be used as the port_stop() entry in ata_port_operations.
3268 * LOCKING:
3269 * Inherited from caller.
3272 void ata_sas_port_stop(struct ata_port *ap)
3274 ata_pad_free(ap, ap->dev);
3276 EXPORT_SYMBOL_GPL(ata_sas_port_stop);
3279 * ata_sas_port_init - Initialize a SATA device
3280 * @ap: SATA port to initialize
3282 * LOCKING:
3283 * PCI/etc. bus probe sem.
3285 * RETURNS:
3286 * Zero on success, non-zero on error.
3289 int ata_sas_port_init(struct ata_port *ap)
3291 int rc = ap->ops->port_start(ap);
3293 if (!rc)
3294 rc = ata_bus_probe(ap);
3296 return rc;
3298 EXPORT_SYMBOL_GPL(ata_sas_port_init);
3301 * ata_sas_port_destroy - Destroy a SATA port allocated by ata_sas_port_alloc
3302 * @ap: SATA port to destroy
3306 void ata_sas_port_destroy(struct ata_port *ap)
3308 if (ap->ops->port_stop)
3309 ap->ops->port_stop(ap);
3310 kfree(ap);
3312 EXPORT_SYMBOL_GPL(ata_sas_port_destroy);
3315 * ata_sas_slave_configure - Default slave_config routine for libata devices
3316 * @sdev: SCSI device to configure
3317 * @ap: ATA port to which SCSI device is attached
3319 * RETURNS:
3320 * Zero.
3323 int ata_sas_slave_configure(struct scsi_device *sdev, struct ata_port *ap)
3325 ata_scsi_sdev_config(sdev);
3326 ata_scsi_dev_config(sdev, ap->device);
3327 return 0;
3329 EXPORT_SYMBOL_GPL(ata_sas_slave_configure);
3332 * ata_sas_queuecmd - Issue SCSI cdb to libata-managed device
3333 * @cmd: SCSI command to be sent
3334 * @done: Completion function, called when command is complete
3335 * @ap: ATA port to which the command is being sent
3337 * RETURNS:
3338 * Return value from __ata_scsi_queuecmd() if @cmd can be queued,
3339 * 0 otherwise.
3342 int ata_sas_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *),
3343 struct ata_port *ap)
3345 int rc = 0;
3347 ata_scsi_dump_cdb(ap, cmd);
3349 if (likely(ata_scsi_dev_enabled(ap->device)))
3350 rc = __ata_scsi_queuecmd(cmd, done, ap->device);
3351 else {
3352 cmd->result = (DID_BAD_TARGET << 16);
3353 done(cmd);
3355 return rc;
3357 EXPORT_SYMBOL_GPL(ata_sas_queuecmd);