libata: fix probe_ent alloc/free bugs
[linux-2.6/mini2440.git] / drivers / ata / libata-scsi.c
blob7bb782b5ce0c5ae8bc86380cb654055023e8349c
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[13] = args[6] & 0x0f;
337 scsi_cmd[14] = args[0];
339 /* Good values for timeout and retries? Values below
340 from scsi_ioctl_send_command() for default case... */
341 cmd_result = scsi_execute(scsidev, scsi_cmd, DMA_NONE, NULL, 0,
342 sensebuf, (10*HZ), 5, 0);
344 if (driver_byte(cmd_result) == DRIVER_SENSE) {/* sense data available */
345 u8 *desc = sensebuf + 8;
346 cmd_result &= ~(0xFF<<24); /* DRIVER_SENSE is not an error */
348 /* If we set cc then ATA pass-through will cause a
349 * check condition even if no error. Filter that. */
350 if (cmd_result & SAM_STAT_CHECK_CONDITION) {
351 struct scsi_sense_hdr sshdr;
352 scsi_normalize_sense(sensebuf, SCSI_SENSE_BUFFERSIZE,
353 &sshdr);
354 if (sshdr.sense_key==0 &&
355 sshdr.asc==0 && sshdr.ascq==0)
356 cmd_result &= ~SAM_STAT_CHECK_CONDITION;
359 /* Send userspace ATA registers */
360 if (sensebuf[0] == 0x72 && /* format is "descriptor" */
361 desc[0] == 0x09) {/* code is "ATA Descriptor" */
362 args[0] = desc[13]; /* status */
363 args[1] = desc[3]; /* error */
364 args[2] = desc[5]; /* sector count (0:7) */
365 args[3] = desc[7]; /* lbal */
366 args[4] = desc[9]; /* lbam */
367 args[5] = desc[11]; /* lbah */
368 args[6] = desc[12]; /* select */
369 if (copy_to_user(arg, args, sizeof(args)))
370 rc = -EFAULT;
374 if (cmd_result) {
375 rc = -EIO;
376 goto error;
379 error:
380 kfree(sensebuf);
381 return rc;
384 int ata_scsi_ioctl(struct scsi_device *scsidev, int cmd, void __user *arg)
386 int val = -EINVAL, rc = -EINVAL;
388 switch (cmd) {
389 case ATA_IOC_GET_IO32:
390 val = 0;
391 if (copy_to_user(arg, &val, 1))
392 return -EFAULT;
393 return 0;
395 case ATA_IOC_SET_IO32:
396 val = (unsigned long) arg;
397 if (val != 0)
398 return -EINVAL;
399 return 0;
401 case HDIO_GET_IDENTITY:
402 return ata_get_identity(scsidev, arg);
404 case HDIO_DRIVE_CMD:
405 if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
406 return -EACCES;
407 return ata_cmd_ioctl(scsidev, arg);
409 case HDIO_DRIVE_TASK:
410 if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
411 return -EACCES;
412 return ata_task_ioctl(scsidev, arg);
414 default:
415 rc = -ENOTTY;
416 break;
419 return rc;
423 * ata_scsi_qc_new - acquire new ata_queued_cmd reference
424 * @dev: ATA device to which the new command is attached
425 * @cmd: SCSI command that originated this ATA command
426 * @done: SCSI command completion function
428 * Obtain a reference to an unused ata_queued_cmd structure,
429 * which is the basic libata structure representing a single
430 * ATA command sent to the hardware.
432 * If a command was available, fill in the SCSI-specific
433 * portions of the structure with information on the
434 * current command.
436 * LOCKING:
437 * spin_lock_irqsave(host lock)
439 * RETURNS:
440 * Command allocated, or %NULL if none available.
442 static struct ata_queued_cmd *ata_scsi_qc_new(struct ata_device *dev,
443 struct scsi_cmnd *cmd,
444 void (*done)(struct scsi_cmnd *))
446 struct ata_queued_cmd *qc;
448 qc = ata_qc_new_init(dev);
449 if (qc) {
450 qc->scsicmd = cmd;
451 qc->scsidone = done;
453 if (cmd->use_sg) {
454 qc->__sg = (struct scatterlist *) cmd->request_buffer;
455 qc->n_elem = cmd->use_sg;
456 } else if (cmd->request_bufflen) {
457 qc->__sg = &qc->sgent;
458 qc->n_elem = 1;
460 } else {
461 cmd->result = (DID_OK << 16) | (QUEUE_FULL << 1);
462 done(cmd);
465 return qc;
469 * ata_dump_status - user friendly display of error info
470 * @id: id of the port in question
471 * @tf: ptr to filled out taskfile
473 * Decode and dump the ATA error/status registers for the user so
474 * that they have some idea what really happened at the non
475 * make-believe layer.
477 * LOCKING:
478 * inherited from caller
480 static void ata_dump_status(unsigned id, struct ata_taskfile *tf)
482 u8 stat = tf->command, err = tf->feature;
484 printk(KERN_WARNING "ata%u: status=0x%02x { ", id, stat);
485 if (stat & ATA_BUSY) {
486 printk("Busy }\n"); /* Data is not valid in this case */
487 } else {
488 if (stat & 0x40) printk("DriveReady ");
489 if (stat & 0x20) printk("DeviceFault ");
490 if (stat & 0x10) printk("SeekComplete ");
491 if (stat & 0x08) printk("DataRequest ");
492 if (stat & 0x04) printk("CorrectedError ");
493 if (stat & 0x02) printk("Index ");
494 if (stat & 0x01) printk("Error ");
495 printk("}\n");
497 if (err) {
498 printk(KERN_WARNING "ata%u: error=0x%02x { ", id, err);
499 if (err & 0x04) printk("DriveStatusError ");
500 if (err & 0x80) {
501 if (err & 0x04) printk("BadCRC ");
502 else printk("Sector ");
504 if (err & 0x40) printk("UncorrectableError ");
505 if (err & 0x10) printk("SectorIdNotFound ");
506 if (err & 0x02) printk("TrackZeroNotFound ");
507 if (err & 0x01) printk("AddrMarkNotFound ");
508 printk("}\n");
514 * ata_scsi_device_suspend - suspend ATA device associated with sdev
515 * @sdev: the SCSI device to suspend
516 * @mesg: target power management message
518 * Request suspend EH action on the ATA device associated with
519 * @sdev and wait for the operation to complete.
521 * LOCKING:
522 * Kernel thread context (may sleep).
524 * RETURNS:
525 * 0 on success, -errno otherwise.
527 int ata_scsi_device_suspend(struct scsi_device *sdev, pm_message_t mesg)
529 struct ata_port *ap = ata_shost_to_port(sdev->host);
530 struct ata_device *dev = ata_scsi_find_dev(ap, sdev);
531 unsigned long flags;
532 unsigned int action;
533 int rc = 0;
535 if (!dev)
536 goto out;
538 spin_lock_irqsave(ap->lock, flags);
540 /* wait for the previous resume to complete */
541 while (dev->flags & ATA_DFLAG_SUSPENDED) {
542 spin_unlock_irqrestore(ap->lock, flags);
543 ata_port_wait_eh(ap);
544 spin_lock_irqsave(ap->lock, flags);
547 /* if @sdev is already detached, nothing to do */
548 if (sdev->sdev_state == SDEV_OFFLINE ||
549 sdev->sdev_state == SDEV_CANCEL || sdev->sdev_state == SDEV_DEL)
550 goto out_unlock;
552 /* request suspend */
553 action = ATA_EH_SUSPEND;
554 if (mesg.event != PM_EVENT_SUSPEND)
555 action |= ATA_EH_PM_FREEZE;
556 ap->eh_info.dev_action[dev->devno] |= action;
557 ap->eh_info.flags |= ATA_EHI_QUIET;
558 ata_port_schedule_eh(ap);
560 spin_unlock_irqrestore(ap->lock, flags);
562 /* wait for EH to do the job */
563 ata_port_wait_eh(ap);
565 spin_lock_irqsave(ap->lock, flags);
567 /* If @sdev is still attached but the associated ATA device
568 * isn't suspended, the operation failed.
570 if (sdev->sdev_state != SDEV_OFFLINE &&
571 sdev->sdev_state != SDEV_CANCEL && sdev->sdev_state != SDEV_DEL &&
572 !(dev->flags & ATA_DFLAG_SUSPENDED))
573 rc = -EIO;
575 out_unlock:
576 spin_unlock_irqrestore(ap->lock, flags);
577 out:
578 if (rc == 0)
579 sdev->sdev_gendev.power.power_state = mesg;
580 return rc;
584 * ata_scsi_device_resume - resume ATA device associated with sdev
585 * @sdev: the SCSI device to resume
587 * Request resume EH action on the ATA device associated with
588 * @sdev and return immediately. This enables parallel
589 * wakeup/spinup of devices.
591 * LOCKING:
592 * Kernel thread context (may sleep).
594 * RETURNS:
595 * 0.
597 int ata_scsi_device_resume(struct scsi_device *sdev)
599 struct ata_port *ap = ata_shost_to_port(sdev->host);
600 struct ata_device *dev = ata_scsi_find_dev(ap, sdev);
601 struct ata_eh_info *ehi = &ap->eh_info;
602 unsigned long flags;
603 unsigned int action;
605 if (!dev)
606 goto out;
608 spin_lock_irqsave(ap->lock, flags);
610 /* if @sdev is already detached, nothing to do */
611 if (sdev->sdev_state == SDEV_OFFLINE ||
612 sdev->sdev_state == SDEV_CANCEL || sdev->sdev_state == SDEV_DEL)
613 goto out_unlock;
615 /* request resume */
616 action = ATA_EH_RESUME;
617 if (sdev->sdev_gendev.power.power_state.event == PM_EVENT_SUSPEND)
618 __ata_ehi_hotplugged(ehi);
619 else
620 action |= ATA_EH_PM_FREEZE | ATA_EH_SOFTRESET;
621 ehi->dev_action[dev->devno] |= action;
623 /* We don't want autopsy and verbose EH messages. Disable
624 * those if we're the only device on this link.
626 if (ata_port_max_devices(ap) == 1)
627 ehi->flags |= ATA_EHI_NO_AUTOPSY | ATA_EHI_QUIET;
629 ata_port_schedule_eh(ap);
631 out_unlock:
632 spin_unlock_irqrestore(ap->lock, flags);
633 out:
634 sdev->sdev_gendev.power.power_state = PMSG_ON;
635 return 0;
639 * ata_to_sense_error - convert ATA error to SCSI error
640 * @id: ATA device number
641 * @drv_stat: value contained in ATA status register
642 * @drv_err: value contained in ATA error register
643 * @sk: the sense key we'll fill out
644 * @asc: the additional sense code we'll fill out
645 * @ascq: the additional sense code qualifier we'll fill out
646 * @verbose: be verbose
648 * Converts an ATA error into a SCSI error. Fill out pointers to
649 * SK, ASC, and ASCQ bytes for later use in fixed or descriptor
650 * format sense blocks.
652 * LOCKING:
653 * spin_lock_irqsave(host lock)
655 static void ata_to_sense_error(unsigned id, u8 drv_stat, u8 drv_err, u8 *sk,
656 u8 *asc, u8 *ascq, int verbose)
658 int i;
660 /* Based on the 3ware driver translation table */
661 static const unsigned char sense_table[][4] = {
662 /* BBD|ECC|ID|MAR */
663 {0xd1, ABORTED_COMMAND, 0x00, 0x00}, // Device busy Aborted command
664 /* BBD|ECC|ID */
665 {0xd0, ABORTED_COMMAND, 0x00, 0x00}, // Device busy Aborted command
666 /* ECC|MC|MARK */
667 {0x61, HARDWARE_ERROR, 0x00, 0x00}, // Device fault Hardware error
668 /* ICRC|ABRT */ /* NB: ICRC & !ABRT is BBD */
669 {0x84, ABORTED_COMMAND, 0x47, 0x00}, // Data CRC error SCSI parity error
670 /* MC|ID|ABRT|TRK0|MARK */
671 {0x37, NOT_READY, 0x04, 0x00}, // Unit offline Not ready
672 /* MCR|MARK */
673 {0x09, NOT_READY, 0x04, 0x00}, // Unrecovered disk error Not ready
674 /* Bad address mark */
675 {0x01, MEDIUM_ERROR, 0x13, 0x00}, // Address mark not found Address mark not found for data field
676 /* TRK0 */
677 {0x02, HARDWARE_ERROR, 0x00, 0x00}, // Track 0 not found Hardware error
678 /* Abort & !ICRC */
679 {0x04, ABORTED_COMMAND, 0x00, 0x00}, // Aborted command Aborted command
680 /* Media change request */
681 {0x08, NOT_READY, 0x04, 0x00}, // Media change request FIXME: faking offline
682 /* SRV */
683 {0x10, ABORTED_COMMAND, 0x14, 0x00}, // ID not found Recorded entity not found
684 /* Media change */
685 {0x08, NOT_READY, 0x04, 0x00}, // Media change FIXME: faking offline
686 /* ECC */
687 {0x40, MEDIUM_ERROR, 0x11, 0x04}, // Uncorrectable ECC error Unrecovered read error
688 /* BBD - block marked bad */
689 {0x80, MEDIUM_ERROR, 0x11, 0x04}, // Block marked bad Medium error, unrecovered read error
690 {0xFF, 0xFF, 0xFF, 0xFF}, // END mark
692 static const unsigned char stat_table[][4] = {
693 /* Must be first because BUSY means no other bits valid */
694 {0x80, ABORTED_COMMAND, 0x47, 0x00}, // Busy, fake parity for now
695 {0x20, HARDWARE_ERROR, 0x00, 0x00}, // Device fault
696 {0x08, ABORTED_COMMAND, 0x47, 0x00}, // Timed out in xfer, fake parity for now
697 {0x04, RECOVERED_ERROR, 0x11, 0x00}, // Recovered ECC error Medium error, recovered
698 {0xFF, 0xFF, 0xFF, 0xFF}, // END mark
702 * Is this an error we can process/parse
704 if (drv_stat & ATA_BUSY) {
705 drv_err = 0; /* Ignore the err bits, they're invalid */
708 if (drv_err) {
709 /* Look for drv_err */
710 for (i = 0; sense_table[i][0] != 0xFF; i++) {
711 /* Look for best matches first */
712 if ((sense_table[i][0] & drv_err) ==
713 sense_table[i][0]) {
714 *sk = sense_table[i][1];
715 *asc = sense_table[i][2];
716 *ascq = sense_table[i][3];
717 goto translate_done;
720 /* No immediate match */
721 if (verbose)
722 printk(KERN_WARNING "ata%u: no sense translation for "
723 "error 0x%02x\n", id, drv_err);
726 /* Fall back to interpreting status bits */
727 for (i = 0; stat_table[i][0] != 0xFF; i++) {
728 if (stat_table[i][0] & drv_stat) {
729 *sk = stat_table[i][1];
730 *asc = stat_table[i][2];
731 *ascq = stat_table[i][3];
732 goto translate_done;
735 /* No error? Undecoded? */
736 if (verbose)
737 printk(KERN_WARNING "ata%u: no sense translation for "
738 "status: 0x%02x\n", id, drv_stat);
740 /* We need a sensible error return here, which is tricky, and one
741 that won't cause people to do things like return a disk wrongly */
742 *sk = ABORTED_COMMAND;
743 *asc = 0x00;
744 *ascq = 0x00;
746 translate_done:
747 if (verbose)
748 printk(KERN_ERR "ata%u: translated ATA stat/err 0x%02x/%02x "
749 "to SCSI SK/ASC/ASCQ 0x%x/%02x/%02x\n",
750 id, drv_stat, drv_err, *sk, *asc, *ascq);
751 return;
755 * ata_gen_passthru_sense - Generate check condition sense block.
756 * @qc: Command that completed.
758 * This function is specific to the ATA descriptor format sense
759 * block specified for the ATA pass through commands. Regardless
760 * of whether the command errored or not, return a sense
761 * block. Copy all controller registers into the sense
762 * block. Clear sense key, ASC & ASCQ if there is no error.
764 * LOCKING:
765 * None.
767 static void ata_gen_passthru_sense(struct ata_queued_cmd *qc)
769 struct scsi_cmnd *cmd = qc->scsicmd;
770 struct ata_taskfile *tf = &qc->result_tf;
771 unsigned char *sb = cmd->sense_buffer;
772 unsigned char *desc = sb + 8;
773 int verbose = qc->ap->ops->error_handler == NULL;
775 memset(sb, 0, SCSI_SENSE_BUFFERSIZE);
777 cmd->result = (DRIVER_SENSE << 24) | SAM_STAT_CHECK_CONDITION;
780 * Use ata_to_sense_error() to map status register bits
781 * onto sense key, asc & ascq.
783 if (qc->err_mask ||
784 tf->command & (ATA_BUSY | ATA_DF | ATA_ERR | ATA_DRQ)) {
785 ata_to_sense_error(qc->ap->id, tf->command, tf->feature,
786 &sb[1], &sb[2], &sb[3], verbose);
787 sb[1] &= 0x0f;
791 * Sense data is current and format is descriptor.
793 sb[0] = 0x72;
795 desc[0] = 0x09;
797 /* set length of additional sense data */
798 sb[7] = 14;
799 desc[1] = 12;
802 * Copy registers into sense buffer.
804 desc[2] = 0x00;
805 desc[3] = tf->feature; /* == error reg */
806 desc[5] = tf->nsect;
807 desc[7] = tf->lbal;
808 desc[9] = tf->lbam;
809 desc[11] = tf->lbah;
810 desc[12] = tf->device;
811 desc[13] = tf->command; /* == status reg */
814 * Fill in Extend bit, and the high order bytes
815 * if applicable.
817 if (tf->flags & ATA_TFLAG_LBA48) {
818 desc[2] |= 0x01;
819 desc[4] = tf->hob_nsect;
820 desc[6] = tf->hob_lbal;
821 desc[8] = tf->hob_lbam;
822 desc[10] = tf->hob_lbah;
827 * ata_gen_ata_sense - generate a SCSI fixed sense block
828 * @qc: Command that we are erroring out
830 * Generate sense block for a failed ATA command @qc. Descriptor
831 * format is used to accomodate LBA48 block address.
833 * LOCKING:
834 * None.
836 static void ata_gen_ata_sense(struct ata_queued_cmd *qc)
838 struct ata_device *dev = qc->dev;
839 struct scsi_cmnd *cmd = qc->scsicmd;
840 struct ata_taskfile *tf = &qc->result_tf;
841 unsigned char *sb = cmd->sense_buffer;
842 unsigned char *desc = sb + 8;
843 int verbose = qc->ap->ops->error_handler == NULL;
844 u64 block;
846 memset(sb, 0, SCSI_SENSE_BUFFERSIZE);
848 cmd->result = (DRIVER_SENSE << 24) | SAM_STAT_CHECK_CONDITION;
850 /* sense data is current and format is descriptor */
851 sb[0] = 0x72;
853 /* Use ata_to_sense_error() to map status register bits
854 * onto sense key, asc & ascq.
856 if (qc->err_mask ||
857 tf->command & (ATA_BUSY | ATA_DF | ATA_ERR | ATA_DRQ)) {
858 ata_to_sense_error(qc->ap->id, tf->command, tf->feature,
859 &sb[1], &sb[2], &sb[3], verbose);
860 sb[1] &= 0x0f;
863 block = ata_tf_read_block(&qc->result_tf, dev);
865 /* information sense data descriptor */
866 sb[7] = 12;
867 desc[0] = 0x00;
868 desc[1] = 10;
870 desc[2] |= 0x80; /* valid */
871 desc[6] = block >> 40;
872 desc[7] = block >> 32;
873 desc[8] = block >> 24;
874 desc[9] = block >> 16;
875 desc[10] = block >> 8;
876 desc[11] = block;
879 static void ata_scsi_sdev_config(struct scsi_device *sdev)
881 sdev->use_10_for_rw = 1;
882 sdev->use_10_for_ms = 1;
885 static void ata_scsi_dev_config(struct scsi_device *sdev,
886 struct ata_device *dev)
888 /* configure max sectors */
889 blk_queue_max_sectors(sdev->request_queue, dev->max_sectors);
891 /* SATA DMA transfers must be multiples of 4 byte, so
892 * we need to pad ATAPI transfers using an extra sg.
893 * Decrement max hw segments accordingly.
895 if (dev->class == ATA_DEV_ATAPI) {
896 request_queue_t *q = sdev->request_queue;
897 blk_queue_max_hw_segments(q, q->max_hw_segments - 1);
900 if (dev->flags & ATA_DFLAG_NCQ) {
901 int depth;
903 depth = min(sdev->host->can_queue, ata_id_queue_depth(dev->id));
904 depth = min(ATA_MAX_QUEUE - 1, depth);
905 scsi_adjust_queue_depth(sdev, MSG_SIMPLE_TAG, depth);
910 * ata_scsi_slave_config - Set SCSI device attributes
911 * @sdev: SCSI device to examine
913 * This is called before we actually start reading
914 * and writing to the device, to configure certain
915 * SCSI mid-layer behaviors.
917 * LOCKING:
918 * Defined by SCSI layer. We don't really care.
921 int ata_scsi_slave_config(struct scsi_device *sdev)
923 struct ata_port *ap = ata_shost_to_port(sdev->host);
924 struct ata_device *dev = __ata_scsi_find_dev(ap, sdev);
926 ata_scsi_sdev_config(sdev);
928 blk_queue_max_phys_segments(sdev->request_queue, LIBATA_MAX_PRD);
930 if (dev)
931 ata_scsi_dev_config(sdev, dev);
933 return 0; /* scsi layer doesn't check return value, sigh */
937 * ata_scsi_slave_destroy - SCSI device is about to be destroyed
938 * @sdev: SCSI device to be destroyed
940 * @sdev is about to be destroyed for hot/warm unplugging. If
941 * this unplugging was initiated by libata as indicated by NULL
942 * dev->sdev, this function doesn't have to do anything.
943 * Otherwise, SCSI layer initiated warm-unplug is in progress.
944 * Clear dev->sdev, schedule the device for ATA detach and invoke
945 * EH.
947 * LOCKING:
948 * Defined by SCSI layer. We don't really care.
950 void ata_scsi_slave_destroy(struct scsi_device *sdev)
952 struct ata_port *ap = ata_shost_to_port(sdev->host);
953 unsigned long flags;
954 struct ata_device *dev;
956 if (!ap->ops->error_handler)
957 return;
959 spin_lock_irqsave(ap->lock, flags);
960 dev = __ata_scsi_find_dev(ap, sdev);
961 if (dev && dev->sdev) {
962 /* SCSI device already in CANCEL state, no need to offline it */
963 dev->sdev = NULL;
964 dev->flags |= ATA_DFLAG_DETACH;
965 ata_port_schedule_eh(ap);
967 spin_unlock_irqrestore(ap->lock, flags);
971 * ata_scsi_change_queue_depth - SCSI callback for queue depth config
972 * @sdev: SCSI device to configure queue depth for
973 * @queue_depth: new queue depth
975 * This is libata standard hostt->change_queue_depth callback.
976 * SCSI will call into this callback when user tries to set queue
977 * depth via sysfs.
979 * LOCKING:
980 * SCSI layer (we don't care)
982 * RETURNS:
983 * Newly configured queue depth.
985 int ata_scsi_change_queue_depth(struct scsi_device *sdev, int queue_depth)
987 struct ata_port *ap = ata_shost_to_port(sdev->host);
988 struct ata_device *dev;
989 unsigned long flags;
990 int max_depth;
992 if (queue_depth < 1)
993 return sdev->queue_depth;
995 dev = ata_scsi_find_dev(ap, sdev);
996 if (!dev || !ata_dev_enabled(dev))
997 return sdev->queue_depth;
999 max_depth = min(sdev->host->can_queue, ata_id_queue_depth(dev->id));
1000 max_depth = min(ATA_MAX_QUEUE - 1, max_depth);
1001 if (queue_depth > max_depth)
1002 queue_depth = max_depth;
1004 scsi_adjust_queue_depth(sdev, MSG_SIMPLE_TAG, queue_depth);
1006 spin_lock_irqsave(ap->lock, flags);
1007 if (queue_depth > 1)
1008 dev->flags &= ~ATA_DFLAG_NCQ_OFF;
1009 else
1010 dev->flags |= ATA_DFLAG_NCQ_OFF;
1011 spin_unlock_irqrestore(ap->lock, flags);
1013 return queue_depth;
1017 * ata_scsi_start_stop_xlat - Translate SCSI START STOP UNIT command
1018 * @qc: Storage for translated ATA taskfile
1020 * Sets up an ATA taskfile to issue STANDBY (to stop) or READ VERIFY
1021 * (to start). Perhaps these commands should be preceded by
1022 * CHECK POWER MODE to see what power mode the device is already in.
1023 * [See SAT revision 5 at www.t10.org]
1025 * LOCKING:
1026 * spin_lock_irqsave(host lock)
1028 * RETURNS:
1029 * Zero on success, non-zero on error.
1031 static unsigned int ata_scsi_start_stop_xlat(struct ata_queued_cmd *qc)
1033 struct scsi_cmnd *scmd = qc->scsicmd;
1034 struct ata_taskfile *tf = &qc->tf;
1035 const u8 *cdb = scmd->cmnd;
1037 if (scmd->cmd_len < 5)
1038 goto invalid_fld;
1040 tf->flags |= ATA_TFLAG_DEVICE | ATA_TFLAG_ISADDR;
1041 tf->protocol = ATA_PROT_NODATA;
1042 if (cdb[1] & 0x1) {
1043 ; /* ignore IMMED bit, violates sat-r05 */
1045 if (cdb[4] & 0x2)
1046 goto invalid_fld; /* LOEJ bit set not supported */
1047 if (((cdb[4] >> 4) & 0xf) != 0)
1048 goto invalid_fld; /* power conditions not supported */
1049 if (cdb[4] & 0x1) {
1050 tf->nsect = 1; /* 1 sector, lba=0 */
1052 if (qc->dev->flags & ATA_DFLAG_LBA) {
1053 tf->flags |= ATA_TFLAG_LBA;
1055 tf->lbah = 0x0;
1056 tf->lbam = 0x0;
1057 tf->lbal = 0x0;
1058 tf->device |= ATA_LBA;
1059 } else {
1060 /* CHS */
1061 tf->lbal = 0x1; /* sect */
1062 tf->lbam = 0x0; /* cyl low */
1063 tf->lbah = 0x0; /* cyl high */
1066 tf->command = ATA_CMD_VERIFY; /* READ VERIFY */
1067 } else
1068 /* Issue ATA STANDBY IMMEDIATE command */
1069 tf->command = ATA_CMD_STANDBYNOW1;
1072 * Standby and Idle condition timers could be implemented but that
1073 * would require libata to implement the Power condition mode page
1074 * and allow the user to change it. Changing mode pages requires
1075 * MODE SELECT to be implemented.
1078 return 0;
1080 invalid_fld:
1081 ata_scsi_set_sense(scmd, ILLEGAL_REQUEST, 0x24, 0x0);
1082 /* "Invalid field in cbd" */
1083 return 1;
1088 * ata_scsi_flush_xlat - Translate SCSI SYNCHRONIZE CACHE command
1089 * @qc: Storage for translated ATA taskfile
1091 * Sets up an ATA taskfile to issue FLUSH CACHE or
1092 * FLUSH CACHE EXT.
1094 * LOCKING:
1095 * spin_lock_irqsave(host lock)
1097 * RETURNS:
1098 * Zero on success, non-zero on error.
1100 static unsigned int ata_scsi_flush_xlat(struct ata_queued_cmd *qc)
1102 struct ata_taskfile *tf = &qc->tf;
1104 tf->flags |= ATA_TFLAG_DEVICE;
1105 tf->protocol = ATA_PROT_NODATA;
1107 if (qc->dev->flags & ATA_DFLAG_FLUSH_EXT)
1108 tf->command = ATA_CMD_FLUSH_EXT;
1109 else
1110 tf->command = ATA_CMD_FLUSH;
1112 return 0;
1116 * scsi_6_lba_len - Get LBA and transfer length
1117 * @cdb: SCSI command to translate
1119 * Calculate LBA and transfer length for 6-byte commands.
1121 * RETURNS:
1122 * @plba: the LBA
1123 * @plen: the transfer length
1125 static void scsi_6_lba_len(const u8 *cdb, u64 *plba, u32 *plen)
1127 u64 lba = 0;
1128 u32 len = 0;
1130 VPRINTK("six-byte command\n");
1132 lba |= ((u64)cdb[2]) << 8;
1133 lba |= ((u64)cdb[3]);
1135 len |= ((u32)cdb[4]);
1137 *plba = lba;
1138 *plen = len;
1142 * scsi_10_lba_len - Get LBA and transfer length
1143 * @cdb: SCSI command to translate
1145 * Calculate LBA and transfer length for 10-byte commands.
1147 * RETURNS:
1148 * @plba: the LBA
1149 * @plen: the transfer length
1151 static void scsi_10_lba_len(const u8 *cdb, u64 *plba, u32 *plen)
1153 u64 lba = 0;
1154 u32 len = 0;
1156 VPRINTK("ten-byte command\n");
1158 lba |= ((u64)cdb[2]) << 24;
1159 lba |= ((u64)cdb[3]) << 16;
1160 lba |= ((u64)cdb[4]) << 8;
1161 lba |= ((u64)cdb[5]);
1163 len |= ((u32)cdb[7]) << 8;
1164 len |= ((u32)cdb[8]);
1166 *plba = lba;
1167 *plen = len;
1171 * scsi_16_lba_len - Get LBA and transfer length
1172 * @cdb: SCSI command to translate
1174 * Calculate LBA and transfer length for 16-byte commands.
1176 * RETURNS:
1177 * @plba: the LBA
1178 * @plen: the transfer length
1180 static void scsi_16_lba_len(const u8 *cdb, u64 *plba, u32 *plen)
1182 u64 lba = 0;
1183 u32 len = 0;
1185 VPRINTK("sixteen-byte command\n");
1187 lba |= ((u64)cdb[2]) << 56;
1188 lba |= ((u64)cdb[3]) << 48;
1189 lba |= ((u64)cdb[4]) << 40;
1190 lba |= ((u64)cdb[5]) << 32;
1191 lba |= ((u64)cdb[6]) << 24;
1192 lba |= ((u64)cdb[7]) << 16;
1193 lba |= ((u64)cdb[8]) << 8;
1194 lba |= ((u64)cdb[9]);
1196 len |= ((u32)cdb[10]) << 24;
1197 len |= ((u32)cdb[11]) << 16;
1198 len |= ((u32)cdb[12]) << 8;
1199 len |= ((u32)cdb[13]);
1201 *plba = lba;
1202 *plen = len;
1206 * ata_scsi_verify_xlat - Translate SCSI VERIFY command into an ATA one
1207 * @qc: Storage for translated ATA taskfile
1209 * Converts SCSI VERIFY command to an ATA READ VERIFY command.
1211 * LOCKING:
1212 * spin_lock_irqsave(host lock)
1214 * RETURNS:
1215 * Zero on success, non-zero on error.
1217 static unsigned int ata_scsi_verify_xlat(struct ata_queued_cmd *qc)
1219 struct scsi_cmnd *scmd = qc->scsicmd;
1220 struct ata_taskfile *tf = &qc->tf;
1221 struct ata_device *dev = qc->dev;
1222 u64 dev_sectors = qc->dev->n_sectors;
1223 const u8 *cdb = scmd->cmnd;
1224 u64 block;
1225 u32 n_block;
1227 tf->flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
1228 tf->protocol = ATA_PROT_NODATA;
1230 if (cdb[0] == VERIFY) {
1231 if (scmd->cmd_len < 10)
1232 goto invalid_fld;
1233 scsi_10_lba_len(cdb, &block, &n_block);
1234 } else if (cdb[0] == VERIFY_16) {
1235 if (scmd->cmd_len < 16)
1236 goto invalid_fld;
1237 scsi_16_lba_len(cdb, &block, &n_block);
1238 } else
1239 goto invalid_fld;
1241 if (!n_block)
1242 goto nothing_to_do;
1243 if (block >= dev_sectors)
1244 goto out_of_range;
1245 if ((block + n_block) > dev_sectors)
1246 goto out_of_range;
1248 if (dev->flags & ATA_DFLAG_LBA) {
1249 tf->flags |= ATA_TFLAG_LBA;
1251 if (lba_28_ok(block, n_block)) {
1252 /* use LBA28 */
1253 tf->command = ATA_CMD_VERIFY;
1254 tf->device |= (block >> 24) & 0xf;
1255 } else if (lba_48_ok(block, n_block)) {
1256 if (!(dev->flags & ATA_DFLAG_LBA48))
1257 goto out_of_range;
1259 /* use LBA48 */
1260 tf->flags |= ATA_TFLAG_LBA48;
1261 tf->command = ATA_CMD_VERIFY_EXT;
1263 tf->hob_nsect = (n_block >> 8) & 0xff;
1265 tf->hob_lbah = (block >> 40) & 0xff;
1266 tf->hob_lbam = (block >> 32) & 0xff;
1267 tf->hob_lbal = (block >> 24) & 0xff;
1268 } else
1269 /* request too large even for LBA48 */
1270 goto out_of_range;
1272 tf->nsect = n_block & 0xff;
1274 tf->lbah = (block >> 16) & 0xff;
1275 tf->lbam = (block >> 8) & 0xff;
1276 tf->lbal = block & 0xff;
1278 tf->device |= ATA_LBA;
1279 } else {
1280 /* CHS */
1281 u32 sect, head, cyl, track;
1283 if (!lba_28_ok(block, n_block))
1284 goto out_of_range;
1286 /* Convert LBA to CHS */
1287 track = (u32)block / dev->sectors;
1288 cyl = track / dev->heads;
1289 head = track % dev->heads;
1290 sect = (u32)block % dev->sectors + 1;
1292 DPRINTK("block %u track %u cyl %u head %u sect %u\n",
1293 (u32)block, track, cyl, head, sect);
1295 /* Check whether the converted CHS can fit.
1296 Cylinder: 0-65535
1297 Head: 0-15
1298 Sector: 1-255*/
1299 if ((cyl >> 16) || (head >> 4) || (sect >> 8) || (!sect))
1300 goto out_of_range;
1302 tf->command = ATA_CMD_VERIFY;
1303 tf->nsect = n_block & 0xff; /* Sector count 0 means 256 sectors */
1304 tf->lbal = sect;
1305 tf->lbam = cyl;
1306 tf->lbah = cyl >> 8;
1307 tf->device |= head;
1310 return 0;
1312 invalid_fld:
1313 ata_scsi_set_sense(scmd, ILLEGAL_REQUEST, 0x24, 0x0);
1314 /* "Invalid field in cbd" */
1315 return 1;
1317 out_of_range:
1318 ata_scsi_set_sense(scmd, ILLEGAL_REQUEST, 0x21, 0x0);
1319 /* "Logical Block Address out of range" */
1320 return 1;
1322 nothing_to_do:
1323 scmd->result = SAM_STAT_GOOD;
1324 return 1;
1328 * ata_scsi_rw_xlat - Translate SCSI r/w command into an ATA one
1329 * @qc: Storage for translated ATA taskfile
1331 * Converts any of six SCSI read/write commands into the
1332 * ATA counterpart, including starting sector (LBA),
1333 * sector count, and taking into account the device's LBA48
1334 * support.
1336 * Commands %READ_6, %READ_10, %READ_16, %WRITE_6, %WRITE_10, and
1337 * %WRITE_16 are currently supported.
1339 * LOCKING:
1340 * spin_lock_irqsave(host lock)
1342 * RETURNS:
1343 * Zero on success, non-zero on error.
1345 static unsigned int ata_scsi_rw_xlat(struct ata_queued_cmd *qc)
1347 struct scsi_cmnd *scmd = qc->scsicmd;
1348 const u8 *cdb = scmd->cmnd;
1349 unsigned int tf_flags = 0;
1350 u64 block;
1351 u32 n_block;
1352 int rc;
1354 if (cdb[0] == WRITE_10 || cdb[0] == WRITE_6 || cdb[0] == WRITE_16)
1355 tf_flags |= ATA_TFLAG_WRITE;
1357 /* Calculate the SCSI LBA, transfer length and FUA. */
1358 switch (cdb[0]) {
1359 case READ_10:
1360 case WRITE_10:
1361 if (unlikely(scmd->cmd_len < 10))
1362 goto invalid_fld;
1363 scsi_10_lba_len(cdb, &block, &n_block);
1364 if (unlikely(cdb[1] & (1 << 3)))
1365 tf_flags |= ATA_TFLAG_FUA;
1366 break;
1367 case READ_6:
1368 case WRITE_6:
1369 if (unlikely(scmd->cmd_len < 6))
1370 goto invalid_fld;
1371 scsi_6_lba_len(cdb, &block, &n_block);
1373 /* for 6-byte r/w commands, transfer length 0
1374 * means 256 blocks of data, not 0 block.
1376 if (!n_block)
1377 n_block = 256;
1378 break;
1379 case READ_16:
1380 case WRITE_16:
1381 if (unlikely(scmd->cmd_len < 16))
1382 goto invalid_fld;
1383 scsi_16_lba_len(cdb, &block, &n_block);
1384 if (unlikely(cdb[1] & (1 << 3)))
1385 tf_flags |= ATA_TFLAG_FUA;
1386 break;
1387 default:
1388 DPRINTK("no-byte command\n");
1389 goto invalid_fld;
1392 /* Check and compose ATA command */
1393 if (!n_block)
1394 /* For 10-byte and 16-byte SCSI R/W commands, transfer
1395 * length 0 means transfer 0 block of data.
1396 * However, for ATA R/W commands, sector count 0 means
1397 * 256 or 65536 sectors, not 0 sectors as in SCSI.
1399 * WARNING: one or two older ATA drives treat 0 as 0...
1401 goto nothing_to_do;
1403 qc->flags |= ATA_QCFLAG_IO;
1404 qc->nbytes = n_block * ATA_SECT_SIZE;
1406 rc = ata_build_rw_tf(&qc->tf, qc->dev, block, n_block, tf_flags,
1407 qc->tag);
1408 if (likely(rc == 0))
1409 return 0;
1411 if (rc == -ERANGE)
1412 goto out_of_range;
1413 /* treat all other errors as -EINVAL, fall through */
1414 invalid_fld:
1415 ata_scsi_set_sense(scmd, ILLEGAL_REQUEST, 0x24, 0x0);
1416 /* "Invalid field in cbd" */
1417 return 1;
1419 out_of_range:
1420 ata_scsi_set_sense(scmd, ILLEGAL_REQUEST, 0x21, 0x0);
1421 /* "Logical Block Address out of range" */
1422 return 1;
1424 nothing_to_do:
1425 scmd->result = SAM_STAT_GOOD;
1426 return 1;
1429 static void ata_scsi_qc_complete(struct ata_queued_cmd *qc)
1431 struct ata_port *ap = qc->ap;
1432 struct scsi_cmnd *cmd = qc->scsicmd;
1433 u8 *cdb = cmd->cmnd;
1434 int need_sense = (qc->err_mask != 0);
1436 /* We snoop the SET_FEATURES - Write Cache ON/OFF command, and
1437 * schedule EH_REVALIDATE operation to update the IDENTIFY DEVICE
1438 * cache
1440 if (ap->ops->error_handler &&
1441 !need_sense && (qc->tf.command == ATA_CMD_SET_FEATURES) &&
1442 ((qc->tf.feature == SETFEATURES_WC_ON) ||
1443 (qc->tf.feature == SETFEATURES_WC_OFF))) {
1444 ap->eh_info.action |= ATA_EH_REVALIDATE;
1445 ata_port_schedule_eh(ap);
1448 /* For ATA pass thru (SAT) commands, generate a sense block if
1449 * user mandated it or if there's an error. Note that if we
1450 * generate because the user forced us to, a check condition
1451 * is generated and the ATA register values are returned
1452 * whether the command completed successfully or not. If there
1453 * was no error, SK, ASC and ASCQ will all be zero.
1455 if (((cdb[0] == ATA_16) || (cdb[0] == ATA_12)) &&
1456 ((cdb[2] & 0x20) || need_sense)) {
1457 ata_gen_passthru_sense(qc);
1458 } else {
1459 if (!need_sense) {
1460 cmd->result = SAM_STAT_GOOD;
1461 } else {
1462 /* TODO: decide which descriptor format to use
1463 * for 48b LBA devices and call that here
1464 * instead of the fixed desc, which is only
1465 * good for smaller LBA (and maybe CHS?)
1466 * devices.
1468 ata_gen_ata_sense(qc);
1472 if (need_sense && !ap->ops->error_handler)
1473 ata_dump_status(ap->id, &qc->result_tf);
1475 qc->scsidone(cmd);
1477 ata_qc_free(qc);
1481 * ata_scmd_need_defer - Check whether we need to defer scmd
1482 * @dev: ATA device to which the command is addressed
1483 * @is_io: Is the command IO (and thus possibly NCQ)?
1485 * NCQ and non-NCQ commands cannot run together. As upper layer
1486 * only knows the queue depth, we are responsible for maintaining
1487 * exclusion. This function checks whether a new command can be
1488 * issued to @dev.
1490 * LOCKING:
1491 * spin_lock_irqsave(host lock)
1493 * RETURNS:
1494 * 1 if deferring is needed, 0 otherwise.
1496 static int ata_scmd_need_defer(struct ata_device *dev, int is_io)
1498 struct ata_port *ap = dev->ap;
1500 if (!(dev->flags & ATA_DFLAG_NCQ))
1501 return 0;
1503 if (is_io) {
1504 if (!ata_tag_valid(ap->active_tag))
1505 return 0;
1506 } else {
1507 if (!ata_tag_valid(ap->active_tag) && !ap->sactive)
1508 return 0;
1510 return 1;
1514 * ata_scsi_translate - Translate then issue SCSI command to ATA device
1515 * @dev: ATA device to which the command is addressed
1516 * @cmd: SCSI command to execute
1517 * @done: SCSI command completion function
1518 * @xlat_func: Actor which translates @cmd to an ATA taskfile
1520 * Our ->queuecommand() function has decided that the SCSI
1521 * command issued can be directly translated into an ATA
1522 * command, rather than handled internally.
1524 * This function sets up an ata_queued_cmd structure for the
1525 * SCSI command, and sends that ata_queued_cmd to the hardware.
1527 * The xlat_func argument (actor) returns 0 if ready to execute
1528 * ATA command, else 1 to finish translation. If 1 is returned
1529 * then cmd->result (and possibly cmd->sense_buffer) are assumed
1530 * to be set reflecting an error condition or clean (early)
1531 * termination.
1533 * LOCKING:
1534 * spin_lock_irqsave(host lock)
1536 * RETURNS:
1537 * 0 on success, SCSI_ML_QUEUE_DEVICE_BUSY if the command
1538 * needs to be deferred.
1540 static int ata_scsi_translate(struct ata_device *dev, struct scsi_cmnd *cmd,
1541 void (*done)(struct scsi_cmnd *),
1542 ata_xlat_func_t xlat_func)
1544 struct ata_queued_cmd *qc;
1545 int is_io = xlat_func == ata_scsi_rw_xlat;
1547 VPRINTK("ENTER\n");
1549 if (unlikely(ata_scmd_need_defer(dev, is_io)))
1550 goto defer;
1552 qc = ata_scsi_qc_new(dev, cmd, done);
1553 if (!qc)
1554 goto err_mem;
1556 /* data is present; dma-map it */
1557 if (cmd->sc_data_direction == DMA_FROM_DEVICE ||
1558 cmd->sc_data_direction == DMA_TO_DEVICE) {
1559 if (unlikely(cmd->request_bufflen < 1)) {
1560 ata_dev_printk(dev, KERN_WARNING,
1561 "WARNING: zero len r/w req\n");
1562 goto err_did;
1565 if (cmd->use_sg)
1566 ata_sg_init(qc, cmd->request_buffer, cmd->use_sg);
1567 else
1568 ata_sg_init_one(qc, cmd->request_buffer,
1569 cmd->request_bufflen);
1571 qc->dma_dir = cmd->sc_data_direction;
1574 qc->complete_fn = ata_scsi_qc_complete;
1576 if (xlat_func(qc))
1577 goto early_finish;
1579 /* select device, send command to hardware */
1580 ata_qc_issue(qc);
1582 VPRINTK("EXIT\n");
1583 return 0;
1585 early_finish:
1586 ata_qc_free(qc);
1587 done(cmd);
1588 DPRINTK("EXIT - early finish (good or error)\n");
1589 return 0;
1591 err_did:
1592 ata_qc_free(qc);
1593 cmd->result = (DID_ERROR << 16);
1594 done(cmd);
1595 err_mem:
1596 DPRINTK("EXIT - internal\n");
1597 return 0;
1599 defer:
1600 DPRINTK("EXIT - defer\n");
1601 return SCSI_MLQUEUE_DEVICE_BUSY;
1605 * ata_scsi_rbuf_get - Map response buffer.
1606 * @cmd: SCSI command containing buffer to be mapped.
1607 * @buf_out: Pointer to mapped area.
1609 * Maps buffer contained within SCSI command @cmd.
1611 * LOCKING:
1612 * spin_lock_irqsave(host lock)
1614 * RETURNS:
1615 * Length of response buffer.
1618 static unsigned int ata_scsi_rbuf_get(struct scsi_cmnd *cmd, u8 **buf_out)
1620 u8 *buf;
1621 unsigned int buflen;
1623 if (cmd->use_sg) {
1624 struct scatterlist *sg;
1626 sg = (struct scatterlist *) cmd->request_buffer;
1627 buf = kmap_atomic(sg->page, KM_IRQ0) + sg->offset;
1628 buflen = sg->length;
1629 } else {
1630 buf = cmd->request_buffer;
1631 buflen = cmd->request_bufflen;
1634 *buf_out = buf;
1635 return buflen;
1639 * ata_scsi_rbuf_put - Unmap response buffer.
1640 * @cmd: SCSI command containing buffer to be unmapped.
1641 * @buf: buffer to unmap
1643 * Unmaps response buffer contained within @cmd.
1645 * LOCKING:
1646 * spin_lock_irqsave(host lock)
1649 static inline void ata_scsi_rbuf_put(struct scsi_cmnd *cmd, u8 *buf)
1651 if (cmd->use_sg) {
1652 struct scatterlist *sg;
1654 sg = (struct scatterlist *) cmd->request_buffer;
1655 kunmap_atomic(buf - sg->offset, KM_IRQ0);
1660 * ata_scsi_rbuf_fill - wrapper for SCSI command simulators
1661 * @args: device IDENTIFY data / SCSI command of interest.
1662 * @actor: Callback hook for desired SCSI command simulator
1664 * Takes care of the hard work of simulating a SCSI command...
1665 * Mapping the response buffer, calling the command's handler,
1666 * and handling the handler's return value. This return value
1667 * indicates whether the handler wishes the SCSI command to be
1668 * completed successfully (0), or not (in which case cmd->result
1669 * and sense buffer are assumed to be set).
1671 * LOCKING:
1672 * spin_lock_irqsave(host lock)
1675 void ata_scsi_rbuf_fill(struct ata_scsi_args *args,
1676 unsigned int (*actor) (struct ata_scsi_args *args,
1677 u8 *rbuf, unsigned int buflen))
1679 u8 *rbuf;
1680 unsigned int buflen, rc;
1681 struct scsi_cmnd *cmd = args->cmd;
1683 buflen = ata_scsi_rbuf_get(cmd, &rbuf);
1684 memset(rbuf, 0, buflen);
1685 rc = actor(args, rbuf, buflen);
1686 ata_scsi_rbuf_put(cmd, rbuf);
1688 if (rc == 0)
1689 cmd->result = SAM_STAT_GOOD;
1690 args->done(cmd);
1694 * ATA_SCSI_RBUF_SET - helper to set values in SCSI response buffer
1695 * @idx: byte index into SCSI response buffer
1696 * @val: value to set
1698 * To be used by SCSI command simulator functions. This macros
1699 * expects two local variables, u8 *rbuf and unsigned int buflen,
1700 * are in scope.
1702 * LOCKING:
1703 * None.
1705 #define ATA_SCSI_RBUF_SET(idx, val) do { \
1706 if ((idx) < buflen) rbuf[(idx)] = (u8)(val); \
1707 } while (0)
1710 * ata_scsiop_inq_std - Simulate INQUIRY command
1711 * @args: device IDENTIFY data / SCSI command of interest.
1712 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1713 * @buflen: Response buffer length.
1715 * Returns standard device identification data associated
1716 * with non-VPD INQUIRY command output.
1718 * LOCKING:
1719 * spin_lock_irqsave(host lock)
1722 unsigned int ata_scsiop_inq_std(struct ata_scsi_args *args, u8 *rbuf,
1723 unsigned int buflen)
1725 u8 hdr[] = {
1726 TYPE_DISK,
1728 0x5, /* claim SPC-3 version compatibility */
1730 95 - 4
1733 /* set scsi removeable (RMB) bit per ata bit */
1734 if (ata_id_removeable(args->id))
1735 hdr[1] |= (1 << 7);
1737 VPRINTK("ENTER\n");
1739 memcpy(rbuf, hdr, sizeof(hdr));
1741 if (buflen > 35) {
1742 memcpy(&rbuf[8], "ATA ", 8);
1743 ata_id_string(args->id, &rbuf[16], ATA_ID_PROD, 16);
1744 ata_id_string(args->id, &rbuf[32], ATA_ID_FW_REV, 4);
1745 if (rbuf[32] == 0 || rbuf[32] == ' ')
1746 memcpy(&rbuf[32], "n/a ", 4);
1749 if (buflen > 63) {
1750 const u8 versions[] = {
1751 0x60, /* SAM-3 (no version claimed) */
1753 0x03,
1754 0x20, /* SBC-2 (no version claimed) */
1756 0x02,
1757 0x60 /* SPC-3 (no version claimed) */
1760 memcpy(rbuf + 59, versions, sizeof(versions));
1763 return 0;
1767 * ata_scsiop_inq_00 - Simulate INQUIRY VPD page 0, list of pages
1768 * @args: device IDENTIFY data / SCSI command of interest.
1769 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1770 * @buflen: Response buffer length.
1772 * Returns list of inquiry VPD pages available.
1774 * LOCKING:
1775 * spin_lock_irqsave(host lock)
1778 unsigned int ata_scsiop_inq_00(struct ata_scsi_args *args, u8 *rbuf,
1779 unsigned int buflen)
1781 const u8 pages[] = {
1782 0x00, /* page 0x00, this page */
1783 0x80, /* page 0x80, unit serial no page */
1784 0x83 /* page 0x83, device ident page */
1786 rbuf[3] = sizeof(pages); /* number of supported VPD pages */
1788 if (buflen > 6)
1789 memcpy(rbuf + 4, pages, sizeof(pages));
1791 return 0;
1795 * ata_scsiop_inq_80 - Simulate INQUIRY VPD page 80, device serial number
1796 * @args: device IDENTIFY data / SCSI command of interest.
1797 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1798 * @buflen: Response buffer length.
1800 * Returns ATA device serial number.
1802 * LOCKING:
1803 * spin_lock_irqsave(host lock)
1806 unsigned int ata_scsiop_inq_80(struct ata_scsi_args *args, u8 *rbuf,
1807 unsigned int buflen)
1809 const u8 hdr[] = {
1811 0x80, /* this page code */
1813 ATA_ID_SERNO_LEN, /* page len */
1815 memcpy(rbuf, hdr, sizeof(hdr));
1817 if (buflen > (ATA_ID_SERNO_LEN + 4 - 1))
1818 ata_id_string(args->id, (unsigned char *) &rbuf[4],
1819 ATA_ID_SERNO, ATA_ID_SERNO_LEN);
1821 return 0;
1825 * ata_scsiop_inq_83 - Simulate INQUIRY VPD page 83, device identity
1826 * @args: device IDENTIFY data / SCSI command of interest.
1827 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1828 * @buflen: Response buffer length.
1830 * Yields two logical unit device identification designators:
1831 * - vendor specific ASCII containing the ATA serial number
1832 * - SAT defined "t10 vendor id based" containing ASCII vendor
1833 * name ("ATA "), model and serial numbers.
1835 * LOCKING:
1836 * spin_lock_irqsave(host lock)
1839 unsigned int ata_scsiop_inq_83(struct ata_scsi_args *args, u8 *rbuf,
1840 unsigned int buflen)
1842 int num;
1843 const int sat_model_serial_desc_len = 68;
1845 rbuf[1] = 0x83; /* this page code */
1846 num = 4;
1848 if (buflen > (ATA_ID_SERNO_LEN + num + 3)) {
1849 /* piv=0, assoc=lu, code_set=ACSII, designator=vendor */
1850 rbuf[num + 0] = 2;
1851 rbuf[num + 3] = ATA_ID_SERNO_LEN;
1852 num += 4;
1853 ata_id_string(args->id, (unsigned char *) rbuf + num,
1854 ATA_ID_SERNO, ATA_ID_SERNO_LEN);
1855 num += ATA_ID_SERNO_LEN;
1857 if (buflen > (sat_model_serial_desc_len + num + 3)) {
1858 /* SAT defined lu model and serial numbers descriptor */
1859 /* piv=0, assoc=lu, code_set=ACSII, designator=t10 vendor id */
1860 rbuf[num + 0] = 2;
1861 rbuf[num + 1] = 1;
1862 rbuf[num + 3] = sat_model_serial_desc_len;
1863 num += 4;
1864 memcpy(rbuf + num, "ATA ", 8);
1865 num += 8;
1866 ata_id_string(args->id, (unsigned char *) rbuf + num,
1867 ATA_ID_PROD, ATA_ID_PROD_LEN);
1868 num += ATA_ID_PROD_LEN;
1869 ata_id_string(args->id, (unsigned char *) rbuf + num,
1870 ATA_ID_SERNO, ATA_ID_SERNO_LEN);
1871 num += ATA_ID_SERNO_LEN;
1873 rbuf[3] = num - 4; /* page len (assume less than 256 bytes) */
1874 return 0;
1878 * ata_scsiop_noop - Command handler that simply returns success.
1879 * @args: device IDENTIFY data / SCSI command of interest.
1880 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1881 * @buflen: Response buffer length.
1883 * No operation. Simply returns success to caller, to indicate
1884 * that the caller should successfully complete this SCSI command.
1886 * LOCKING:
1887 * spin_lock_irqsave(host lock)
1890 unsigned int ata_scsiop_noop(struct ata_scsi_args *args, u8 *rbuf,
1891 unsigned int buflen)
1893 VPRINTK("ENTER\n");
1894 return 0;
1898 * ata_msense_push - Push data onto MODE SENSE data output buffer
1899 * @ptr_io: (input/output) Location to store more output data
1900 * @last: End of output data buffer
1901 * @buf: Pointer to BLOB being added to output buffer
1902 * @buflen: Length of BLOB
1904 * Store MODE SENSE data on an output buffer.
1906 * LOCKING:
1907 * None.
1910 static void ata_msense_push(u8 **ptr_io, const u8 *last,
1911 const u8 *buf, unsigned int buflen)
1913 u8 *ptr = *ptr_io;
1915 if ((ptr + buflen - 1) > last)
1916 return;
1918 memcpy(ptr, buf, buflen);
1920 ptr += buflen;
1922 *ptr_io = ptr;
1926 * ata_msense_caching - Simulate MODE SENSE caching info page
1927 * @id: device IDENTIFY data
1928 * @ptr_io: (input/output) Location to store more output data
1929 * @last: End of output data buffer
1931 * Generate a caching info page, which conditionally indicates
1932 * write caching to the SCSI layer, depending on device
1933 * capabilities.
1935 * LOCKING:
1936 * None.
1939 static unsigned int ata_msense_caching(u16 *id, u8 **ptr_io,
1940 const u8 *last)
1942 u8 page[CACHE_MPAGE_LEN];
1944 memcpy(page, def_cache_mpage, sizeof(page));
1945 if (ata_id_wcache_enabled(id))
1946 page[2] |= (1 << 2); /* write cache enable */
1947 if (!ata_id_rahead_enabled(id))
1948 page[12] |= (1 << 5); /* disable read ahead */
1950 ata_msense_push(ptr_io, last, page, sizeof(page));
1951 return sizeof(page);
1955 * ata_msense_ctl_mode - Simulate MODE SENSE control mode page
1956 * @dev: Device associated with this MODE SENSE command
1957 * @ptr_io: (input/output) Location to store more output data
1958 * @last: End of output data buffer
1960 * Generate a generic MODE SENSE control mode page.
1962 * LOCKING:
1963 * None.
1966 static unsigned int ata_msense_ctl_mode(u8 **ptr_io, const u8 *last)
1968 ata_msense_push(ptr_io, last, def_control_mpage,
1969 sizeof(def_control_mpage));
1970 return sizeof(def_control_mpage);
1974 * ata_msense_rw_recovery - Simulate MODE SENSE r/w error recovery page
1975 * @dev: Device associated with this MODE SENSE command
1976 * @ptr_io: (input/output) Location to store more output data
1977 * @last: End of output data buffer
1979 * Generate a generic MODE SENSE r/w error recovery page.
1981 * LOCKING:
1982 * None.
1985 static unsigned int ata_msense_rw_recovery(u8 **ptr_io, const u8 *last)
1988 ata_msense_push(ptr_io, last, def_rw_recovery_mpage,
1989 sizeof(def_rw_recovery_mpage));
1990 return sizeof(def_rw_recovery_mpage);
1994 * We can turn this into a real blacklist if it's needed, for now just
1995 * blacklist any Maxtor BANC1G10 revision firmware
1997 static int ata_dev_supports_fua(u16 *id)
1999 unsigned char model[ATA_ID_PROD_LEN + 1], fw[ATA_ID_FW_REV_LEN + 1];
2001 if (!libata_fua)
2002 return 0;
2003 if (!ata_id_has_fua(id))
2004 return 0;
2006 ata_id_c_string(id, model, ATA_ID_PROD, sizeof(model));
2007 ata_id_c_string(id, fw, ATA_ID_FW_REV, sizeof(fw));
2009 if (strcmp(model, "Maxtor"))
2010 return 1;
2011 if (strcmp(fw, "BANC1G10"))
2012 return 1;
2014 return 0; /* blacklisted */
2018 * ata_scsiop_mode_sense - Simulate MODE SENSE 6, 10 commands
2019 * @args: device IDENTIFY data / SCSI command of interest.
2020 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2021 * @buflen: Response buffer length.
2023 * Simulate MODE SENSE commands. Assume this is invoked for direct
2024 * access devices (e.g. disks) only. There should be no block
2025 * descriptor for other device types.
2027 * LOCKING:
2028 * spin_lock_irqsave(host lock)
2031 unsigned int ata_scsiop_mode_sense(struct ata_scsi_args *args, u8 *rbuf,
2032 unsigned int buflen)
2034 struct ata_device *dev = args->dev;
2035 u8 *scsicmd = args->cmd->cmnd, *p, *last;
2036 const u8 sat_blk_desc[] = {
2037 0, 0, 0, 0, /* number of blocks: sat unspecified */
2039 0, 0x2, 0x0 /* block length: 512 bytes */
2041 u8 pg, spg;
2042 unsigned int ebd, page_control, six_byte, output_len, alloc_len, minlen;
2043 u8 dpofua;
2045 VPRINTK("ENTER\n");
2047 six_byte = (scsicmd[0] == MODE_SENSE);
2048 ebd = !(scsicmd[1] & 0x8); /* dbd bit inverted == edb */
2050 * LLBA bit in msense(10) ignored (compliant)
2053 page_control = scsicmd[2] >> 6;
2054 switch (page_control) {
2055 case 0: /* current */
2056 break; /* supported */
2057 case 3: /* saved */
2058 goto saving_not_supp;
2059 case 1: /* changeable */
2060 case 2: /* defaults */
2061 default:
2062 goto invalid_fld;
2065 if (six_byte) {
2066 output_len = 4 + (ebd ? 8 : 0);
2067 alloc_len = scsicmd[4];
2068 } else {
2069 output_len = 8 + (ebd ? 8 : 0);
2070 alloc_len = (scsicmd[7] << 8) + scsicmd[8];
2072 minlen = (alloc_len < buflen) ? alloc_len : buflen;
2074 p = rbuf + output_len;
2075 last = rbuf + minlen - 1;
2077 pg = scsicmd[2] & 0x3f;
2078 spg = scsicmd[3];
2080 * No mode subpages supported (yet) but asking for _all_
2081 * subpages may be valid
2083 if (spg && (spg != ALL_SUB_MPAGES))
2084 goto invalid_fld;
2086 switch(pg) {
2087 case RW_RECOVERY_MPAGE:
2088 output_len += ata_msense_rw_recovery(&p, last);
2089 break;
2091 case CACHE_MPAGE:
2092 output_len += ata_msense_caching(args->id, &p, last);
2093 break;
2095 case CONTROL_MPAGE: {
2096 output_len += ata_msense_ctl_mode(&p, last);
2097 break;
2100 case ALL_MPAGES:
2101 output_len += ata_msense_rw_recovery(&p, last);
2102 output_len += ata_msense_caching(args->id, &p, last);
2103 output_len += ata_msense_ctl_mode(&p, last);
2104 break;
2106 default: /* invalid page code */
2107 goto invalid_fld;
2110 if (minlen < 1)
2111 return 0;
2113 dpofua = 0;
2114 if (ata_dev_supports_fua(args->id) && (dev->flags & ATA_DFLAG_LBA48) &&
2115 (!(dev->flags & ATA_DFLAG_PIO) || dev->multi_count))
2116 dpofua = 1 << 4;
2118 if (six_byte) {
2119 output_len--;
2120 rbuf[0] = output_len;
2121 if (minlen > 2)
2122 rbuf[2] |= dpofua;
2123 if (ebd) {
2124 if (minlen > 3)
2125 rbuf[3] = sizeof(sat_blk_desc);
2126 if (minlen > 11)
2127 memcpy(rbuf + 4, sat_blk_desc,
2128 sizeof(sat_blk_desc));
2130 } else {
2131 output_len -= 2;
2132 rbuf[0] = output_len >> 8;
2133 if (minlen > 1)
2134 rbuf[1] = output_len;
2135 if (minlen > 3)
2136 rbuf[3] |= dpofua;
2137 if (ebd) {
2138 if (minlen > 7)
2139 rbuf[7] = sizeof(sat_blk_desc);
2140 if (minlen > 15)
2141 memcpy(rbuf + 8, sat_blk_desc,
2142 sizeof(sat_blk_desc));
2145 return 0;
2147 invalid_fld:
2148 ata_scsi_set_sense(args->cmd, ILLEGAL_REQUEST, 0x24, 0x0);
2149 /* "Invalid field in cbd" */
2150 return 1;
2152 saving_not_supp:
2153 ata_scsi_set_sense(args->cmd, ILLEGAL_REQUEST, 0x39, 0x0);
2154 /* "Saving parameters not supported" */
2155 return 1;
2159 * ata_scsiop_read_cap - Simulate READ CAPACITY[ 16] commands
2160 * @args: device IDENTIFY data / SCSI command of interest.
2161 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2162 * @buflen: Response buffer length.
2164 * Simulate READ CAPACITY commands.
2166 * LOCKING:
2167 * None.
2169 unsigned int ata_scsiop_read_cap(struct ata_scsi_args *args, u8 *rbuf,
2170 unsigned int buflen)
2172 u64 last_lba = args->dev->n_sectors - 1; /* LBA of the last block */
2174 VPRINTK("ENTER\n");
2176 if (args->cmd->cmnd[0] == READ_CAPACITY) {
2177 if (last_lba >= 0xffffffffULL)
2178 last_lba = 0xffffffff;
2180 /* sector count, 32-bit */
2181 ATA_SCSI_RBUF_SET(0, last_lba >> (8 * 3));
2182 ATA_SCSI_RBUF_SET(1, last_lba >> (8 * 2));
2183 ATA_SCSI_RBUF_SET(2, last_lba >> (8 * 1));
2184 ATA_SCSI_RBUF_SET(3, last_lba);
2186 /* sector size */
2187 ATA_SCSI_RBUF_SET(6, ATA_SECT_SIZE >> 8);
2188 ATA_SCSI_RBUF_SET(7, ATA_SECT_SIZE);
2189 } else {
2190 /* sector count, 64-bit */
2191 ATA_SCSI_RBUF_SET(0, last_lba >> (8 * 7));
2192 ATA_SCSI_RBUF_SET(1, last_lba >> (8 * 6));
2193 ATA_SCSI_RBUF_SET(2, last_lba >> (8 * 5));
2194 ATA_SCSI_RBUF_SET(3, last_lba >> (8 * 4));
2195 ATA_SCSI_RBUF_SET(4, last_lba >> (8 * 3));
2196 ATA_SCSI_RBUF_SET(5, last_lba >> (8 * 2));
2197 ATA_SCSI_RBUF_SET(6, last_lba >> (8 * 1));
2198 ATA_SCSI_RBUF_SET(7, last_lba);
2200 /* sector size */
2201 ATA_SCSI_RBUF_SET(10, ATA_SECT_SIZE >> 8);
2202 ATA_SCSI_RBUF_SET(11, ATA_SECT_SIZE);
2205 return 0;
2209 * ata_scsiop_report_luns - Simulate REPORT LUNS command
2210 * @args: device IDENTIFY data / SCSI command of interest.
2211 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2212 * @buflen: Response buffer length.
2214 * Simulate REPORT LUNS command.
2216 * LOCKING:
2217 * spin_lock_irqsave(host lock)
2220 unsigned int ata_scsiop_report_luns(struct ata_scsi_args *args, u8 *rbuf,
2221 unsigned int buflen)
2223 VPRINTK("ENTER\n");
2224 rbuf[3] = 8; /* just one lun, LUN 0, size 8 bytes */
2226 return 0;
2230 * ata_scsi_set_sense - Set SCSI sense data and status
2231 * @cmd: SCSI request to be handled
2232 * @sk: SCSI-defined sense key
2233 * @asc: SCSI-defined additional sense code
2234 * @ascq: SCSI-defined additional sense code qualifier
2236 * Helper function that builds a valid fixed format, current
2237 * response code and the given sense key (sk), additional sense
2238 * code (asc) and additional sense code qualifier (ascq) with
2239 * a SCSI command status of %SAM_STAT_CHECK_CONDITION and
2240 * DRIVER_SENSE set in the upper bits of scsi_cmnd::result .
2242 * LOCKING:
2243 * Not required
2246 void ata_scsi_set_sense(struct scsi_cmnd *cmd, u8 sk, u8 asc, u8 ascq)
2248 cmd->result = (DRIVER_SENSE << 24) | SAM_STAT_CHECK_CONDITION;
2250 cmd->sense_buffer[0] = 0x70; /* fixed format, current */
2251 cmd->sense_buffer[2] = sk;
2252 cmd->sense_buffer[7] = 18 - 8; /* additional sense length */
2253 cmd->sense_buffer[12] = asc;
2254 cmd->sense_buffer[13] = ascq;
2258 * ata_scsi_badcmd - End a SCSI request with an error
2259 * @cmd: SCSI request to be handled
2260 * @done: SCSI command completion function
2261 * @asc: SCSI-defined additional sense code
2262 * @ascq: SCSI-defined additional sense code qualifier
2264 * Helper function that completes a SCSI command with
2265 * %SAM_STAT_CHECK_CONDITION, with a sense key %ILLEGAL_REQUEST
2266 * and the specified additional sense codes.
2268 * LOCKING:
2269 * spin_lock_irqsave(host lock)
2272 void ata_scsi_badcmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *), u8 asc, u8 ascq)
2274 DPRINTK("ENTER\n");
2275 ata_scsi_set_sense(cmd, ILLEGAL_REQUEST, asc, ascq);
2277 done(cmd);
2280 static void atapi_sense_complete(struct ata_queued_cmd *qc)
2282 if (qc->err_mask && ((qc->err_mask & AC_ERR_DEV) == 0)) {
2283 /* FIXME: not quite right; we don't want the
2284 * translation of taskfile registers into
2285 * a sense descriptors, since that's only
2286 * correct for ATA, not ATAPI
2288 ata_gen_passthru_sense(qc);
2291 qc->scsidone(qc->scsicmd);
2292 ata_qc_free(qc);
2295 /* is it pointless to prefer PIO for "safety reasons"? */
2296 static inline int ata_pio_use_silly(struct ata_port *ap)
2298 return (ap->flags & ATA_FLAG_PIO_DMA);
2301 static void atapi_request_sense(struct ata_queued_cmd *qc)
2303 struct ata_port *ap = qc->ap;
2304 struct scsi_cmnd *cmd = qc->scsicmd;
2306 DPRINTK("ATAPI request sense\n");
2308 /* FIXME: is this needed? */
2309 memset(cmd->sense_buffer, 0, sizeof(cmd->sense_buffer));
2311 ap->ops->tf_read(ap, &qc->tf);
2313 /* fill these in, for the case where they are -not- overwritten */
2314 cmd->sense_buffer[0] = 0x70;
2315 cmd->sense_buffer[2] = qc->tf.feature >> 4;
2317 ata_qc_reinit(qc);
2319 ata_sg_init_one(qc, cmd->sense_buffer, sizeof(cmd->sense_buffer));
2320 qc->dma_dir = DMA_FROM_DEVICE;
2322 memset(&qc->cdb, 0, qc->dev->cdb_len);
2323 qc->cdb[0] = REQUEST_SENSE;
2324 qc->cdb[4] = SCSI_SENSE_BUFFERSIZE;
2326 qc->tf.flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
2327 qc->tf.command = ATA_CMD_PACKET;
2329 if (ata_pio_use_silly(ap)) {
2330 qc->tf.protocol = ATA_PROT_ATAPI_DMA;
2331 qc->tf.feature |= ATAPI_PKT_DMA;
2332 } else {
2333 qc->tf.protocol = ATA_PROT_ATAPI;
2334 qc->tf.lbam = (8 * 1024) & 0xff;
2335 qc->tf.lbah = (8 * 1024) >> 8;
2337 qc->nbytes = SCSI_SENSE_BUFFERSIZE;
2339 qc->complete_fn = atapi_sense_complete;
2341 ata_qc_issue(qc);
2343 DPRINTK("EXIT\n");
2346 static void atapi_qc_complete(struct ata_queued_cmd *qc)
2348 struct scsi_cmnd *cmd = qc->scsicmd;
2349 unsigned int err_mask = qc->err_mask;
2351 VPRINTK("ENTER, err_mask 0x%X\n", err_mask);
2353 /* handle completion from new EH */
2354 if (unlikely(qc->ap->ops->error_handler &&
2355 (err_mask || qc->flags & ATA_QCFLAG_SENSE_VALID))) {
2357 if (!(qc->flags & ATA_QCFLAG_SENSE_VALID)) {
2358 /* FIXME: not quite right; we don't want the
2359 * translation of taskfile registers into a
2360 * sense descriptors, since that's only
2361 * correct for ATA, not ATAPI
2363 ata_gen_passthru_sense(qc);
2366 /* SCSI EH automatically locks door if sdev->locked is
2367 * set. Sometimes door lock request continues to
2368 * fail, for example, when no media is present. This
2369 * creates a loop - SCSI EH issues door lock which
2370 * fails and gets invoked again to acquire sense data
2371 * for the failed command.
2373 * If door lock fails, always clear sdev->locked to
2374 * avoid this infinite loop.
2376 if (qc->cdb[0] == ALLOW_MEDIUM_REMOVAL)
2377 qc->dev->sdev->locked = 0;
2379 qc->scsicmd->result = SAM_STAT_CHECK_CONDITION;
2380 qc->scsidone(cmd);
2381 ata_qc_free(qc);
2382 return;
2385 /* successful completion or old EH failure path */
2386 if (unlikely(err_mask & AC_ERR_DEV)) {
2387 cmd->result = SAM_STAT_CHECK_CONDITION;
2388 atapi_request_sense(qc);
2389 return;
2390 } else if (unlikely(err_mask)) {
2391 /* FIXME: not quite right; we don't want the
2392 * translation of taskfile registers into
2393 * a sense descriptors, since that's only
2394 * correct for ATA, not ATAPI
2396 ata_gen_passthru_sense(qc);
2397 } else {
2398 u8 *scsicmd = cmd->cmnd;
2400 if ((scsicmd[0] == INQUIRY) && ((scsicmd[1] & 0x03) == 0)) {
2401 u8 *buf = NULL;
2402 unsigned int buflen;
2404 buflen = ata_scsi_rbuf_get(cmd, &buf);
2406 /* ATAPI devices typically report zero for their SCSI version,
2407 * and sometimes deviate from the spec WRT response data
2408 * format. If SCSI version is reported as zero like normal,
2409 * then we make the following fixups: 1) Fake MMC-5 version,
2410 * to indicate to the Linux scsi midlayer this is a modern
2411 * device. 2) Ensure response data format / ATAPI information
2412 * are always correct.
2414 if (buf[2] == 0) {
2415 buf[2] = 0x5;
2416 buf[3] = 0x32;
2419 ata_scsi_rbuf_put(cmd, buf);
2422 cmd->result = SAM_STAT_GOOD;
2425 qc->scsidone(cmd);
2426 ata_qc_free(qc);
2429 * atapi_xlat - Initialize PACKET taskfile
2430 * @qc: command structure to be initialized
2432 * LOCKING:
2433 * spin_lock_irqsave(host lock)
2435 * RETURNS:
2436 * Zero on success, non-zero on failure.
2438 static unsigned int atapi_xlat(struct ata_queued_cmd *qc)
2440 struct scsi_cmnd *scmd = qc->scsicmd;
2441 struct ata_device *dev = qc->dev;
2442 int using_pio = (dev->flags & ATA_DFLAG_PIO);
2443 int nodata = (scmd->sc_data_direction == DMA_NONE);
2445 if (!using_pio)
2446 /* Check whether ATAPI DMA is safe */
2447 if (ata_check_atapi_dma(qc))
2448 using_pio = 1;
2450 memset(qc->cdb, 0, dev->cdb_len);
2451 memcpy(qc->cdb, scmd->cmnd, scmd->cmd_len);
2453 qc->complete_fn = atapi_qc_complete;
2455 qc->tf.flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
2456 if (scmd->sc_data_direction == DMA_TO_DEVICE) {
2457 qc->tf.flags |= ATA_TFLAG_WRITE;
2458 DPRINTK("direction: write\n");
2461 qc->tf.command = ATA_CMD_PACKET;
2463 /* no data, or PIO data xfer */
2464 if (using_pio || nodata) {
2465 if (nodata)
2466 qc->tf.protocol = ATA_PROT_ATAPI_NODATA;
2467 else
2468 qc->tf.protocol = ATA_PROT_ATAPI;
2469 qc->tf.lbam = (8 * 1024) & 0xff;
2470 qc->tf.lbah = (8 * 1024) >> 8;
2473 /* DMA data xfer */
2474 else {
2475 qc->tf.protocol = ATA_PROT_ATAPI_DMA;
2476 qc->tf.feature |= ATAPI_PKT_DMA;
2478 if (atapi_dmadir && (scmd->sc_data_direction != DMA_TO_DEVICE))
2479 /* some SATA bridges need us to indicate data xfer direction */
2480 qc->tf.feature |= ATAPI_DMADIR;
2483 qc->nbytes = scmd->request_bufflen;
2485 return 0;
2488 static struct ata_device * ata_find_dev(struct ata_port *ap, int id)
2490 if (likely(id < ATA_MAX_DEVICES))
2491 return &ap->device[id];
2492 return NULL;
2495 static struct ata_device * __ata_scsi_find_dev(struct ata_port *ap,
2496 const struct scsi_device *scsidev)
2498 /* skip commands not addressed to targets we simulate */
2499 if (unlikely(scsidev->channel || scsidev->lun))
2500 return NULL;
2502 return ata_find_dev(ap, scsidev->id);
2506 * ata_scsi_dev_enabled - determine if device is enabled
2507 * @dev: ATA device
2509 * Determine if commands should be sent to the specified device.
2511 * LOCKING:
2512 * spin_lock_irqsave(host lock)
2514 * RETURNS:
2515 * 0 if commands are not allowed / 1 if commands are allowed
2518 static int ata_scsi_dev_enabled(struct ata_device *dev)
2520 if (unlikely(!ata_dev_enabled(dev)))
2521 return 0;
2523 if (!atapi_enabled || (dev->ap->flags & ATA_FLAG_NO_ATAPI)) {
2524 if (unlikely(dev->class == ATA_DEV_ATAPI)) {
2525 ata_dev_printk(dev, KERN_WARNING,
2526 "WARNING: ATAPI is %s, device ignored.\n",
2527 atapi_enabled ? "not supported with this driver" : "disabled");
2528 return 0;
2532 return 1;
2536 * ata_scsi_find_dev - lookup ata_device from scsi_cmnd
2537 * @ap: ATA port to which the device is attached
2538 * @scsidev: SCSI device from which we derive the ATA device
2540 * Given various information provided in struct scsi_cmnd,
2541 * map that onto an ATA bus, and using that mapping
2542 * determine which ata_device is associated with the
2543 * SCSI command to be sent.
2545 * LOCKING:
2546 * spin_lock_irqsave(host lock)
2548 * RETURNS:
2549 * Associated ATA device, or %NULL if not found.
2551 static struct ata_device *
2552 ata_scsi_find_dev(struct ata_port *ap, const struct scsi_device *scsidev)
2554 struct ata_device *dev = __ata_scsi_find_dev(ap, scsidev);
2556 if (unlikely(!dev || !ata_scsi_dev_enabled(dev)))
2557 return NULL;
2559 return dev;
2563 * ata_scsi_map_proto - Map pass-thru protocol value to taskfile value.
2564 * @byte1: Byte 1 from pass-thru CDB.
2566 * RETURNS:
2567 * ATA_PROT_UNKNOWN if mapping failed/unimplemented, protocol otherwise.
2569 static u8
2570 ata_scsi_map_proto(u8 byte1)
2572 switch((byte1 & 0x1e) >> 1) {
2573 case 3: /* Non-data */
2574 return ATA_PROT_NODATA;
2576 case 6: /* DMA */
2577 return ATA_PROT_DMA;
2579 case 4: /* PIO Data-in */
2580 case 5: /* PIO Data-out */
2581 return ATA_PROT_PIO;
2583 case 10: /* Device Reset */
2584 case 0: /* Hard Reset */
2585 case 1: /* SRST */
2586 case 2: /* Bus Idle */
2587 case 7: /* Packet */
2588 case 8: /* DMA Queued */
2589 case 9: /* Device Diagnostic */
2590 case 11: /* UDMA Data-in */
2591 case 12: /* UDMA Data-Out */
2592 case 13: /* FPDMA */
2593 default: /* Reserved */
2594 break;
2597 return ATA_PROT_UNKNOWN;
2601 * ata_scsi_pass_thru - convert ATA pass-thru CDB to taskfile
2602 * @qc: command structure to be initialized
2604 * Handles either 12 or 16-byte versions of the CDB.
2606 * RETURNS:
2607 * Zero on success, non-zero on failure.
2609 static unsigned int ata_scsi_pass_thru(struct ata_queued_cmd *qc)
2611 struct ata_taskfile *tf = &(qc->tf);
2612 struct scsi_cmnd *scmd = qc->scsicmd;
2613 struct ata_device *dev = qc->dev;
2614 const u8 *cdb = scmd->cmnd;
2616 if ((tf->protocol = ata_scsi_map_proto(cdb[1])) == ATA_PROT_UNKNOWN)
2617 goto invalid_fld;
2619 /* We may not issue DMA commands if no DMA mode is set */
2620 if (tf->protocol == ATA_PROT_DMA && dev->dma_mode == 0)
2621 goto invalid_fld;
2623 if (cdb[1] & 0xe0)
2624 /* PIO multi not supported yet */
2625 goto invalid_fld;
2628 * 12 and 16 byte CDBs use different offsets to
2629 * provide the various register values.
2631 if (cdb[0] == ATA_16) {
2633 * 16-byte CDB - may contain extended commands.
2635 * If that is the case, copy the upper byte register values.
2637 if (cdb[1] & 0x01) {
2638 tf->hob_feature = cdb[3];
2639 tf->hob_nsect = cdb[5];
2640 tf->hob_lbal = cdb[7];
2641 tf->hob_lbam = cdb[9];
2642 tf->hob_lbah = cdb[11];
2643 tf->flags |= ATA_TFLAG_LBA48;
2644 } else
2645 tf->flags &= ~ATA_TFLAG_LBA48;
2648 * Always copy low byte, device and command registers.
2650 tf->feature = cdb[4];
2651 tf->nsect = cdb[6];
2652 tf->lbal = cdb[8];
2653 tf->lbam = cdb[10];
2654 tf->lbah = cdb[12];
2655 tf->device = cdb[13];
2656 tf->command = cdb[14];
2657 } else {
2659 * 12-byte CDB - incapable of extended commands.
2661 tf->flags &= ~ATA_TFLAG_LBA48;
2663 tf->feature = cdb[3];
2664 tf->nsect = cdb[4];
2665 tf->lbal = cdb[5];
2666 tf->lbam = cdb[6];
2667 tf->lbah = cdb[7];
2668 tf->device = cdb[8];
2669 tf->command = cdb[9];
2672 * If slave is possible, enforce correct master/slave bit
2674 if (qc->ap->flags & ATA_FLAG_SLAVE_POSS)
2675 tf->device = qc->dev->devno ?
2676 tf->device | ATA_DEV1 : tf->device & ~ATA_DEV1;
2679 * Filter SET_FEATURES - XFER MODE command -- otherwise,
2680 * SET_FEATURES - XFER MODE must be preceded/succeeded
2681 * by an update to hardware-specific registers for each
2682 * controller (i.e. the reason for ->set_piomode(),
2683 * ->set_dmamode(), and ->post_set_mode() hooks).
2685 if ((tf->command == ATA_CMD_SET_FEATURES)
2686 && (tf->feature == SETFEATURES_XFER))
2687 goto invalid_fld;
2690 * Set flags so that all registers will be written,
2691 * and pass on write indication (used for PIO/DMA
2692 * setup.)
2694 tf->flags |= (ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE);
2696 if (scmd->sc_data_direction == DMA_TO_DEVICE)
2697 tf->flags |= ATA_TFLAG_WRITE;
2700 * Set transfer length.
2702 * TODO: find out if we need to do more here to
2703 * cover scatter/gather case.
2705 qc->nbytes = scmd->request_bufflen;
2707 /* request result TF */
2708 qc->flags |= ATA_QCFLAG_RESULT_TF;
2710 return 0;
2712 invalid_fld:
2713 ata_scsi_set_sense(scmd, ILLEGAL_REQUEST, 0x24, 0x00);
2714 /* "Invalid field in cdb" */
2715 return 1;
2719 * ata_get_xlat_func - check if SCSI to ATA translation is possible
2720 * @dev: ATA device
2721 * @cmd: SCSI command opcode to consider
2723 * Look up the SCSI command given, and determine whether the
2724 * SCSI command is to be translated or simulated.
2726 * RETURNS:
2727 * Pointer to translation function if possible, %NULL if not.
2730 static inline ata_xlat_func_t ata_get_xlat_func(struct ata_device *dev, u8 cmd)
2732 switch (cmd) {
2733 case READ_6:
2734 case READ_10:
2735 case READ_16:
2737 case WRITE_6:
2738 case WRITE_10:
2739 case WRITE_16:
2740 return ata_scsi_rw_xlat;
2742 case SYNCHRONIZE_CACHE:
2743 if (ata_try_flush_cache(dev))
2744 return ata_scsi_flush_xlat;
2745 break;
2747 case VERIFY:
2748 case VERIFY_16:
2749 return ata_scsi_verify_xlat;
2751 case ATA_12:
2752 case ATA_16:
2753 return ata_scsi_pass_thru;
2755 case START_STOP:
2756 return ata_scsi_start_stop_xlat;
2759 return NULL;
2763 * ata_scsi_dump_cdb - dump SCSI command contents to dmesg
2764 * @ap: ATA port to which the command was being sent
2765 * @cmd: SCSI command to dump
2767 * Prints the contents of a SCSI command via printk().
2770 static inline void ata_scsi_dump_cdb(struct ata_port *ap,
2771 struct scsi_cmnd *cmd)
2773 #ifdef ATA_DEBUG
2774 struct scsi_device *scsidev = cmd->device;
2775 u8 *scsicmd = cmd->cmnd;
2777 DPRINTK("CDB (%u:%d,%d,%d) %02x %02x %02x %02x %02x %02x %02x %02x %02x\n",
2778 ap->id,
2779 scsidev->channel, scsidev->id, scsidev->lun,
2780 scsicmd[0], scsicmd[1], scsicmd[2], scsicmd[3],
2781 scsicmd[4], scsicmd[5], scsicmd[6], scsicmd[7],
2782 scsicmd[8]);
2783 #endif
2786 static inline int __ata_scsi_queuecmd(struct scsi_cmnd *scmd,
2787 void (*done)(struct scsi_cmnd *),
2788 struct ata_device *dev)
2790 int rc = 0;
2792 if (unlikely(!scmd->cmd_len)) {
2793 ata_dev_printk(dev, KERN_WARNING, "WARNING: zero len CDB\n");
2794 scmd->result = DID_ERROR << 16;
2795 done(scmd);
2796 return 0;
2799 if (dev->class == ATA_DEV_ATA) {
2800 ata_xlat_func_t xlat_func = ata_get_xlat_func(dev,
2801 scmd->cmnd[0]);
2803 if (xlat_func)
2804 rc = ata_scsi_translate(dev, scmd, done, xlat_func);
2805 else
2806 ata_scsi_simulate(dev, scmd, done);
2807 } else
2808 rc = ata_scsi_translate(dev, scmd, done, atapi_xlat);
2810 return rc;
2814 * ata_scsi_queuecmd - Issue SCSI cdb to libata-managed device
2815 * @cmd: SCSI command to be sent
2816 * @done: Completion function, called when command is complete
2818 * In some cases, this function translates SCSI commands into
2819 * ATA taskfiles, and queues the taskfiles to be sent to
2820 * hardware. In other cases, this function simulates a
2821 * SCSI device by evaluating and responding to certain
2822 * SCSI commands. This creates the overall effect of
2823 * ATA and ATAPI devices appearing as SCSI devices.
2825 * LOCKING:
2826 * Releases scsi-layer-held lock, and obtains host lock.
2828 * RETURNS:
2829 * Return value from __ata_scsi_queuecmd() if @cmd can be queued,
2830 * 0 otherwise.
2832 int ata_scsi_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *))
2834 struct ata_port *ap;
2835 struct ata_device *dev;
2836 struct scsi_device *scsidev = cmd->device;
2837 struct Scsi_Host *shost = scsidev->host;
2838 int rc = 0;
2840 ap = ata_shost_to_port(shost);
2842 spin_unlock(shost->host_lock);
2843 spin_lock(ap->lock);
2845 ata_scsi_dump_cdb(ap, cmd);
2847 dev = ata_scsi_find_dev(ap, scsidev);
2848 if (likely(dev))
2849 rc = __ata_scsi_queuecmd(cmd, done, dev);
2850 else {
2851 cmd->result = (DID_BAD_TARGET << 16);
2852 done(cmd);
2855 spin_unlock(ap->lock);
2856 spin_lock(shost->host_lock);
2857 return rc;
2861 * ata_scsi_simulate - simulate SCSI command on ATA device
2862 * @dev: the target device
2863 * @cmd: SCSI command being sent to device.
2864 * @done: SCSI command completion function.
2866 * Interprets and directly executes a select list of SCSI commands
2867 * that can be handled internally.
2869 * LOCKING:
2870 * spin_lock_irqsave(host lock)
2873 void ata_scsi_simulate(struct ata_device *dev, struct scsi_cmnd *cmd,
2874 void (*done)(struct scsi_cmnd *))
2876 struct ata_scsi_args args;
2877 const u8 *scsicmd = cmd->cmnd;
2879 args.dev = dev;
2880 args.id = dev->id;
2881 args.cmd = cmd;
2882 args.done = done;
2884 switch(scsicmd[0]) {
2885 /* no-op's, complete with success */
2886 case SYNCHRONIZE_CACHE:
2887 case REZERO_UNIT:
2888 case SEEK_6:
2889 case SEEK_10:
2890 case TEST_UNIT_READY:
2891 case FORMAT_UNIT: /* FIXME: correct? */
2892 case SEND_DIAGNOSTIC: /* FIXME: correct? */
2893 ata_scsi_rbuf_fill(&args, ata_scsiop_noop);
2894 break;
2896 case INQUIRY:
2897 if (scsicmd[1] & 2) /* is CmdDt set? */
2898 ata_scsi_invalid_field(cmd, done);
2899 else if ((scsicmd[1] & 1) == 0) /* is EVPD clear? */
2900 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_std);
2901 else if (scsicmd[2] == 0x00)
2902 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_00);
2903 else if (scsicmd[2] == 0x80)
2904 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_80);
2905 else if (scsicmd[2] == 0x83)
2906 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_83);
2907 else
2908 ata_scsi_invalid_field(cmd, done);
2909 break;
2911 case MODE_SENSE:
2912 case MODE_SENSE_10:
2913 ata_scsi_rbuf_fill(&args, ata_scsiop_mode_sense);
2914 break;
2916 case MODE_SELECT: /* unconditionally return */
2917 case MODE_SELECT_10: /* bad-field-in-cdb */
2918 ata_scsi_invalid_field(cmd, done);
2919 break;
2921 case READ_CAPACITY:
2922 ata_scsi_rbuf_fill(&args, ata_scsiop_read_cap);
2923 break;
2925 case SERVICE_ACTION_IN:
2926 if ((scsicmd[1] & 0x1f) == SAI_READ_CAPACITY_16)
2927 ata_scsi_rbuf_fill(&args, ata_scsiop_read_cap);
2928 else
2929 ata_scsi_invalid_field(cmd, done);
2930 break;
2932 case REPORT_LUNS:
2933 ata_scsi_rbuf_fill(&args, ata_scsiop_report_luns);
2934 break;
2936 /* mandatory commands we haven't implemented yet */
2937 case REQUEST_SENSE:
2939 /* all other commands */
2940 default:
2941 ata_scsi_set_sense(cmd, ILLEGAL_REQUEST, 0x20, 0x0);
2942 /* "Invalid command operation code" */
2943 done(cmd);
2944 break;
2948 void ata_scsi_scan_host(struct ata_port *ap)
2950 unsigned int i;
2952 if (ap->flags & ATA_FLAG_DISABLED)
2953 return;
2955 for (i = 0; i < ATA_MAX_DEVICES; i++) {
2956 struct ata_device *dev = &ap->device[i];
2957 struct scsi_device *sdev;
2959 if (!ata_dev_enabled(dev) || dev->sdev)
2960 continue;
2962 sdev = __scsi_add_device(ap->scsi_host, 0, i, 0, NULL);
2963 if (!IS_ERR(sdev)) {
2964 dev->sdev = sdev;
2965 scsi_device_put(sdev);
2971 * ata_scsi_offline_dev - offline attached SCSI device
2972 * @dev: ATA device to offline attached SCSI device for
2974 * This function is called from ata_eh_hotplug() and responsible
2975 * for taking the SCSI device attached to @dev offline. This
2976 * function is called with host lock which protects dev->sdev
2977 * against clearing.
2979 * LOCKING:
2980 * spin_lock_irqsave(host lock)
2982 * RETURNS:
2983 * 1 if attached SCSI device exists, 0 otherwise.
2985 int ata_scsi_offline_dev(struct ata_device *dev)
2987 if (dev->sdev) {
2988 scsi_device_set_state(dev->sdev, SDEV_OFFLINE);
2989 return 1;
2991 return 0;
2995 * ata_scsi_remove_dev - remove attached SCSI device
2996 * @dev: ATA device to remove attached SCSI device for
2998 * This function is called from ata_eh_scsi_hotplug() and
2999 * responsible for removing the SCSI device attached to @dev.
3001 * LOCKING:
3002 * Kernel thread context (may sleep).
3004 static void ata_scsi_remove_dev(struct ata_device *dev)
3006 struct ata_port *ap = dev->ap;
3007 struct scsi_device *sdev;
3008 unsigned long flags;
3010 /* Alas, we need to grab scan_mutex to ensure SCSI device
3011 * state doesn't change underneath us and thus
3012 * scsi_device_get() always succeeds. The mutex locking can
3013 * be removed if there is __scsi_device_get() interface which
3014 * increments reference counts regardless of device state.
3016 mutex_lock(&ap->scsi_host->scan_mutex);
3017 spin_lock_irqsave(ap->lock, flags);
3019 /* clearing dev->sdev is protected by host lock */
3020 sdev = dev->sdev;
3021 dev->sdev = NULL;
3023 if (sdev) {
3024 /* If user initiated unplug races with us, sdev can go
3025 * away underneath us after the host lock and
3026 * scan_mutex are released. Hold onto it.
3028 if (scsi_device_get(sdev) == 0) {
3029 /* The following ensures the attached sdev is
3030 * offline on return from ata_scsi_offline_dev()
3031 * regardless it wins or loses the race
3032 * against this function.
3034 scsi_device_set_state(sdev, SDEV_OFFLINE);
3035 } else {
3036 WARN_ON(1);
3037 sdev = NULL;
3041 spin_unlock_irqrestore(ap->lock, flags);
3042 mutex_unlock(&ap->scsi_host->scan_mutex);
3044 if (sdev) {
3045 ata_dev_printk(dev, KERN_INFO, "detaching (SCSI %s)\n",
3046 sdev->sdev_gendev.bus_id);
3048 scsi_remove_device(sdev);
3049 scsi_device_put(sdev);
3054 * ata_scsi_hotplug - SCSI part of hotplug
3055 * @work: Pointer to ATA port to perform SCSI hotplug on
3057 * Perform SCSI part of hotplug. It's executed from a separate
3058 * workqueue after EH completes. This is necessary because SCSI
3059 * hot plugging requires working EH and hot unplugging is
3060 * synchronized with hot plugging with a mutex.
3062 * LOCKING:
3063 * Kernel thread context (may sleep).
3065 void ata_scsi_hotplug(struct work_struct *work)
3067 struct ata_port *ap =
3068 container_of(work, struct ata_port, hotplug_task.work);
3069 int i;
3071 if (ap->pflags & ATA_PFLAG_UNLOADING) {
3072 DPRINTK("ENTER/EXIT - unloading\n");
3073 return;
3076 DPRINTK("ENTER\n");
3078 /* unplug detached devices */
3079 for (i = 0; i < ATA_MAX_DEVICES; i++) {
3080 struct ata_device *dev = &ap->device[i];
3081 unsigned long flags;
3083 if (!(dev->flags & ATA_DFLAG_DETACHED))
3084 continue;
3086 spin_lock_irqsave(ap->lock, flags);
3087 dev->flags &= ~ATA_DFLAG_DETACHED;
3088 spin_unlock_irqrestore(ap->lock, flags);
3090 ata_scsi_remove_dev(dev);
3093 /* scan for new ones */
3094 ata_scsi_scan_host(ap);
3096 /* If we scanned while EH was in progress, scan would have
3097 * failed silently. Requeue if there are enabled but
3098 * unattached devices.
3100 for (i = 0; i < ATA_MAX_DEVICES; i++) {
3101 struct ata_device *dev = &ap->device[i];
3102 if (ata_dev_enabled(dev) && !dev->sdev) {
3103 queue_delayed_work(ata_aux_wq, &ap->hotplug_task,
3104 round_jiffies_relative(HZ));
3105 break;
3109 DPRINTK("EXIT\n");
3113 * ata_scsi_user_scan - indication for user-initiated bus scan
3114 * @shost: SCSI host to scan
3115 * @channel: Channel to scan
3116 * @id: ID to scan
3117 * @lun: LUN to scan
3119 * This function is called when user explicitly requests bus
3120 * scan. Set probe pending flag and invoke EH.
3122 * LOCKING:
3123 * SCSI layer (we don't care)
3125 * RETURNS:
3126 * Zero.
3128 static int ata_scsi_user_scan(struct Scsi_Host *shost, unsigned int channel,
3129 unsigned int id, unsigned int lun)
3131 struct ata_port *ap = ata_shost_to_port(shost);
3132 unsigned long flags;
3133 int rc = 0;
3135 if (!ap->ops->error_handler)
3136 return -EOPNOTSUPP;
3138 if ((channel != SCAN_WILD_CARD && channel != 0) ||
3139 (lun != SCAN_WILD_CARD && lun != 0))
3140 return -EINVAL;
3142 spin_lock_irqsave(ap->lock, flags);
3144 if (id == SCAN_WILD_CARD) {
3145 ap->eh_info.probe_mask |= (1 << ATA_MAX_DEVICES) - 1;
3146 ap->eh_info.action |= ATA_EH_SOFTRESET;
3147 } else {
3148 struct ata_device *dev = ata_find_dev(ap, id);
3150 if (dev) {
3151 ap->eh_info.probe_mask |= 1 << dev->devno;
3152 ap->eh_info.action |= ATA_EH_SOFTRESET;
3153 ap->eh_info.flags |= ATA_EHI_RESUME_LINK;
3154 } else
3155 rc = -EINVAL;
3158 if (rc == 0) {
3159 ata_port_schedule_eh(ap);
3160 spin_unlock_irqrestore(ap->lock, flags);
3161 ata_port_wait_eh(ap);
3162 } else
3163 spin_unlock_irqrestore(ap->lock, flags);
3165 return rc;
3169 * ata_scsi_dev_rescan - initiate scsi_rescan_device()
3170 * @work: Pointer to ATA port to perform scsi_rescan_device()
3172 * After ATA pass thru (SAT) commands are executed successfully,
3173 * libata need to propagate the changes to SCSI layer. This
3174 * function must be executed from ata_aux_wq such that sdev
3175 * attach/detach don't race with rescan.
3177 * LOCKING:
3178 * Kernel thread context (may sleep).
3180 void ata_scsi_dev_rescan(struct work_struct *work)
3182 struct ata_port *ap =
3183 container_of(work, struct ata_port, scsi_rescan_task);
3184 unsigned long flags;
3185 unsigned int i;
3187 spin_lock_irqsave(ap->lock, flags);
3189 for (i = 0; i < ATA_MAX_DEVICES; i++) {
3190 struct ata_device *dev = &ap->device[i];
3191 struct scsi_device *sdev = dev->sdev;
3193 if (!ata_dev_enabled(dev) || !sdev)
3194 continue;
3195 if (scsi_device_get(sdev))
3196 continue;
3198 spin_unlock_irqrestore(ap->lock, flags);
3199 scsi_rescan_device(&(sdev->sdev_gendev));
3200 scsi_device_put(sdev);
3201 spin_lock_irqsave(ap->lock, flags);
3204 spin_unlock_irqrestore(ap->lock, flags);
3208 * ata_sas_port_alloc - Allocate port for a SAS attached SATA device
3209 * @host: ATA host container for all SAS ports
3210 * @port_info: Information from low-level host driver
3211 * @shost: SCSI host that the scsi device is attached to
3213 * LOCKING:
3214 * PCI/etc. bus probe sem.
3216 * RETURNS:
3217 * ata_port pointer on success / NULL on failure.
3220 struct ata_port *ata_sas_port_alloc(struct ata_host *host,
3221 struct ata_port_info *port_info,
3222 struct Scsi_Host *shost)
3224 struct ata_port *ap = kzalloc(sizeof(*ap), GFP_KERNEL);
3225 struct ata_probe_ent *ent;
3227 if (!ap)
3228 return NULL;
3230 ent = ata_probe_ent_alloc(host->dev, port_info);
3231 if (!ent) {
3232 kfree(ap);
3233 return NULL;
3236 ata_port_init(ap, host, ent, 0);
3237 ap->lock = shost->host_lock;
3238 devm_kfree(host->dev, ent);
3239 return ap;
3241 EXPORT_SYMBOL_GPL(ata_sas_port_alloc);
3244 * ata_sas_port_start - Set port up for dma.
3245 * @ap: Port to initialize
3247 * Called just after data structures for each port are
3248 * initialized. Allocates DMA pad.
3250 * May be used as the port_start() entry in ata_port_operations.
3252 * LOCKING:
3253 * Inherited from caller.
3255 int ata_sas_port_start(struct ata_port *ap)
3257 return ata_pad_alloc(ap, ap->dev);
3259 EXPORT_SYMBOL_GPL(ata_sas_port_start);
3262 * ata_port_stop - Undo ata_sas_port_start()
3263 * @ap: Port to shut down
3265 * Frees the DMA pad.
3267 * May be used as the port_stop() entry in ata_port_operations.
3269 * LOCKING:
3270 * Inherited from caller.
3273 void ata_sas_port_stop(struct ata_port *ap)
3275 ata_pad_free(ap, ap->dev);
3277 EXPORT_SYMBOL_GPL(ata_sas_port_stop);
3280 * ata_sas_port_init - Initialize a SATA device
3281 * @ap: SATA port to initialize
3283 * LOCKING:
3284 * PCI/etc. bus probe sem.
3286 * RETURNS:
3287 * Zero on success, non-zero on error.
3290 int ata_sas_port_init(struct ata_port *ap)
3292 int rc = ap->ops->port_start(ap);
3294 if (!rc)
3295 rc = ata_bus_probe(ap);
3297 return rc;
3299 EXPORT_SYMBOL_GPL(ata_sas_port_init);
3302 * ata_sas_port_destroy - Destroy a SATA port allocated by ata_sas_port_alloc
3303 * @ap: SATA port to destroy
3307 void ata_sas_port_destroy(struct ata_port *ap)
3309 if (ap->ops->port_stop)
3310 ap->ops->port_stop(ap);
3311 kfree(ap);
3313 EXPORT_SYMBOL_GPL(ata_sas_port_destroy);
3316 * ata_sas_slave_configure - Default slave_config routine for libata devices
3317 * @sdev: SCSI device to configure
3318 * @ap: ATA port to which SCSI device is attached
3320 * RETURNS:
3321 * Zero.
3324 int ata_sas_slave_configure(struct scsi_device *sdev, struct ata_port *ap)
3326 ata_scsi_sdev_config(sdev);
3327 ata_scsi_dev_config(sdev, ap->device);
3328 return 0;
3330 EXPORT_SYMBOL_GPL(ata_sas_slave_configure);
3333 * ata_sas_queuecmd - Issue SCSI cdb to libata-managed device
3334 * @cmd: SCSI command to be sent
3335 * @done: Completion function, called when command is complete
3336 * @ap: ATA port to which the command is being sent
3338 * RETURNS:
3339 * Return value from __ata_scsi_queuecmd() if @cmd can be queued,
3340 * 0 otherwise.
3343 int ata_sas_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *),
3344 struct ata_port *ap)
3346 int rc = 0;
3348 ata_scsi_dump_cdb(ap, cmd);
3350 if (likely(ata_scsi_dev_enabled(ap->device)))
3351 rc = __ata_scsi_queuecmd(cmd, done, ap->device);
3352 else {
3353 cmd->result = (DID_BAD_TARGET << 16);
3354 done(cmd);
3356 return rc;
3358 EXPORT_SYMBOL_GPL(ata_sas_queuecmd);