[PATCH] libata: implement ATA_EHI_RESUME_LINK
[linux-2.6/libata-dev.git] / drivers / scsi / libata-scsi.c
blobba3e515f2b9dda0ff87867cb754f33ecabe24e53
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, const u8 *scsicmd);
56 static struct ata_device * __ata_scsi_find_dev(struct ata_port *ap,
57 const struct scsi_device *scsidev);
58 static struct ata_device * ata_scsi_find_dev(struct ata_port *ap,
59 const struct scsi_device *scsidev);
60 static int ata_scsi_user_scan(struct Scsi_Host *shost, unsigned int channel,
61 unsigned int id, unsigned int lun);
64 #define RW_RECOVERY_MPAGE 0x1
65 #define RW_RECOVERY_MPAGE_LEN 12
66 #define CACHE_MPAGE 0x8
67 #define CACHE_MPAGE_LEN 20
68 #define CONTROL_MPAGE 0xa
69 #define CONTROL_MPAGE_LEN 12
70 #define ALL_MPAGES 0x3f
71 #define ALL_SUB_MPAGES 0xff
74 static const u8 def_rw_recovery_mpage[] = {
75 RW_RECOVERY_MPAGE,
76 RW_RECOVERY_MPAGE_LEN - 2,
77 (1 << 7) | /* AWRE, sat-r06 say it shall be 0 */
78 (1 << 6), /* ARRE (auto read reallocation) */
79 0, /* read retry count */
80 0, 0, 0, 0,
81 0, /* write retry count */
82 0, 0, 0
85 static const u8 def_cache_mpage[CACHE_MPAGE_LEN] = {
86 CACHE_MPAGE,
87 CACHE_MPAGE_LEN - 2,
88 0, /* contains WCE, needs to be 0 for logic */
89 0, 0, 0, 0, 0, 0, 0, 0, 0,
90 0, /* contains DRA, needs to be 0 for logic */
91 0, 0, 0, 0, 0, 0, 0
94 static const u8 def_control_mpage[CONTROL_MPAGE_LEN] = {
95 CONTROL_MPAGE,
96 CONTROL_MPAGE_LEN - 2,
97 2, /* DSENSE=0, GLTSD=1 */
98 0, /* [QAM+QERR may be 1, see 05-359r1] */
99 0, 0, 0, 0, 0xff, 0xff,
100 0, 30 /* extended self test time, see 05-359r1 */
104 * libata transport template. libata doesn't do real transport stuff.
105 * It just needs the eh_timed_out hook.
107 struct scsi_transport_template ata_scsi_transport_template = {
108 .eh_strategy_handler = ata_scsi_error,
109 .eh_timed_out = ata_scsi_timed_out,
110 .user_scan = ata_scsi_user_scan,
114 static void ata_scsi_invalid_field(struct scsi_cmnd *cmd,
115 void (*done)(struct scsi_cmnd *))
117 ata_scsi_set_sense(cmd, ILLEGAL_REQUEST, 0x24, 0x0);
118 /* "Invalid field in cbd" */
119 done(cmd);
123 * ata_std_bios_param - generic bios head/sector/cylinder calculator used by sd.
124 * @sdev: SCSI device for which BIOS geometry is to be determined
125 * @bdev: block device associated with @sdev
126 * @capacity: capacity of SCSI device
127 * @geom: location to which geometry will be output
129 * Generic bios head/sector/cylinder calculator
130 * used by sd. Most BIOSes nowadays expect a XXX/255/16 (CHS)
131 * mapping. Some situations may arise where the disk is not
132 * bootable if this is not used.
134 * LOCKING:
135 * Defined by the SCSI layer. We don't really care.
137 * RETURNS:
138 * Zero.
140 int ata_std_bios_param(struct scsi_device *sdev, struct block_device *bdev,
141 sector_t capacity, int geom[])
143 geom[0] = 255;
144 geom[1] = 63;
145 sector_div(capacity, 255*63);
146 geom[2] = capacity;
148 return 0;
152 * ata_cmd_ioctl - Handler for HDIO_DRIVE_CMD ioctl
153 * @scsidev: Device to which we are issuing command
154 * @arg: User provided data for issuing command
156 * LOCKING:
157 * Defined by the SCSI layer. We don't really care.
159 * RETURNS:
160 * Zero on success, negative errno on error.
163 int ata_cmd_ioctl(struct scsi_device *scsidev, void __user *arg)
165 int rc = 0;
166 u8 scsi_cmd[MAX_COMMAND_SIZE];
167 u8 args[4], *argbuf = NULL;
168 int argsize = 0;
169 struct scsi_sense_hdr sshdr;
170 enum dma_data_direction data_dir;
172 if (arg == NULL)
173 return -EINVAL;
175 if (copy_from_user(args, arg, sizeof(args)))
176 return -EFAULT;
178 memset(scsi_cmd, 0, sizeof(scsi_cmd));
180 if (args[3]) {
181 argsize = SECTOR_SIZE * args[3];
182 argbuf = kmalloc(argsize, GFP_KERNEL);
183 if (argbuf == NULL) {
184 rc = -ENOMEM;
185 goto error;
188 scsi_cmd[1] = (4 << 1); /* PIO Data-in */
189 scsi_cmd[2] = 0x0e; /* no off.line or cc, read from dev,
190 block count in sector count field */
191 data_dir = DMA_FROM_DEVICE;
192 } else {
193 scsi_cmd[1] = (3 << 1); /* Non-data */
194 /* scsi_cmd[2] is already 0 -- no off.line, cc, or data xfer */
195 data_dir = DMA_NONE;
198 scsi_cmd[0] = ATA_16;
200 scsi_cmd[4] = args[2];
201 if (args[0] == WIN_SMART) { /* hack -- ide driver does this too... */
202 scsi_cmd[6] = args[3];
203 scsi_cmd[8] = args[1];
204 scsi_cmd[10] = 0x4f;
205 scsi_cmd[12] = 0xc2;
206 } else {
207 scsi_cmd[6] = args[1];
209 scsi_cmd[14] = args[0];
211 /* Good values for timeout and retries? Values below
212 from scsi_ioctl_send_command() for default case... */
213 if (scsi_execute_req(scsidev, scsi_cmd, data_dir, argbuf, argsize,
214 &sshdr, (10*HZ), 5)) {
215 rc = -EIO;
216 goto error;
219 /* Need code to retrieve data from check condition? */
221 if ((argbuf)
222 && copy_to_user(arg + sizeof(args), argbuf, argsize))
223 rc = -EFAULT;
224 error:
225 kfree(argbuf);
226 return rc;
230 * ata_task_ioctl - Handler for HDIO_DRIVE_TASK ioctl
231 * @scsidev: Device to which we are issuing command
232 * @arg: User provided data for issuing command
234 * LOCKING:
235 * Defined by the SCSI layer. We don't really care.
237 * RETURNS:
238 * Zero on success, negative errno on error.
240 int ata_task_ioctl(struct scsi_device *scsidev, void __user *arg)
242 int rc = 0;
243 u8 scsi_cmd[MAX_COMMAND_SIZE];
244 u8 args[7];
245 struct scsi_sense_hdr sshdr;
247 if (arg == NULL)
248 return -EINVAL;
250 if (copy_from_user(args, arg, sizeof(args)))
251 return -EFAULT;
253 memset(scsi_cmd, 0, sizeof(scsi_cmd));
254 scsi_cmd[0] = ATA_16;
255 scsi_cmd[1] = (3 << 1); /* Non-data */
256 /* scsi_cmd[2] is already 0 -- no off.line, cc, or data xfer */
257 scsi_cmd[4] = args[1];
258 scsi_cmd[6] = args[2];
259 scsi_cmd[8] = args[3];
260 scsi_cmd[10] = args[4];
261 scsi_cmd[12] = args[5];
262 scsi_cmd[14] = args[0];
264 /* Good values for timeout and retries? Values below
265 from scsi_ioctl_send_command() for default case... */
266 if (scsi_execute_req(scsidev, scsi_cmd, DMA_NONE, NULL, 0, &sshdr,
267 (10*HZ), 5))
268 rc = -EIO;
270 /* Need code to retrieve data from check condition? */
271 return rc;
274 int ata_scsi_ioctl(struct scsi_device *scsidev, int cmd, void __user *arg)
276 int val = -EINVAL, rc = -EINVAL;
278 switch (cmd) {
279 case ATA_IOC_GET_IO32:
280 val = 0;
281 if (copy_to_user(arg, &val, 1))
282 return -EFAULT;
283 return 0;
285 case ATA_IOC_SET_IO32:
286 val = (unsigned long) arg;
287 if (val != 0)
288 return -EINVAL;
289 return 0;
291 case HDIO_DRIVE_CMD:
292 if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
293 return -EACCES;
294 return ata_cmd_ioctl(scsidev, arg);
296 case HDIO_DRIVE_TASK:
297 if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
298 return -EACCES;
299 return ata_task_ioctl(scsidev, arg);
301 default:
302 rc = -ENOTTY;
303 break;
306 return rc;
310 * ata_scsi_qc_new - acquire new ata_queued_cmd reference
311 * @dev: ATA device to which the new command is attached
312 * @cmd: SCSI command that originated this ATA command
313 * @done: SCSI command completion function
315 * Obtain a reference to an unused ata_queued_cmd structure,
316 * which is the basic libata structure representing a single
317 * ATA command sent to the hardware.
319 * If a command was available, fill in the SCSI-specific
320 * portions of the structure with information on the
321 * current command.
323 * LOCKING:
324 * spin_lock_irqsave(host_set lock)
326 * RETURNS:
327 * Command allocated, or %NULL if none available.
329 struct ata_queued_cmd *ata_scsi_qc_new(struct ata_device *dev,
330 struct scsi_cmnd *cmd,
331 void (*done)(struct scsi_cmnd *))
333 struct ata_queued_cmd *qc;
335 qc = ata_qc_new_init(dev);
336 if (qc) {
337 qc->scsicmd = cmd;
338 qc->scsidone = done;
340 if (cmd->use_sg) {
341 qc->__sg = (struct scatterlist *) cmd->request_buffer;
342 qc->n_elem = cmd->use_sg;
343 } else {
344 qc->__sg = &qc->sgent;
345 qc->n_elem = 1;
347 } else {
348 cmd->result = (DID_OK << 16) | (QUEUE_FULL << 1);
349 done(cmd);
352 return qc;
356 * ata_dump_status - user friendly display of error info
357 * @id: id of the port in question
358 * @tf: ptr to filled out taskfile
360 * Decode and dump the ATA error/status registers for the user so
361 * that they have some idea what really happened at the non
362 * make-believe layer.
364 * LOCKING:
365 * inherited from caller
367 void ata_dump_status(unsigned id, struct ata_taskfile *tf)
369 u8 stat = tf->command, err = tf->feature;
371 printk(KERN_WARNING "ata%u: status=0x%02x { ", id, stat);
372 if (stat & ATA_BUSY) {
373 printk("Busy }\n"); /* Data is not valid in this case */
374 } else {
375 if (stat & 0x40) printk("DriveReady ");
376 if (stat & 0x20) printk("DeviceFault ");
377 if (stat & 0x10) printk("SeekComplete ");
378 if (stat & 0x08) printk("DataRequest ");
379 if (stat & 0x04) printk("CorrectedError ");
380 if (stat & 0x02) printk("Index ");
381 if (stat & 0x01) printk("Error ");
382 printk("}\n");
384 if (err) {
385 printk(KERN_WARNING "ata%u: error=0x%02x { ", id, err);
386 if (err & 0x04) printk("DriveStatusError ");
387 if (err & 0x80) {
388 if (err & 0x04) printk("BadCRC ");
389 else printk("Sector ");
391 if (err & 0x40) printk("UncorrectableError ");
392 if (err & 0x10) printk("SectorIdNotFound ");
393 if (err & 0x02) printk("TrackZeroNotFound ");
394 if (err & 0x01) printk("AddrMarkNotFound ");
395 printk("}\n");
400 int ata_scsi_device_resume(struct scsi_device *sdev)
402 struct ata_port *ap = ata_shost_to_port(sdev->host);
403 struct ata_device *dev = __ata_scsi_find_dev(ap, sdev);
405 return ata_device_resume(dev);
408 int ata_scsi_device_suspend(struct scsi_device *sdev, pm_message_t state)
410 struct ata_port *ap = ata_shost_to_port(sdev->host);
411 struct ata_device *dev = __ata_scsi_find_dev(ap, sdev);
413 return ata_device_suspend(dev, state);
417 * ata_to_sense_error - convert ATA error to SCSI error
418 * @id: ATA device number
419 * @drv_stat: value contained in ATA status register
420 * @drv_err: value contained in ATA error register
421 * @sk: the sense key we'll fill out
422 * @asc: the additional sense code we'll fill out
423 * @ascq: the additional sense code qualifier we'll fill out
424 * @verbose: be verbose
426 * Converts an ATA error into a SCSI error. Fill out pointers to
427 * SK, ASC, and ASCQ bytes for later use in fixed or descriptor
428 * format sense blocks.
430 * LOCKING:
431 * spin_lock_irqsave(host_set lock)
433 void ata_to_sense_error(unsigned id, u8 drv_stat, u8 drv_err, u8 *sk, u8 *asc,
434 u8 *ascq, int verbose)
436 int i;
438 /* Based on the 3ware driver translation table */
439 static const unsigned char sense_table[][4] = {
440 /* BBD|ECC|ID|MAR */
441 {0xd1, ABORTED_COMMAND, 0x00, 0x00}, // Device busy Aborted command
442 /* BBD|ECC|ID */
443 {0xd0, ABORTED_COMMAND, 0x00, 0x00}, // Device busy Aborted command
444 /* ECC|MC|MARK */
445 {0x61, HARDWARE_ERROR, 0x00, 0x00}, // Device fault Hardware error
446 /* ICRC|ABRT */ /* NB: ICRC & !ABRT is BBD */
447 {0x84, ABORTED_COMMAND, 0x47, 0x00}, // Data CRC error SCSI parity error
448 /* MC|ID|ABRT|TRK0|MARK */
449 {0x37, NOT_READY, 0x04, 0x00}, // Unit offline Not ready
450 /* MCR|MARK */
451 {0x09, NOT_READY, 0x04, 0x00}, // Unrecovered disk error Not ready
452 /* Bad address mark */
453 {0x01, MEDIUM_ERROR, 0x13, 0x00}, // Address mark not found Address mark not found for data field
454 /* TRK0 */
455 {0x02, HARDWARE_ERROR, 0x00, 0x00}, // Track 0 not found Hardware error
456 /* Abort & !ICRC */
457 {0x04, ABORTED_COMMAND, 0x00, 0x00}, // Aborted command Aborted command
458 /* Media change request */
459 {0x08, NOT_READY, 0x04, 0x00}, // Media change request FIXME: faking offline
460 /* SRV */
461 {0x10, ABORTED_COMMAND, 0x14, 0x00}, // ID not found Recorded entity not found
462 /* Media change */
463 {0x08, NOT_READY, 0x04, 0x00}, // Media change FIXME: faking offline
464 /* ECC */
465 {0x40, MEDIUM_ERROR, 0x11, 0x04}, // Uncorrectable ECC error Unrecovered read error
466 /* BBD - block marked bad */
467 {0x80, MEDIUM_ERROR, 0x11, 0x04}, // Block marked bad Medium error, unrecovered read error
468 {0xFF, 0xFF, 0xFF, 0xFF}, // END mark
470 static const unsigned char stat_table[][4] = {
471 /* Must be first because BUSY means no other bits valid */
472 {0x80, ABORTED_COMMAND, 0x47, 0x00}, // Busy, fake parity for now
473 {0x20, HARDWARE_ERROR, 0x00, 0x00}, // Device fault
474 {0x08, ABORTED_COMMAND, 0x47, 0x00}, // Timed out in xfer, fake parity for now
475 {0x04, RECOVERED_ERROR, 0x11, 0x00}, // Recovered ECC error Medium error, recovered
476 {0xFF, 0xFF, 0xFF, 0xFF}, // END mark
480 * Is this an error we can process/parse
482 if (drv_stat & ATA_BUSY) {
483 drv_err = 0; /* Ignore the err bits, they're invalid */
486 if (drv_err) {
487 /* Look for drv_err */
488 for (i = 0; sense_table[i][0] != 0xFF; i++) {
489 /* Look for best matches first */
490 if ((sense_table[i][0] & drv_err) ==
491 sense_table[i][0]) {
492 *sk = sense_table[i][1];
493 *asc = sense_table[i][2];
494 *ascq = sense_table[i][3];
495 goto translate_done;
498 /* No immediate match */
499 if (verbose)
500 printk(KERN_WARNING "ata%u: no sense translation for "
501 "error 0x%02x\n", id, drv_err);
504 /* Fall back to interpreting status bits */
505 for (i = 0; stat_table[i][0] != 0xFF; i++) {
506 if (stat_table[i][0] & drv_stat) {
507 *sk = stat_table[i][1];
508 *asc = stat_table[i][2];
509 *ascq = stat_table[i][3];
510 goto translate_done;
513 /* No error? Undecoded? */
514 if (verbose)
515 printk(KERN_WARNING "ata%u: no sense translation for "
516 "status: 0x%02x\n", id, drv_stat);
518 /* We need a sensible error return here, which is tricky, and one
519 that won't cause people to do things like return a disk wrongly */
520 *sk = ABORTED_COMMAND;
521 *asc = 0x00;
522 *ascq = 0x00;
524 translate_done:
525 if (verbose)
526 printk(KERN_ERR "ata%u: translated ATA stat/err 0x%02x/%02x "
527 "to SCSI SK/ASC/ASCQ 0x%x/%02x/%02x\n",
528 id, drv_stat, drv_err, *sk, *asc, *ascq);
529 return;
533 * ata_gen_ata_desc_sense - Generate check condition sense block.
534 * @qc: Command that completed.
536 * This function is specific to the ATA descriptor format sense
537 * block specified for the ATA pass through commands. Regardless
538 * of whether the command errored or not, return a sense
539 * block. Copy all controller registers into the sense
540 * block. Clear sense key, ASC & ASCQ if there is no error.
542 * LOCKING:
543 * spin_lock_irqsave(host_set lock)
545 void ata_gen_ata_desc_sense(struct ata_queued_cmd *qc)
547 struct scsi_cmnd *cmd = qc->scsicmd;
548 struct ata_taskfile *tf = &qc->result_tf;
549 unsigned char *sb = cmd->sense_buffer;
550 unsigned char *desc = sb + 8;
551 int verbose = qc->ap->ops->error_handler == NULL;
553 memset(sb, 0, SCSI_SENSE_BUFFERSIZE);
555 cmd->result = (DRIVER_SENSE << 24) | SAM_STAT_CHECK_CONDITION;
558 * Use ata_to_sense_error() to map status register bits
559 * onto sense key, asc & ascq.
561 if (qc->err_mask ||
562 tf->command & (ATA_BUSY | ATA_DF | ATA_ERR | ATA_DRQ)) {
563 ata_to_sense_error(qc->ap->id, tf->command, tf->feature,
564 &sb[1], &sb[2], &sb[3], verbose);
565 sb[1] &= 0x0f;
569 * Sense data is current and format is descriptor.
571 sb[0] = 0x72;
573 desc[0] = 0x09;
576 * Set length of additional sense data.
577 * Since we only populate descriptor 0, the total
578 * length is the same (fixed) length as descriptor 0.
580 desc[1] = sb[7] = 14;
583 * Copy registers into sense buffer.
585 desc[2] = 0x00;
586 desc[3] = tf->feature; /* == error reg */
587 desc[5] = tf->nsect;
588 desc[7] = tf->lbal;
589 desc[9] = tf->lbam;
590 desc[11] = tf->lbah;
591 desc[12] = tf->device;
592 desc[13] = tf->command; /* == status reg */
595 * Fill in Extend bit, and the high order bytes
596 * if applicable.
598 if (tf->flags & ATA_TFLAG_LBA48) {
599 desc[2] |= 0x01;
600 desc[4] = tf->hob_nsect;
601 desc[6] = tf->hob_lbal;
602 desc[8] = tf->hob_lbam;
603 desc[10] = tf->hob_lbah;
608 * ata_gen_fixed_sense - generate a SCSI fixed sense block
609 * @qc: Command that we are erroring out
611 * Leverage ata_to_sense_error() to give us the codes. Fit our
612 * LBA in here if there's room.
614 * LOCKING:
615 * inherited from caller
617 void ata_gen_fixed_sense(struct ata_queued_cmd *qc)
619 struct scsi_cmnd *cmd = qc->scsicmd;
620 struct ata_taskfile *tf = &qc->result_tf;
621 unsigned char *sb = cmd->sense_buffer;
622 int verbose = qc->ap->ops->error_handler == NULL;
624 memset(sb, 0, SCSI_SENSE_BUFFERSIZE);
626 cmd->result = (DRIVER_SENSE << 24) | SAM_STAT_CHECK_CONDITION;
629 * Use ata_to_sense_error() to map status register bits
630 * onto sense key, asc & ascq.
632 if (qc->err_mask ||
633 tf->command & (ATA_BUSY | ATA_DF | ATA_ERR | ATA_DRQ)) {
634 ata_to_sense_error(qc->ap->id, tf->command, tf->feature,
635 &sb[2], &sb[12], &sb[13], verbose);
636 sb[2] &= 0x0f;
639 sb[0] = 0x70;
640 sb[7] = 0x0a;
642 if (tf->flags & ATA_TFLAG_LBA48) {
643 /* TODO: find solution for LBA48 descriptors */
646 else if (tf->flags & ATA_TFLAG_LBA) {
647 /* A small (28b) LBA will fit in the 32b info field */
648 sb[0] |= 0x80; /* set valid bit */
649 sb[3] = tf->device & 0x0f;
650 sb[4] = tf->lbah;
651 sb[5] = tf->lbam;
652 sb[6] = tf->lbal;
655 else {
656 /* TODO: C/H/S */
660 static void ata_scsi_sdev_config(struct scsi_device *sdev)
662 sdev->use_10_for_rw = 1;
663 sdev->use_10_for_ms = 1;
666 static void ata_scsi_dev_config(struct scsi_device *sdev,
667 struct ata_device *dev)
669 unsigned int max_sectors;
671 /* TODO: 2048 is an arbitrary number, not the
672 * hardware maximum. This should be increased to
673 * 65534 when Jens Axboe's patch for dynamically
674 * determining max_sectors is merged.
676 max_sectors = ATA_MAX_SECTORS;
677 if (dev->flags & ATA_DFLAG_LBA48)
678 max_sectors = ATA_MAX_SECTORS_LBA48;
679 if (dev->max_sectors)
680 max_sectors = dev->max_sectors;
682 blk_queue_max_sectors(sdev->request_queue, max_sectors);
685 * SATA DMA transfers must be multiples of 4 byte, so
686 * we need to pad ATAPI transfers using an extra sg.
687 * Decrement max hw segments accordingly.
689 if (dev->class == ATA_DEV_ATAPI) {
690 request_queue_t *q = sdev->request_queue;
691 blk_queue_max_hw_segments(q, q->max_hw_segments - 1);
694 if (dev->flags & ATA_DFLAG_NCQ) {
695 int depth;
697 depth = min(sdev->host->can_queue, ata_id_queue_depth(dev->id));
698 depth = min(ATA_MAX_QUEUE - 1, depth);
699 scsi_adjust_queue_depth(sdev, MSG_SIMPLE_TAG, depth);
704 * ata_scsi_slave_config - Set SCSI device attributes
705 * @sdev: SCSI device to examine
707 * This is called before we actually start reading
708 * and writing to the device, to configure certain
709 * SCSI mid-layer behaviors.
711 * LOCKING:
712 * Defined by SCSI layer. We don't really care.
715 int ata_scsi_slave_config(struct scsi_device *sdev)
717 struct ata_port *ap = ata_shost_to_port(sdev->host);
718 struct ata_device *dev = __ata_scsi_find_dev(ap, sdev);
720 ata_scsi_sdev_config(sdev);
722 blk_queue_max_phys_segments(sdev->request_queue, LIBATA_MAX_PRD);
724 if (dev)
725 ata_scsi_dev_config(sdev, dev);
727 return 0; /* scsi layer doesn't check return value, sigh */
731 * ata_scsi_slave_destroy - SCSI device is about to be destroyed
732 * @sdev: SCSI device to be destroyed
734 * @sdev is about to be destroyed for hot/warm unplugging. If
735 * this unplugging was initiated by libata as indicated by NULL
736 * dev->sdev, this function doesn't have to do anything.
737 * Otherwise, SCSI layer initiated warm-unplug is in progress.
738 * Clear dev->sdev, schedule the device for ATA detach and invoke
739 * EH.
741 * LOCKING:
742 * Defined by SCSI layer. We don't really care.
744 void ata_scsi_slave_destroy(struct scsi_device *sdev)
746 struct ata_port *ap = ata_shost_to_port(sdev->host);
747 unsigned long flags;
748 struct ata_device *dev;
750 if (!ap->ops->error_handler)
751 return;
753 spin_lock_irqsave(ap->lock, flags);
754 dev = __ata_scsi_find_dev(ap, sdev);
755 if (dev && dev->sdev) {
756 /* SCSI device already in CANCEL state, no need to offline it */
757 dev->sdev = NULL;
758 dev->flags |= ATA_DFLAG_DETACH;
759 ata_port_schedule_eh(ap);
761 spin_unlock_irqrestore(ap->lock, flags);
765 * ata_scsi_change_queue_depth - SCSI callback for queue depth config
766 * @sdev: SCSI device to configure queue depth for
767 * @queue_depth: new queue depth
769 * This is libata standard hostt->change_queue_depth callback.
770 * SCSI will call into this callback when user tries to set queue
771 * depth via sysfs.
773 * LOCKING:
774 * SCSI layer (we don't care)
776 * RETURNS:
777 * Newly configured queue depth.
779 int ata_scsi_change_queue_depth(struct scsi_device *sdev, int queue_depth)
781 struct ata_port *ap = ata_shost_to_port(sdev->host);
782 struct ata_device *dev;
783 int max_depth;
785 if (queue_depth < 1)
786 return sdev->queue_depth;
788 dev = ata_scsi_find_dev(ap, sdev);
789 if (!dev || !ata_dev_enabled(dev))
790 return sdev->queue_depth;
792 max_depth = min(sdev->host->can_queue, ata_id_queue_depth(dev->id));
793 max_depth = min(ATA_MAX_QUEUE - 1, max_depth);
794 if (queue_depth > max_depth)
795 queue_depth = max_depth;
797 scsi_adjust_queue_depth(sdev, MSG_SIMPLE_TAG, queue_depth);
798 return queue_depth;
802 * ata_scsi_start_stop_xlat - Translate SCSI START STOP UNIT command
803 * @qc: Storage for translated ATA taskfile
804 * @scsicmd: SCSI command to translate
806 * Sets up an ATA taskfile to issue STANDBY (to stop) or READ VERIFY
807 * (to start). Perhaps these commands should be preceded by
808 * CHECK POWER MODE to see what power mode the device is already in.
809 * [See SAT revision 5 at www.t10.org]
811 * LOCKING:
812 * spin_lock_irqsave(host_set lock)
814 * RETURNS:
815 * Zero on success, non-zero on error.
818 static unsigned int ata_scsi_start_stop_xlat(struct ata_queued_cmd *qc,
819 const u8 *scsicmd)
821 struct ata_taskfile *tf = &qc->tf;
823 tf->flags |= ATA_TFLAG_DEVICE | ATA_TFLAG_ISADDR;
824 tf->protocol = ATA_PROT_NODATA;
825 if (scsicmd[1] & 0x1) {
826 ; /* ignore IMMED bit, violates sat-r05 */
828 if (scsicmd[4] & 0x2)
829 goto invalid_fld; /* LOEJ bit set not supported */
830 if (((scsicmd[4] >> 4) & 0xf) != 0)
831 goto invalid_fld; /* power conditions not supported */
832 if (scsicmd[4] & 0x1) {
833 tf->nsect = 1; /* 1 sector, lba=0 */
835 if (qc->dev->flags & ATA_DFLAG_LBA) {
836 tf->flags |= ATA_TFLAG_LBA;
838 tf->lbah = 0x0;
839 tf->lbam = 0x0;
840 tf->lbal = 0x0;
841 tf->device |= ATA_LBA;
842 } else {
843 /* CHS */
844 tf->lbal = 0x1; /* sect */
845 tf->lbam = 0x0; /* cyl low */
846 tf->lbah = 0x0; /* cyl high */
849 tf->command = ATA_CMD_VERIFY; /* READ VERIFY */
850 } else {
851 tf->nsect = 0; /* time period value (0 implies now) */
852 tf->command = ATA_CMD_STANDBY;
853 /* Consider: ATA STANDBY IMMEDIATE command */
856 * Standby and Idle condition timers could be implemented but that
857 * would require libata to implement the Power condition mode page
858 * and allow the user to change it. Changing mode pages requires
859 * MODE SELECT to be implemented.
862 return 0;
864 invalid_fld:
865 ata_scsi_set_sense(qc->scsicmd, ILLEGAL_REQUEST, 0x24, 0x0);
866 /* "Invalid field in cbd" */
867 return 1;
872 * ata_scsi_flush_xlat - Translate SCSI SYNCHRONIZE CACHE command
873 * @qc: Storage for translated ATA taskfile
874 * @scsicmd: SCSI command to translate (ignored)
876 * Sets up an ATA taskfile to issue FLUSH CACHE or
877 * FLUSH CACHE EXT.
879 * LOCKING:
880 * spin_lock_irqsave(host_set lock)
882 * RETURNS:
883 * Zero on success, non-zero on error.
886 static unsigned int ata_scsi_flush_xlat(struct ata_queued_cmd *qc, const u8 *scsicmd)
888 struct ata_taskfile *tf = &qc->tf;
890 tf->flags |= ATA_TFLAG_DEVICE;
891 tf->protocol = ATA_PROT_NODATA;
893 if ((qc->dev->flags & ATA_DFLAG_LBA48) &&
894 (ata_id_has_flush_ext(qc->dev->id)))
895 tf->command = ATA_CMD_FLUSH_EXT;
896 else
897 tf->command = ATA_CMD_FLUSH;
899 return 0;
903 * scsi_6_lba_len - Get LBA and transfer length
904 * @scsicmd: SCSI command to translate
906 * Calculate LBA and transfer length for 6-byte commands.
908 * RETURNS:
909 * @plba: the LBA
910 * @plen: the transfer length
913 static void scsi_6_lba_len(const u8 *scsicmd, u64 *plba, u32 *plen)
915 u64 lba = 0;
916 u32 len = 0;
918 VPRINTK("six-byte command\n");
920 lba |= ((u64)scsicmd[2]) << 8;
921 lba |= ((u64)scsicmd[3]);
923 len |= ((u32)scsicmd[4]);
925 *plba = lba;
926 *plen = len;
930 * scsi_10_lba_len - Get LBA and transfer length
931 * @scsicmd: SCSI command to translate
933 * Calculate LBA and transfer length for 10-byte commands.
935 * RETURNS:
936 * @plba: the LBA
937 * @plen: the transfer length
940 static void scsi_10_lba_len(const u8 *scsicmd, u64 *plba, u32 *plen)
942 u64 lba = 0;
943 u32 len = 0;
945 VPRINTK("ten-byte command\n");
947 lba |= ((u64)scsicmd[2]) << 24;
948 lba |= ((u64)scsicmd[3]) << 16;
949 lba |= ((u64)scsicmd[4]) << 8;
950 lba |= ((u64)scsicmd[5]);
952 len |= ((u32)scsicmd[7]) << 8;
953 len |= ((u32)scsicmd[8]);
955 *plba = lba;
956 *plen = len;
960 * scsi_16_lba_len - Get LBA and transfer length
961 * @scsicmd: SCSI command to translate
963 * Calculate LBA and transfer length for 16-byte commands.
965 * RETURNS:
966 * @plba: the LBA
967 * @plen: the transfer length
970 static void scsi_16_lba_len(const u8 *scsicmd, u64 *plba, u32 *plen)
972 u64 lba = 0;
973 u32 len = 0;
975 VPRINTK("sixteen-byte command\n");
977 lba |= ((u64)scsicmd[2]) << 56;
978 lba |= ((u64)scsicmd[3]) << 48;
979 lba |= ((u64)scsicmd[4]) << 40;
980 lba |= ((u64)scsicmd[5]) << 32;
981 lba |= ((u64)scsicmd[6]) << 24;
982 lba |= ((u64)scsicmd[7]) << 16;
983 lba |= ((u64)scsicmd[8]) << 8;
984 lba |= ((u64)scsicmd[9]);
986 len |= ((u32)scsicmd[10]) << 24;
987 len |= ((u32)scsicmd[11]) << 16;
988 len |= ((u32)scsicmd[12]) << 8;
989 len |= ((u32)scsicmd[13]);
991 *plba = lba;
992 *plen = len;
996 * ata_scsi_verify_xlat - Translate SCSI VERIFY command into an ATA one
997 * @qc: Storage for translated ATA taskfile
998 * @scsicmd: SCSI command to translate
1000 * Converts SCSI VERIFY command to an ATA READ VERIFY command.
1002 * LOCKING:
1003 * spin_lock_irqsave(host_set lock)
1005 * RETURNS:
1006 * Zero on success, non-zero on error.
1009 static unsigned int ata_scsi_verify_xlat(struct ata_queued_cmd *qc, const u8 *scsicmd)
1011 struct ata_taskfile *tf = &qc->tf;
1012 struct ata_device *dev = qc->dev;
1013 u64 dev_sectors = qc->dev->n_sectors;
1014 u64 block;
1015 u32 n_block;
1017 tf->flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
1018 tf->protocol = ATA_PROT_NODATA;
1020 if (scsicmd[0] == VERIFY)
1021 scsi_10_lba_len(scsicmd, &block, &n_block);
1022 else if (scsicmd[0] == VERIFY_16)
1023 scsi_16_lba_len(scsicmd, &block, &n_block);
1024 else
1025 goto invalid_fld;
1027 if (!n_block)
1028 goto nothing_to_do;
1029 if (block >= dev_sectors)
1030 goto out_of_range;
1031 if ((block + n_block) > dev_sectors)
1032 goto out_of_range;
1034 if (dev->flags & ATA_DFLAG_LBA) {
1035 tf->flags |= ATA_TFLAG_LBA;
1037 if (lba_28_ok(block, n_block)) {
1038 /* use LBA28 */
1039 tf->command = ATA_CMD_VERIFY;
1040 tf->device |= (block >> 24) & 0xf;
1041 } else if (lba_48_ok(block, n_block)) {
1042 if (!(dev->flags & ATA_DFLAG_LBA48))
1043 goto out_of_range;
1045 /* use LBA48 */
1046 tf->flags |= ATA_TFLAG_LBA48;
1047 tf->command = ATA_CMD_VERIFY_EXT;
1049 tf->hob_nsect = (n_block >> 8) & 0xff;
1051 tf->hob_lbah = (block >> 40) & 0xff;
1052 tf->hob_lbam = (block >> 32) & 0xff;
1053 tf->hob_lbal = (block >> 24) & 0xff;
1054 } else
1055 /* request too large even for LBA48 */
1056 goto out_of_range;
1058 tf->nsect = n_block & 0xff;
1060 tf->lbah = (block >> 16) & 0xff;
1061 tf->lbam = (block >> 8) & 0xff;
1062 tf->lbal = block & 0xff;
1064 tf->device |= ATA_LBA;
1065 } else {
1066 /* CHS */
1067 u32 sect, head, cyl, track;
1069 if (!lba_28_ok(block, n_block))
1070 goto out_of_range;
1072 /* Convert LBA to CHS */
1073 track = (u32)block / dev->sectors;
1074 cyl = track / dev->heads;
1075 head = track % dev->heads;
1076 sect = (u32)block % dev->sectors + 1;
1078 DPRINTK("block %u track %u cyl %u head %u sect %u\n",
1079 (u32)block, track, cyl, head, sect);
1081 /* Check whether the converted CHS can fit.
1082 Cylinder: 0-65535
1083 Head: 0-15
1084 Sector: 1-255*/
1085 if ((cyl >> 16) || (head >> 4) || (sect >> 8) || (!sect))
1086 goto out_of_range;
1088 tf->command = ATA_CMD_VERIFY;
1089 tf->nsect = n_block & 0xff; /* Sector count 0 means 256 sectors */
1090 tf->lbal = sect;
1091 tf->lbam = cyl;
1092 tf->lbah = cyl >> 8;
1093 tf->device |= head;
1096 return 0;
1098 invalid_fld:
1099 ata_scsi_set_sense(qc->scsicmd, ILLEGAL_REQUEST, 0x24, 0x0);
1100 /* "Invalid field in cbd" */
1101 return 1;
1103 out_of_range:
1104 ata_scsi_set_sense(qc->scsicmd, ILLEGAL_REQUEST, 0x21, 0x0);
1105 /* "Logical Block Address out of range" */
1106 return 1;
1108 nothing_to_do:
1109 qc->scsicmd->result = SAM_STAT_GOOD;
1110 return 1;
1114 * ata_scsi_rw_xlat - Translate SCSI r/w command into an ATA one
1115 * @qc: Storage for translated ATA taskfile
1116 * @scsicmd: SCSI command to translate
1118 * Converts any of six SCSI read/write commands into the
1119 * ATA counterpart, including starting sector (LBA),
1120 * sector count, and taking into account the device's LBA48
1121 * support.
1123 * Commands %READ_6, %READ_10, %READ_16, %WRITE_6, %WRITE_10, and
1124 * %WRITE_16 are currently supported.
1126 * LOCKING:
1127 * spin_lock_irqsave(host_set lock)
1129 * RETURNS:
1130 * Zero on success, non-zero on error.
1133 static unsigned int ata_scsi_rw_xlat(struct ata_queued_cmd *qc, const u8 *scsicmd)
1135 struct ata_taskfile *tf = &qc->tf;
1136 struct ata_device *dev = qc->dev;
1137 u64 block;
1138 u32 n_block;
1140 qc->flags |= ATA_QCFLAG_IO;
1141 tf->flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
1143 if (scsicmd[0] == WRITE_10 || scsicmd[0] == WRITE_6 ||
1144 scsicmd[0] == WRITE_16)
1145 tf->flags |= ATA_TFLAG_WRITE;
1147 /* Calculate the SCSI LBA, transfer length and FUA. */
1148 switch (scsicmd[0]) {
1149 case READ_10:
1150 case WRITE_10:
1151 scsi_10_lba_len(scsicmd, &block, &n_block);
1152 if (unlikely(scsicmd[1] & (1 << 3)))
1153 tf->flags |= ATA_TFLAG_FUA;
1154 break;
1155 case READ_6:
1156 case WRITE_6:
1157 scsi_6_lba_len(scsicmd, &block, &n_block);
1159 /* for 6-byte r/w commands, transfer length 0
1160 * means 256 blocks of data, not 0 block.
1162 if (!n_block)
1163 n_block = 256;
1164 break;
1165 case READ_16:
1166 case WRITE_16:
1167 scsi_16_lba_len(scsicmd, &block, &n_block);
1168 if (unlikely(scsicmd[1] & (1 << 3)))
1169 tf->flags |= ATA_TFLAG_FUA;
1170 break;
1171 default:
1172 DPRINTK("no-byte command\n");
1173 goto invalid_fld;
1176 /* Check and compose ATA command */
1177 if (!n_block)
1178 /* For 10-byte and 16-byte SCSI R/W commands, transfer
1179 * length 0 means transfer 0 block of data.
1180 * However, for ATA R/W commands, sector count 0 means
1181 * 256 or 65536 sectors, not 0 sectors as in SCSI.
1183 * WARNING: one or two older ATA drives treat 0 as 0...
1185 goto nothing_to_do;
1187 if ((dev->flags & (ATA_DFLAG_PIO | ATA_DFLAG_NCQ)) == ATA_DFLAG_NCQ) {
1188 /* yay, NCQ */
1189 if (!lba_48_ok(block, n_block))
1190 goto out_of_range;
1192 tf->protocol = ATA_PROT_NCQ;
1193 tf->flags |= ATA_TFLAG_LBA | ATA_TFLAG_LBA48;
1195 if (tf->flags & ATA_TFLAG_WRITE)
1196 tf->command = ATA_CMD_FPDMA_WRITE;
1197 else
1198 tf->command = ATA_CMD_FPDMA_READ;
1200 qc->nsect = n_block;
1202 tf->nsect = qc->tag << 3;
1203 tf->hob_feature = (n_block >> 8) & 0xff;
1204 tf->feature = n_block & 0xff;
1206 tf->hob_lbah = (block >> 40) & 0xff;
1207 tf->hob_lbam = (block >> 32) & 0xff;
1208 tf->hob_lbal = (block >> 24) & 0xff;
1209 tf->lbah = (block >> 16) & 0xff;
1210 tf->lbam = (block >> 8) & 0xff;
1211 tf->lbal = block & 0xff;
1213 tf->device = 1 << 6;
1214 if (tf->flags & ATA_TFLAG_FUA)
1215 tf->device |= 1 << 7;
1216 } else if (dev->flags & ATA_DFLAG_LBA) {
1217 tf->flags |= ATA_TFLAG_LBA;
1219 if (lba_28_ok(block, n_block)) {
1220 /* use LBA28 */
1221 tf->device |= (block >> 24) & 0xf;
1222 } else if (lba_48_ok(block, n_block)) {
1223 if (!(dev->flags & ATA_DFLAG_LBA48))
1224 goto out_of_range;
1226 /* use LBA48 */
1227 tf->flags |= ATA_TFLAG_LBA48;
1229 tf->hob_nsect = (n_block >> 8) & 0xff;
1231 tf->hob_lbah = (block >> 40) & 0xff;
1232 tf->hob_lbam = (block >> 32) & 0xff;
1233 tf->hob_lbal = (block >> 24) & 0xff;
1234 } else
1235 /* request too large even for LBA48 */
1236 goto out_of_range;
1238 if (unlikely(ata_rwcmd_protocol(qc) < 0))
1239 goto invalid_fld;
1241 qc->nsect = n_block;
1242 tf->nsect = n_block & 0xff;
1244 tf->lbah = (block >> 16) & 0xff;
1245 tf->lbam = (block >> 8) & 0xff;
1246 tf->lbal = block & 0xff;
1248 tf->device |= ATA_LBA;
1249 } else {
1250 /* CHS */
1251 u32 sect, head, cyl, track;
1253 /* The request -may- be too large for CHS addressing. */
1254 if (!lba_28_ok(block, n_block))
1255 goto out_of_range;
1257 if (unlikely(ata_rwcmd_protocol(qc) < 0))
1258 goto invalid_fld;
1260 /* Convert LBA to CHS */
1261 track = (u32)block / dev->sectors;
1262 cyl = track / dev->heads;
1263 head = track % dev->heads;
1264 sect = (u32)block % dev->sectors + 1;
1266 DPRINTK("block %u track %u cyl %u head %u sect %u\n",
1267 (u32)block, track, cyl, head, sect);
1269 /* Check whether the converted CHS can fit.
1270 Cylinder: 0-65535
1271 Head: 0-15
1272 Sector: 1-255*/
1273 if ((cyl >> 16) || (head >> 4) || (sect >> 8) || (!sect))
1274 goto out_of_range;
1276 qc->nsect = n_block;
1277 tf->nsect = n_block & 0xff; /* Sector count 0 means 256 sectors */
1278 tf->lbal = sect;
1279 tf->lbam = cyl;
1280 tf->lbah = cyl >> 8;
1281 tf->device |= head;
1284 return 0;
1286 invalid_fld:
1287 ata_scsi_set_sense(qc->scsicmd, ILLEGAL_REQUEST, 0x24, 0x0);
1288 /* "Invalid field in cbd" */
1289 return 1;
1291 out_of_range:
1292 ata_scsi_set_sense(qc->scsicmd, ILLEGAL_REQUEST, 0x21, 0x0);
1293 /* "Logical Block Address out of range" */
1294 return 1;
1296 nothing_to_do:
1297 qc->scsicmd->result = SAM_STAT_GOOD;
1298 return 1;
1301 static void ata_scsi_qc_complete(struct ata_queued_cmd *qc)
1303 struct scsi_cmnd *cmd = qc->scsicmd;
1304 u8 *cdb = cmd->cmnd;
1305 int need_sense = (qc->err_mask != 0);
1307 /* We snoop the SET_FEATURES - Write Cache ON/OFF command, and
1308 * schedule EH_REVALIDATE operation to update the IDENTIFY DEVICE
1309 * cache
1311 if (!need_sense && (qc->tf.command == ATA_CMD_SET_FEATURES) &&
1312 ((qc->tf.feature == SETFEATURES_WC_ON) ||
1313 (qc->tf.feature == SETFEATURES_WC_OFF))) {
1314 qc->ap->eh_info.action |= ATA_EH_REVALIDATE;
1315 ata_port_schedule_eh(qc->ap);
1318 /* For ATA pass thru (SAT) commands, generate a sense block if
1319 * user mandated it or if there's an error. Note that if we
1320 * generate because the user forced us to, a check condition
1321 * is generated and the ATA register values are returned
1322 * whether the command completed successfully or not. If there
1323 * was no error, SK, ASC and ASCQ will all be zero.
1325 if (((cdb[0] == ATA_16) || (cdb[0] == ATA_12)) &&
1326 ((cdb[2] & 0x20) || need_sense)) {
1327 ata_gen_ata_desc_sense(qc);
1328 } else {
1329 if (!need_sense) {
1330 cmd->result = SAM_STAT_GOOD;
1331 } else {
1332 /* TODO: decide which descriptor format to use
1333 * for 48b LBA devices and call that here
1334 * instead of the fixed desc, which is only
1335 * good for smaller LBA (and maybe CHS?)
1336 * devices.
1338 ata_gen_fixed_sense(qc);
1342 if (need_sense && !qc->ap->ops->error_handler)
1343 ata_dump_status(qc->ap->id, &qc->result_tf);
1345 qc->scsidone(cmd);
1347 ata_qc_free(qc);
1351 * ata_scmd_need_defer - Check whether we need to defer scmd
1352 * @dev: ATA device to which the command is addressed
1353 * @is_io: Is the command IO (and thus possibly NCQ)?
1355 * NCQ and non-NCQ commands cannot run together. As upper layer
1356 * only knows the queue depth, we are responsible for maintaining
1357 * exclusion. This function checks whether a new command can be
1358 * issued to @dev.
1360 * LOCKING:
1361 * spin_lock_irqsave(host_set lock)
1363 * RETURNS:
1364 * 1 if deferring is needed, 0 otherwise.
1366 static int ata_scmd_need_defer(struct ata_device *dev, int is_io)
1368 struct ata_port *ap = dev->ap;
1370 if (!(dev->flags & ATA_DFLAG_NCQ))
1371 return 0;
1373 if (is_io) {
1374 if (!ata_tag_valid(ap->active_tag))
1375 return 0;
1376 } else {
1377 if (!ata_tag_valid(ap->active_tag) && !ap->sactive)
1378 return 0;
1380 return 1;
1384 * ata_scsi_translate - Translate then issue SCSI command to ATA device
1385 * @dev: ATA device to which the command is addressed
1386 * @cmd: SCSI command to execute
1387 * @done: SCSI command completion function
1388 * @xlat_func: Actor which translates @cmd to an ATA taskfile
1390 * Our ->queuecommand() function has decided that the SCSI
1391 * command issued can be directly translated into an ATA
1392 * command, rather than handled internally.
1394 * This function sets up an ata_queued_cmd structure for the
1395 * SCSI command, and sends that ata_queued_cmd to the hardware.
1397 * The xlat_func argument (actor) returns 0 if ready to execute
1398 * ATA command, else 1 to finish translation. If 1 is returned
1399 * then cmd->result (and possibly cmd->sense_buffer) are assumed
1400 * to be set reflecting an error condition or clean (early)
1401 * termination.
1403 * LOCKING:
1404 * spin_lock_irqsave(host_set lock)
1406 * RETURNS:
1407 * 0 on success, SCSI_ML_QUEUE_DEVICE_BUSY if the command
1408 * needs to be deferred.
1410 static int ata_scsi_translate(struct ata_device *dev, struct scsi_cmnd *cmd,
1411 void (*done)(struct scsi_cmnd *),
1412 ata_xlat_func_t xlat_func)
1414 struct ata_queued_cmd *qc;
1415 u8 *scsicmd = cmd->cmnd;
1416 int is_io = xlat_func == ata_scsi_rw_xlat;
1418 VPRINTK("ENTER\n");
1420 if (unlikely(ata_scmd_need_defer(dev, is_io)))
1421 goto defer;
1423 qc = ata_scsi_qc_new(dev, cmd, done);
1424 if (!qc)
1425 goto err_mem;
1427 /* data is present; dma-map it */
1428 if (cmd->sc_data_direction == DMA_FROM_DEVICE ||
1429 cmd->sc_data_direction == DMA_TO_DEVICE) {
1430 if (unlikely(cmd->request_bufflen < 1)) {
1431 ata_dev_printk(dev, KERN_WARNING,
1432 "WARNING: zero len r/w req\n");
1433 goto err_did;
1436 if (cmd->use_sg)
1437 ata_sg_init(qc, cmd->request_buffer, cmd->use_sg);
1438 else
1439 ata_sg_init_one(qc, cmd->request_buffer,
1440 cmd->request_bufflen);
1442 qc->dma_dir = cmd->sc_data_direction;
1445 qc->complete_fn = ata_scsi_qc_complete;
1447 if (xlat_func(qc, scsicmd))
1448 goto early_finish;
1450 /* select device, send command to hardware */
1451 ata_qc_issue(qc);
1453 VPRINTK("EXIT\n");
1454 return 0;
1456 early_finish:
1457 ata_qc_free(qc);
1458 done(cmd);
1459 DPRINTK("EXIT - early finish (good or error)\n");
1460 return 0;
1462 err_did:
1463 ata_qc_free(qc);
1464 err_mem:
1465 cmd->result = (DID_ERROR << 16);
1466 done(cmd);
1467 DPRINTK("EXIT - internal\n");
1468 return 0;
1470 defer:
1471 DPRINTK("EXIT - defer\n");
1472 return SCSI_MLQUEUE_DEVICE_BUSY;
1476 * ata_scsi_rbuf_get - Map response buffer.
1477 * @cmd: SCSI command containing buffer to be mapped.
1478 * @buf_out: Pointer to mapped area.
1480 * Maps buffer contained within SCSI command @cmd.
1482 * LOCKING:
1483 * spin_lock_irqsave(host_set lock)
1485 * RETURNS:
1486 * Length of response buffer.
1489 static unsigned int ata_scsi_rbuf_get(struct scsi_cmnd *cmd, u8 **buf_out)
1491 u8 *buf;
1492 unsigned int buflen;
1494 if (cmd->use_sg) {
1495 struct scatterlist *sg;
1497 sg = (struct scatterlist *) cmd->request_buffer;
1498 buf = kmap_atomic(sg->page, KM_USER0) + sg->offset;
1499 buflen = sg->length;
1500 } else {
1501 buf = cmd->request_buffer;
1502 buflen = cmd->request_bufflen;
1505 *buf_out = buf;
1506 return buflen;
1510 * ata_scsi_rbuf_put - Unmap response buffer.
1511 * @cmd: SCSI command containing buffer to be unmapped.
1512 * @buf: buffer to unmap
1514 * Unmaps response buffer contained within @cmd.
1516 * LOCKING:
1517 * spin_lock_irqsave(host_set lock)
1520 static inline void ata_scsi_rbuf_put(struct scsi_cmnd *cmd, u8 *buf)
1522 if (cmd->use_sg) {
1523 struct scatterlist *sg;
1525 sg = (struct scatterlist *) cmd->request_buffer;
1526 kunmap_atomic(buf - sg->offset, KM_USER0);
1531 * ata_scsi_rbuf_fill - wrapper for SCSI command simulators
1532 * @args: device IDENTIFY data / SCSI command of interest.
1533 * @actor: Callback hook for desired SCSI command simulator
1535 * Takes care of the hard work of simulating a SCSI command...
1536 * Mapping the response buffer, calling the command's handler,
1537 * and handling the handler's return value. This return value
1538 * indicates whether the handler wishes the SCSI command to be
1539 * completed successfully (0), or not (in which case cmd->result
1540 * and sense buffer are assumed to be set).
1542 * LOCKING:
1543 * spin_lock_irqsave(host_set lock)
1546 void ata_scsi_rbuf_fill(struct ata_scsi_args *args,
1547 unsigned int (*actor) (struct ata_scsi_args *args,
1548 u8 *rbuf, unsigned int buflen))
1550 u8 *rbuf;
1551 unsigned int buflen, rc;
1552 struct scsi_cmnd *cmd = args->cmd;
1554 buflen = ata_scsi_rbuf_get(cmd, &rbuf);
1555 memset(rbuf, 0, buflen);
1556 rc = actor(args, rbuf, buflen);
1557 ata_scsi_rbuf_put(cmd, rbuf);
1559 if (rc == 0)
1560 cmd->result = SAM_STAT_GOOD;
1561 args->done(cmd);
1565 * ata_scsiop_inq_std - Simulate INQUIRY command
1566 * @args: device IDENTIFY data / SCSI command of interest.
1567 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1568 * @buflen: Response buffer length.
1570 * Returns standard device identification data associated
1571 * with non-VPD INQUIRY command output.
1573 * LOCKING:
1574 * spin_lock_irqsave(host_set lock)
1577 unsigned int ata_scsiop_inq_std(struct ata_scsi_args *args, u8 *rbuf,
1578 unsigned int buflen)
1580 u8 hdr[] = {
1581 TYPE_DISK,
1583 0x5, /* claim SPC-3 version compatibility */
1585 95 - 4
1588 /* set scsi removeable (RMB) bit per ata bit */
1589 if (ata_id_removeable(args->id))
1590 hdr[1] |= (1 << 7);
1592 VPRINTK("ENTER\n");
1594 memcpy(rbuf, hdr, sizeof(hdr));
1596 if (buflen > 35) {
1597 memcpy(&rbuf[8], "ATA ", 8);
1598 ata_id_string(args->id, &rbuf[16], ATA_ID_PROD_OFS, 16);
1599 ata_id_string(args->id, &rbuf[32], ATA_ID_FW_REV_OFS, 4);
1600 if (rbuf[32] == 0 || rbuf[32] == ' ')
1601 memcpy(&rbuf[32], "n/a ", 4);
1604 if (buflen > 63) {
1605 const u8 versions[] = {
1606 0x60, /* SAM-3 (no version claimed) */
1608 0x03,
1609 0x20, /* SBC-2 (no version claimed) */
1611 0x02,
1612 0x60 /* SPC-3 (no version claimed) */
1615 memcpy(rbuf + 59, versions, sizeof(versions));
1618 return 0;
1622 * ata_scsiop_inq_00 - Simulate INQUIRY VPD page 0, list of pages
1623 * @args: device IDENTIFY data / SCSI command of interest.
1624 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1625 * @buflen: Response buffer length.
1627 * Returns list of inquiry VPD pages available.
1629 * LOCKING:
1630 * spin_lock_irqsave(host_set lock)
1633 unsigned int ata_scsiop_inq_00(struct ata_scsi_args *args, u8 *rbuf,
1634 unsigned int buflen)
1636 const u8 pages[] = {
1637 0x00, /* page 0x00, this page */
1638 0x80, /* page 0x80, unit serial no page */
1639 0x83 /* page 0x83, device ident page */
1641 rbuf[3] = sizeof(pages); /* number of supported VPD pages */
1643 if (buflen > 6)
1644 memcpy(rbuf + 4, pages, sizeof(pages));
1646 return 0;
1650 * ata_scsiop_inq_80 - Simulate INQUIRY VPD page 80, device serial number
1651 * @args: device IDENTIFY data / SCSI command of interest.
1652 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1653 * @buflen: Response buffer length.
1655 * Returns ATA device serial number.
1657 * LOCKING:
1658 * spin_lock_irqsave(host_set lock)
1661 unsigned int ata_scsiop_inq_80(struct ata_scsi_args *args, u8 *rbuf,
1662 unsigned int buflen)
1664 const u8 hdr[] = {
1666 0x80, /* this page code */
1668 ATA_SERNO_LEN, /* page len */
1670 memcpy(rbuf, hdr, sizeof(hdr));
1672 if (buflen > (ATA_SERNO_LEN + 4 - 1))
1673 ata_id_string(args->id, (unsigned char *) &rbuf[4],
1674 ATA_ID_SERNO_OFS, ATA_SERNO_LEN);
1676 return 0;
1680 * ata_scsiop_inq_83 - Simulate INQUIRY VPD page 83, device identity
1681 * @args: device IDENTIFY data / SCSI command of interest.
1682 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1683 * @buflen: Response buffer length.
1685 * Yields two logical unit device identification designators:
1686 * - vendor specific ASCII containing the ATA serial number
1687 * - SAT defined "t10 vendor id based" containing ASCII vendor
1688 * name ("ATA "), model and serial numbers.
1690 * LOCKING:
1691 * spin_lock_irqsave(host_set lock)
1694 unsigned int ata_scsiop_inq_83(struct ata_scsi_args *args, u8 *rbuf,
1695 unsigned int buflen)
1697 int num;
1698 const int sat_model_serial_desc_len = 68;
1699 const int ata_model_byte_len = 40;
1701 rbuf[1] = 0x83; /* this page code */
1702 num = 4;
1704 if (buflen > (ATA_SERNO_LEN + num + 3)) {
1705 /* piv=0, assoc=lu, code_set=ACSII, designator=vendor */
1706 rbuf[num + 0] = 2;
1707 rbuf[num + 3] = ATA_SERNO_LEN;
1708 num += 4;
1709 ata_id_string(args->id, (unsigned char *) rbuf + num,
1710 ATA_ID_SERNO_OFS, ATA_SERNO_LEN);
1711 num += ATA_SERNO_LEN;
1713 if (buflen > (sat_model_serial_desc_len + num + 3)) {
1714 /* SAT defined lu model and serial numbers descriptor */
1715 /* piv=0, assoc=lu, code_set=ACSII, designator=t10 vendor id */
1716 rbuf[num + 0] = 2;
1717 rbuf[num + 1] = 1;
1718 rbuf[num + 3] = sat_model_serial_desc_len;
1719 num += 4;
1720 memcpy(rbuf + num, "ATA ", 8);
1721 num += 8;
1722 ata_id_string(args->id, (unsigned char *) rbuf + num,
1723 ATA_ID_PROD_OFS, ata_model_byte_len);
1724 num += ata_model_byte_len;
1725 ata_id_string(args->id, (unsigned char *) rbuf + num,
1726 ATA_ID_SERNO_OFS, ATA_SERNO_LEN);
1727 num += ATA_SERNO_LEN;
1729 rbuf[3] = num - 4; /* page len (assume less than 256 bytes) */
1730 return 0;
1734 * ata_scsiop_noop - Command handler that simply returns success.
1735 * @args: device IDENTIFY data / SCSI command of interest.
1736 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1737 * @buflen: Response buffer length.
1739 * No operation. Simply returns success to caller, to indicate
1740 * that the caller should successfully complete this SCSI command.
1742 * LOCKING:
1743 * spin_lock_irqsave(host_set lock)
1746 unsigned int ata_scsiop_noop(struct ata_scsi_args *args, u8 *rbuf,
1747 unsigned int buflen)
1749 VPRINTK("ENTER\n");
1750 return 0;
1754 * ata_msense_push - Push data onto MODE SENSE data output buffer
1755 * @ptr_io: (input/output) Location to store more output data
1756 * @last: End of output data buffer
1757 * @buf: Pointer to BLOB being added to output buffer
1758 * @buflen: Length of BLOB
1760 * Store MODE SENSE data on an output buffer.
1762 * LOCKING:
1763 * None.
1766 static void ata_msense_push(u8 **ptr_io, const u8 *last,
1767 const u8 *buf, unsigned int buflen)
1769 u8 *ptr = *ptr_io;
1771 if ((ptr + buflen - 1) > last)
1772 return;
1774 memcpy(ptr, buf, buflen);
1776 ptr += buflen;
1778 *ptr_io = ptr;
1782 * ata_msense_caching - Simulate MODE SENSE caching info page
1783 * @id: device IDENTIFY data
1784 * @ptr_io: (input/output) Location to store more output data
1785 * @last: End of output data buffer
1787 * Generate a caching info page, which conditionally indicates
1788 * write caching to the SCSI layer, depending on device
1789 * capabilities.
1791 * LOCKING:
1792 * None.
1795 static unsigned int ata_msense_caching(u16 *id, u8 **ptr_io,
1796 const u8 *last)
1798 u8 page[CACHE_MPAGE_LEN];
1800 memcpy(page, def_cache_mpage, sizeof(page));
1801 if (ata_id_wcache_enabled(id))
1802 page[2] |= (1 << 2); /* write cache enable */
1803 if (!ata_id_rahead_enabled(id))
1804 page[12] |= (1 << 5); /* disable read ahead */
1806 ata_msense_push(ptr_io, last, page, sizeof(page));
1807 return sizeof(page);
1811 * ata_msense_ctl_mode - Simulate MODE SENSE control mode page
1812 * @dev: Device associated with this MODE SENSE command
1813 * @ptr_io: (input/output) Location to store more output data
1814 * @last: End of output data buffer
1816 * Generate a generic MODE SENSE control mode page.
1818 * LOCKING:
1819 * None.
1822 static unsigned int ata_msense_ctl_mode(u8 **ptr_io, const u8 *last)
1824 ata_msense_push(ptr_io, last, def_control_mpage,
1825 sizeof(def_control_mpage));
1826 return sizeof(def_control_mpage);
1830 * ata_msense_rw_recovery - Simulate MODE SENSE r/w error recovery page
1831 * @dev: Device associated with this MODE SENSE command
1832 * @ptr_io: (input/output) Location to store more output data
1833 * @last: End of output data buffer
1835 * Generate a generic MODE SENSE r/w error recovery page.
1837 * LOCKING:
1838 * None.
1841 static unsigned int ata_msense_rw_recovery(u8 **ptr_io, const u8 *last)
1844 ata_msense_push(ptr_io, last, def_rw_recovery_mpage,
1845 sizeof(def_rw_recovery_mpage));
1846 return sizeof(def_rw_recovery_mpage);
1850 * We can turn this into a real blacklist if it's needed, for now just
1851 * blacklist any Maxtor BANC1G10 revision firmware
1853 static int ata_dev_supports_fua(u16 *id)
1855 unsigned char model[41], fw[9];
1857 if (!libata_fua)
1858 return 0;
1859 if (!ata_id_has_fua(id))
1860 return 0;
1862 ata_id_c_string(id, model, ATA_ID_PROD_OFS, sizeof(model));
1863 ata_id_c_string(id, fw, ATA_ID_FW_REV_OFS, sizeof(fw));
1865 if (strcmp(model, "Maxtor"))
1866 return 1;
1867 if (strcmp(fw, "BANC1G10"))
1868 return 1;
1870 return 0; /* blacklisted */
1874 * ata_scsiop_mode_sense - Simulate MODE SENSE 6, 10 commands
1875 * @args: device IDENTIFY data / SCSI command of interest.
1876 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1877 * @buflen: Response buffer length.
1879 * Simulate MODE SENSE commands. Assume this is invoked for direct
1880 * access devices (e.g. disks) only. There should be no block
1881 * descriptor for other device types.
1883 * LOCKING:
1884 * spin_lock_irqsave(host_set lock)
1887 unsigned int ata_scsiop_mode_sense(struct ata_scsi_args *args, u8 *rbuf,
1888 unsigned int buflen)
1890 struct ata_device *dev = args->dev;
1891 u8 *scsicmd = args->cmd->cmnd, *p, *last;
1892 const u8 sat_blk_desc[] = {
1893 0, 0, 0, 0, /* number of blocks: sat unspecified */
1895 0, 0x2, 0x0 /* block length: 512 bytes */
1897 u8 pg, spg;
1898 unsigned int ebd, page_control, six_byte, output_len, alloc_len, minlen;
1899 u8 dpofua;
1901 VPRINTK("ENTER\n");
1903 six_byte = (scsicmd[0] == MODE_SENSE);
1904 ebd = !(scsicmd[1] & 0x8); /* dbd bit inverted == edb */
1906 * LLBA bit in msense(10) ignored (compliant)
1909 page_control = scsicmd[2] >> 6;
1910 switch (page_control) {
1911 case 0: /* current */
1912 break; /* supported */
1913 case 3: /* saved */
1914 goto saving_not_supp;
1915 case 1: /* changeable */
1916 case 2: /* defaults */
1917 default:
1918 goto invalid_fld;
1921 if (six_byte) {
1922 output_len = 4 + (ebd ? 8 : 0);
1923 alloc_len = scsicmd[4];
1924 } else {
1925 output_len = 8 + (ebd ? 8 : 0);
1926 alloc_len = (scsicmd[7] << 8) + scsicmd[8];
1928 minlen = (alloc_len < buflen) ? alloc_len : buflen;
1930 p = rbuf + output_len;
1931 last = rbuf + minlen - 1;
1933 pg = scsicmd[2] & 0x3f;
1934 spg = scsicmd[3];
1936 * No mode subpages supported (yet) but asking for _all_
1937 * subpages may be valid
1939 if (spg && (spg != ALL_SUB_MPAGES))
1940 goto invalid_fld;
1942 switch(pg) {
1943 case RW_RECOVERY_MPAGE:
1944 output_len += ata_msense_rw_recovery(&p, last);
1945 break;
1947 case CACHE_MPAGE:
1948 output_len += ata_msense_caching(args->id, &p, last);
1949 break;
1951 case CONTROL_MPAGE: {
1952 output_len += ata_msense_ctl_mode(&p, last);
1953 break;
1956 case ALL_MPAGES:
1957 output_len += ata_msense_rw_recovery(&p, last);
1958 output_len += ata_msense_caching(args->id, &p, last);
1959 output_len += ata_msense_ctl_mode(&p, last);
1960 break;
1962 default: /* invalid page code */
1963 goto invalid_fld;
1966 if (minlen < 1)
1967 return 0;
1969 dpofua = 0;
1970 if (ata_dev_supports_fua(args->id) && (dev->flags & ATA_DFLAG_LBA48) &&
1971 (!(dev->flags & ATA_DFLAG_PIO) || dev->multi_count))
1972 dpofua = 1 << 4;
1974 if (six_byte) {
1975 output_len--;
1976 rbuf[0] = output_len;
1977 if (minlen > 2)
1978 rbuf[2] |= dpofua;
1979 if (ebd) {
1980 if (minlen > 3)
1981 rbuf[3] = sizeof(sat_blk_desc);
1982 if (minlen > 11)
1983 memcpy(rbuf + 4, sat_blk_desc,
1984 sizeof(sat_blk_desc));
1986 } else {
1987 output_len -= 2;
1988 rbuf[0] = output_len >> 8;
1989 if (minlen > 1)
1990 rbuf[1] = output_len;
1991 if (minlen > 3)
1992 rbuf[3] |= dpofua;
1993 if (ebd) {
1994 if (minlen > 7)
1995 rbuf[7] = sizeof(sat_blk_desc);
1996 if (minlen > 15)
1997 memcpy(rbuf + 8, sat_blk_desc,
1998 sizeof(sat_blk_desc));
2001 return 0;
2003 invalid_fld:
2004 ata_scsi_set_sense(args->cmd, ILLEGAL_REQUEST, 0x24, 0x0);
2005 /* "Invalid field in cbd" */
2006 return 1;
2008 saving_not_supp:
2009 ata_scsi_set_sense(args->cmd, ILLEGAL_REQUEST, 0x39, 0x0);
2010 /* "Saving parameters not supported" */
2011 return 1;
2015 * ata_scsiop_read_cap - Simulate READ CAPACITY[ 16] commands
2016 * @args: device IDENTIFY data / SCSI command of interest.
2017 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2018 * @buflen: Response buffer length.
2020 * Simulate READ CAPACITY commands.
2022 * LOCKING:
2023 * spin_lock_irqsave(host_set lock)
2026 unsigned int ata_scsiop_read_cap(struct ata_scsi_args *args, u8 *rbuf,
2027 unsigned int buflen)
2029 u64 n_sectors;
2030 u32 tmp;
2032 VPRINTK("ENTER\n");
2034 if (ata_id_has_lba(args->id)) {
2035 if (ata_id_has_lba48(args->id))
2036 n_sectors = ata_id_u64(args->id, 100);
2037 else
2038 n_sectors = ata_id_u32(args->id, 60);
2039 } else {
2040 /* CHS default translation */
2041 n_sectors = args->id[1] * args->id[3] * args->id[6];
2043 if (ata_id_current_chs_valid(args->id))
2044 /* CHS current translation */
2045 n_sectors = ata_id_u32(args->id, 57);
2048 n_sectors--; /* ATA TotalUserSectors - 1 */
2050 if (args->cmd->cmnd[0] == READ_CAPACITY) {
2051 if( n_sectors >= 0xffffffffULL )
2052 tmp = 0xffffffff ; /* Return max count on overflow */
2053 else
2054 tmp = n_sectors ;
2056 /* sector count, 32-bit */
2057 rbuf[0] = tmp >> (8 * 3);
2058 rbuf[1] = tmp >> (8 * 2);
2059 rbuf[2] = tmp >> (8 * 1);
2060 rbuf[3] = tmp;
2062 /* sector size */
2063 tmp = ATA_SECT_SIZE;
2064 rbuf[6] = tmp >> 8;
2065 rbuf[7] = tmp;
2067 } else {
2068 /* sector count, 64-bit */
2069 tmp = n_sectors >> (8 * 4);
2070 rbuf[2] = tmp >> (8 * 3);
2071 rbuf[3] = tmp >> (8 * 2);
2072 rbuf[4] = tmp >> (8 * 1);
2073 rbuf[5] = tmp;
2074 tmp = n_sectors;
2075 rbuf[6] = tmp >> (8 * 3);
2076 rbuf[7] = tmp >> (8 * 2);
2077 rbuf[8] = tmp >> (8 * 1);
2078 rbuf[9] = tmp;
2080 /* sector size */
2081 tmp = ATA_SECT_SIZE;
2082 rbuf[12] = tmp >> 8;
2083 rbuf[13] = tmp;
2086 return 0;
2090 * ata_scsiop_report_luns - Simulate REPORT LUNS command
2091 * @args: device IDENTIFY data / SCSI command of interest.
2092 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2093 * @buflen: Response buffer length.
2095 * Simulate REPORT LUNS command.
2097 * LOCKING:
2098 * spin_lock_irqsave(host_set lock)
2101 unsigned int ata_scsiop_report_luns(struct ata_scsi_args *args, u8 *rbuf,
2102 unsigned int buflen)
2104 VPRINTK("ENTER\n");
2105 rbuf[3] = 8; /* just one lun, LUN 0, size 8 bytes */
2107 return 0;
2111 * ata_scsi_set_sense - Set SCSI sense data and status
2112 * @cmd: SCSI request to be handled
2113 * @sk: SCSI-defined sense key
2114 * @asc: SCSI-defined additional sense code
2115 * @ascq: SCSI-defined additional sense code qualifier
2117 * Helper function that builds a valid fixed format, current
2118 * response code and the given sense key (sk), additional sense
2119 * code (asc) and additional sense code qualifier (ascq) with
2120 * a SCSI command status of %SAM_STAT_CHECK_CONDITION and
2121 * DRIVER_SENSE set in the upper bits of scsi_cmnd::result .
2123 * LOCKING:
2124 * Not required
2127 void ata_scsi_set_sense(struct scsi_cmnd *cmd, u8 sk, u8 asc, u8 ascq)
2129 cmd->result = (DRIVER_SENSE << 24) | SAM_STAT_CHECK_CONDITION;
2131 cmd->sense_buffer[0] = 0x70; /* fixed format, current */
2132 cmd->sense_buffer[2] = sk;
2133 cmd->sense_buffer[7] = 18 - 8; /* additional sense length */
2134 cmd->sense_buffer[12] = asc;
2135 cmd->sense_buffer[13] = ascq;
2139 * ata_scsi_badcmd - End a SCSI request with an error
2140 * @cmd: SCSI request to be handled
2141 * @done: SCSI command completion function
2142 * @asc: SCSI-defined additional sense code
2143 * @ascq: SCSI-defined additional sense code qualifier
2145 * Helper function that completes a SCSI command with
2146 * %SAM_STAT_CHECK_CONDITION, with a sense key %ILLEGAL_REQUEST
2147 * and the specified additional sense codes.
2149 * LOCKING:
2150 * spin_lock_irqsave(host_set lock)
2153 void ata_scsi_badcmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *), u8 asc, u8 ascq)
2155 DPRINTK("ENTER\n");
2156 ata_scsi_set_sense(cmd, ILLEGAL_REQUEST, asc, ascq);
2158 done(cmd);
2161 static void atapi_sense_complete(struct ata_queued_cmd *qc)
2163 if (qc->err_mask && ((qc->err_mask & AC_ERR_DEV) == 0)) {
2164 /* FIXME: not quite right; we don't want the
2165 * translation of taskfile registers into
2166 * a sense descriptors, since that's only
2167 * correct for ATA, not ATAPI
2169 ata_gen_ata_desc_sense(qc);
2172 qc->scsidone(qc->scsicmd);
2173 ata_qc_free(qc);
2176 /* is it pointless to prefer PIO for "safety reasons"? */
2177 static inline int ata_pio_use_silly(struct ata_port *ap)
2179 return (ap->flags & ATA_FLAG_PIO_DMA);
2182 static void atapi_request_sense(struct ata_queued_cmd *qc)
2184 struct ata_port *ap = qc->ap;
2185 struct scsi_cmnd *cmd = qc->scsicmd;
2187 DPRINTK("ATAPI request sense\n");
2189 /* FIXME: is this needed? */
2190 memset(cmd->sense_buffer, 0, sizeof(cmd->sense_buffer));
2192 ap->ops->tf_read(ap, &qc->tf);
2194 /* fill these in, for the case where they are -not- overwritten */
2195 cmd->sense_buffer[0] = 0x70;
2196 cmd->sense_buffer[2] = qc->tf.feature >> 4;
2198 ata_qc_reinit(qc);
2200 ata_sg_init_one(qc, cmd->sense_buffer, sizeof(cmd->sense_buffer));
2201 qc->dma_dir = DMA_FROM_DEVICE;
2203 memset(&qc->cdb, 0, qc->dev->cdb_len);
2204 qc->cdb[0] = REQUEST_SENSE;
2205 qc->cdb[4] = SCSI_SENSE_BUFFERSIZE;
2207 qc->tf.flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
2208 qc->tf.command = ATA_CMD_PACKET;
2210 if (ata_pio_use_silly(ap)) {
2211 qc->tf.protocol = ATA_PROT_ATAPI_DMA;
2212 qc->tf.feature |= ATAPI_PKT_DMA;
2213 } else {
2214 qc->tf.protocol = ATA_PROT_ATAPI;
2215 qc->tf.lbam = (8 * 1024) & 0xff;
2216 qc->tf.lbah = (8 * 1024) >> 8;
2218 qc->nbytes = SCSI_SENSE_BUFFERSIZE;
2220 qc->complete_fn = atapi_sense_complete;
2222 ata_qc_issue(qc);
2224 DPRINTK("EXIT\n");
2227 static void atapi_qc_complete(struct ata_queued_cmd *qc)
2229 struct scsi_cmnd *cmd = qc->scsicmd;
2230 unsigned int err_mask = qc->err_mask;
2232 VPRINTK("ENTER, err_mask 0x%X\n", err_mask);
2234 /* handle completion from new EH */
2235 if (unlikely(qc->ap->ops->error_handler &&
2236 (err_mask || qc->flags & ATA_QCFLAG_SENSE_VALID))) {
2238 if (!(qc->flags & ATA_QCFLAG_SENSE_VALID)) {
2239 /* FIXME: not quite right; we don't want the
2240 * translation of taskfile registers into a
2241 * sense descriptors, since that's only
2242 * correct for ATA, not ATAPI
2244 ata_gen_ata_desc_sense(qc);
2247 qc->scsicmd->result = SAM_STAT_CHECK_CONDITION;
2248 qc->scsidone(cmd);
2249 ata_qc_free(qc);
2250 return;
2253 /* successful completion or old EH failure path */
2254 if (unlikely(err_mask & AC_ERR_DEV)) {
2255 cmd->result = SAM_STAT_CHECK_CONDITION;
2256 atapi_request_sense(qc);
2257 return;
2258 } else if (unlikely(err_mask)) {
2259 /* FIXME: not quite right; we don't want the
2260 * translation of taskfile registers into
2261 * a sense descriptors, since that's only
2262 * correct for ATA, not ATAPI
2264 ata_gen_ata_desc_sense(qc);
2265 } else {
2266 u8 *scsicmd = cmd->cmnd;
2268 if ((scsicmd[0] == INQUIRY) && ((scsicmd[1] & 0x03) == 0)) {
2269 u8 *buf = NULL;
2270 unsigned int buflen;
2272 buflen = ata_scsi_rbuf_get(cmd, &buf);
2274 /* ATAPI devices typically report zero for their SCSI version,
2275 * and sometimes deviate from the spec WRT response data
2276 * format. If SCSI version is reported as zero like normal,
2277 * then we make the following fixups: 1) Fake MMC-5 version,
2278 * to indicate to the Linux scsi midlayer this is a modern
2279 * device. 2) Ensure response data format / ATAPI information
2280 * are always correct.
2282 if (buf[2] == 0) {
2283 buf[2] = 0x5;
2284 buf[3] = 0x32;
2287 ata_scsi_rbuf_put(cmd, buf);
2290 cmd->result = SAM_STAT_GOOD;
2293 qc->scsidone(cmd);
2294 ata_qc_free(qc);
2297 * atapi_xlat - Initialize PACKET taskfile
2298 * @qc: command structure to be initialized
2299 * @scsicmd: SCSI CDB associated with this PACKET command
2301 * LOCKING:
2302 * spin_lock_irqsave(host_set lock)
2304 * RETURNS:
2305 * Zero on success, non-zero on failure.
2308 static unsigned int atapi_xlat(struct ata_queued_cmd *qc, const u8 *scsicmd)
2310 struct scsi_cmnd *cmd = qc->scsicmd;
2311 struct ata_device *dev = qc->dev;
2312 int using_pio = (dev->flags & ATA_DFLAG_PIO);
2313 int nodata = (cmd->sc_data_direction == DMA_NONE);
2315 if (!using_pio)
2316 /* Check whether ATAPI DMA is safe */
2317 if (ata_check_atapi_dma(qc))
2318 using_pio = 1;
2320 memcpy(&qc->cdb, scsicmd, dev->cdb_len);
2322 qc->complete_fn = atapi_qc_complete;
2324 qc->tf.flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
2325 if (cmd->sc_data_direction == DMA_TO_DEVICE) {
2326 qc->tf.flags |= ATA_TFLAG_WRITE;
2327 DPRINTK("direction: write\n");
2330 qc->tf.command = ATA_CMD_PACKET;
2332 /* no data, or PIO data xfer */
2333 if (using_pio || nodata) {
2334 if (nodata)
2335 qc->tf.protocol = ATA_PROT_ATAPI_NODATA;
2336 else
2337 qc->tf.protocol = ATA_PROT_ATAPI;
2338 qc->tf.lbam = (8 * 1024) & 0xff;
2339 qc->tf.lbah = (8 * 1024) >> 8;
2342 /* DMA data xfer */
2343 else {
2344 qc->tf.protocol = ATA_PROT_ATAPI_DMA;
2345 qc->tf.feature |= ATAPI_PKT_DMA;
2347 if (atapi_dmadir && (cmd->sc_data_direction != DMA_TO_DEVICE))
2348 /* some SATA bridges need us to indicate data xfer direction */
2349 qc->tf.feature |= ATAPI_DMADIR;
2352 qc->nbytes = cmd->request_bufflen;
2354 return 0;
2357 static struct ata_device * ata_find_dev(struct ata_port *ap, int id)
2359 if (likely(id < ATA_MAX_DEVICES))
2360 return &ap->device[id];
2361 return NULL;
2364 static struct ata_device * __ata_scsi_find_dev(struct ata_port *ap,
2365 const struct scsi_device *scsidev)
2367 /* skip commands not addressed to targets we simulate */
2368 if (unlikely(scsidev->channel || scsidev->lun))
2369 return NULL;
2371 return ata_find_dev(ap, scsidev->id);
2375 * ata_scsi_dev_enabled - determine if device is enabled
2376 * @dev: ATA device
2378 * Determine if commands should be sent to the specified device.
2380 * LOCKING:
2381 * spin_lock_irqsave(host_set lock)
2383 * RETURNS:
2384 * 0 if commands are not allowed / 1 if commands are allowed
2387 static int ata_scsi_dev_enabled(struct ata_device *dev)
2389 if (unlikely(!ata_dev_enabled(dev)))
2390 return 0;
2392 if (!atapi_enabled || (dev->ap->flags & ATA_FLAG_NO_ATAPI)) {
2393 if (unlikely(dev->class == ATA_DEV_ATAPI)) {
2394 ata_dev_printk(dev, KERN_WARNING,
2395 "WARNING: ATAPI is %s, device ignored.\n",
2396 atapi_enabled ? "not supported with this driver" : "disabled");
2397 return 0;
2401 return 1;
2405 * ata_scsi_find_dev - lookup ata_device from scsi_cmnd
2406 * @ap: ATA port to which the device is attached
2407 * @scsidev: SCSI device from which we derive the ATA device
2409 * Given various information provided in struct scsi_cmnd,
2410 * map that onto an ATA bus, and using that mapping
2411 * determine which ata_device is associated with the
2412 * SCSI command to be sent.
2414 * LOCKING:
2415 * spin_lock_irqsave(host_set lock)
2417 * RETURNS:
2418 * Associated ATA device, or %NULL if not found.
2420 static struct ata_device *
2421 ata_scsi_find_dev(struct ata_port *ap, const struct scsi_device *scsidev)
2423 struct ata_device *dev = __ata_scsi_find_dev(ap, scsidev);
2425 if (unlikely(!dev || !ata_scsi_dev_enabled(dev)))
2426 return NULL;
2428 return dev;
2432 * ata_scsi_map_proto - Map pass-thru protocol value to taskfile value.
2433 * @byte1: Byte 1 from pass-thru CDB.
2435 * RETURNS:
2436 * ATA_PROT_UNKNOWN if mapping failed/unimplemented, protocol otherwise.
2438 static u8
2439 ata_scsi_map_proto(u8 byte1)
2441 switch((byte1 & 0x1e) >> 1) {
2442 case 3: /* Non-data */
2443 return ATA_PROT_NODATA;
2445 case 6: /* DMA */
2446 return ATA_PROT_DMA;
2448 case 4: /* PIO Data-in */
2449 case 5: /* PIO Data-out */
2450 return ATA_PROT_PIO;
2452 case 10: /* Device Reset */
2453 case 0: /* Hard Reset */
2454 case 1: /* SRST */
2455 case 2: /* Bus Idle */
2456 case 7: /* Packet */
2457 case 8: /* DMA Queued */
2458 case 9: /* Device Diagnostic */
2459 case 11: /* UDMA Data-in */
2460 case 12: /* UDMA Data-Out */
2461 case 13: /* FPDMA */
2462 default: /* Reserved */
2463 break;
2466 return ATA_PROT_UNKNOWN;
2470 * ata_scsi_pass_thru - convert ATA pass-thru CDB to taskfile
2471 * @qc: command structure to be initialized
2472 * @scsicmd: SCSI command to convert
2474 * Handles either 12 or 16-byte versions of the CDB.
2476 * RETURNS:
2477 * Zero on success, non-zero on failure.
2479 static unsigned int
2480 ata_scsi_pass_thru(struct ata_queued_cmd *qc, const u8 *scsicmd)
2482 struct ata_taskfile *tf = &(qc->tf);
2483 struct scsi_cmnd *cmd = qc->scsicmd;
2484 struct ata_device *dev = qc->dev;
2486 if ((tf->protocol = ata_scsi_map_proto(scsicmd[1])) == ATA_PROT_UNKNOWN)
2487 goto invalid_fld;
2489 /* We may not issue DMA commands if no DMA mode is set */
2490 if (tf->protocol == ATA_PROT_DMA && dev->dma_mode == 0)
2491 goto invalid_fld;
2493 if (scsicmd[1] & 0xe0)
2494 /* PIO multi not supported yet */
2495 goto invalid_fld;
2498 * 12 and 16 byte CDBs use different offsets to
2499 * provide the various register values.
2501 if (scsicmd[0] == ATA_16) {
2503 * 16-byte CDB - may contain extended commands.
2505 * If that is the case, copy the upper byte register values.
2507 if (scsicmd[1] & 0x01) {
2508 tf->hob_feature = scsicmd[3];
2509 tf->hob_nsect = scsicmd[5];
2510 tf->hob_lbal = scsicmd[7];
2511 tf->hob_lbam = scsicmd[9];
2512 tf->hob_lbah = scsicmd[11];
2513 tf->flags |= ATA_TFLAG_LBA48;
2514 } else
2515 tf->flags &= ~ATA_TFLAG_LBA48;
2518 * Always copy low byte, device and command registers.
2520 tf->feature = scsicmd[4];
2521 tf->nsect = scsicmd[6];
2522 tf->lbal = scsicmd[8];
2523 tf->lbam = scsicmd[10];
2524 tf->lbah = scsicmd[12];
2525 tf->device = scsicmd[13];
2526 tf->command = scsicmd[14];
2527 } else {
2529 * 12-byte CDB - incapable of extended commands.
2531 tf->flags &= ~ATA_TFLAG_LBA48;
2533 tf->feature = scsicmd[3];
2534 tf->nsect = scsicmd[4];
2535 tf->lbal = scsicmd[5];
2536 tf->lbam = scsicmd[6];
2537 tf->lbah = scsicmd[7];
2538 tf->device = scsicmd[8];
2539 tf->command = scsicmd[9];
2542 * If slave is possible, enforce correct master/slave bit
2544 if (qc->ap->flags & ATA_FLAG_SLAVE_POSS)
2545 tf->device = qc->dev->devno ?
2546 tf->device | ATA_DEV1 : tf->device & ~ATA_DEV1;
2549 * Filter SET_FEATURES - XFER MODE command -- otherwise,
2550 * SET_FEATURES - XFER MODE must be preceded/succeeded
2551 * by an update to hardware-specific registers for each
2552 * controller (i.e. the reason for ->set_piomode(),
2553 * ->set_dmamode(), and ->post_set_mode() hooks).
2555 if ((tf->command == ATA_CMD_SET_FEATURES)
2556 && (tf->feature == SETFEATURES_XFER))
2557 goto invalid_fld;
2560 * Set flags so that all registers will be written,
2561 * and pass on write indication (used for PIO/DMA
2562 * setup.)
2564 tf->flags |= (ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE);
2566 if (cmd->sc_data_direction == DMA_TO_DEVICE)
2567 tf->flags |= ATA_TFLAG_WRITE;
2570 * Set transfer length.
2572 * TODO: find out if we need to do more here to
2573 * cover scatter/gather case.
2575 qc->nsect = cmd->request_bufflen / ATA_SECT_SIZE;
2577 /* request result TF */
2578 qc->flags |= ATA_QCFLAG_RESULT_TF;
2580 return 0;
2582 invalid_fld:
2583 ata_scsi_set_sense(qc->scsicmd, ILLEGAL_REQUEST, 0x24, 0x00);
2584 /* "Invalid field in cdb" */
2585 return 1;
2589 * ata_get_xlat_func - check if SCSI to ATA translation is possible
2590 * @dev: ATA device
2591 * @cmd: SCSI command opcode to consider
2593 * Look up the SCSI command given, and determine whether the
2594 * SCSI command is to be translated or simulated.
2596 * RETURNS:
2597 * Pointer to translation function if possible, %NULL if not.
2600 static inline ata_xlat_func_t ata_get_xlat_func(struct ata_device *dev, u8 cmd)
2602 switch (cmd) {
2603 case READ_6:
2604 case READ_10:
2605 case READ_16:
2607 case WRITE_6:
2608 case WRITE_10:
2609 case WRITE_16:
2610 return ata_scsi_rw_xlat;
2612 case SYNCHRONIZE_CACHE:
2613 if (ata_try_flush_cache(dev))
2614 return ata_scsi_flush_xlat;
2615 break;
2617 case VERIFY:
2618 case VERIFY_16:
2619 return ata_scsi_verify_xlat;
2621 case ATA_12:
2622 case ATA_16:
2623 return ata_scsi_pass_thru;
2625 case START_STOP:
2626 return ata_scsi_start_stop_xlat;
2629 return NULL;
2633 * ata_scsi_dump_cdb - dump SCSI command contents to dmesg
2634 * @ap: ATA port to which the command was being sent
2635 * @cmd: SCSI command to dump
2637 * Prints the contents of a SCSI command via printk().
2640 static inline void ata_scsi_dump_cdb(struct ata_port *ap,
2641 struct scsi_cmnd *cmd)
2643 #ifdef ATA_DEBUG
2644 struct scsi_device *scsidev = cmd->device;
2645 u8 *scsicmd = cmd->cmnd;
2647 DPRINTK("CDB (%u:%d,%d,%d) %02x %02x %02x %02x %02x %02x %02x %02x %02x\n",
2648 ap->id,
2649 scsidev->channel, scsidev->id, scsidev->lun,
2650 scsicmd[0], scsicmd[1], scsicmd[2], scsicmd[3],
2651 scsicmd[4], scsicmd[5], scsicmd[6], scsicmd[7],
2652 scsicmd[8]);
2653 #endif
2656 static inline int __ata_scsi_queuecmd(struct scsi_cmnd *cmd,
2657 void (*done)(struct scsi_cmnd *),
2658 struct ata_device *dev)
2660 int rc = 0;
2662 if (dev->class == ATA_DEV_ATA) {
2663 ata_xlat_func_t xlat_func = ata_get_xlat_func(dev,
2664 cmd->cmnd[0]);
2666 if (xlat_func)
2667 rc = ata_scsi_translate(dev, cmd, done, xlat_func);
2668 else
2669 ata_scsi_simulate(dev, cmd, done);
2670 } else
2671 rc = ata_scsi_translate(dev, cmd, done, atapi_xlat);
2673 return rc;
2677 * ata_scsi_queuecmd - Issue SCSI cdb to libata-managed device
2678 * @cmd: SCSI command to be sent
2679 * @done: Completion function, called when command is complete
2681 * In some cases, this function translates SCSI commands into
2682 * ATA taskfiles, and queues the taskfiles to be sent to
2683 * hardware. In other cases, this function simulates a
2684 * SCSI device by evaluating and responding to certain
2685 * SCSI commands. This creates the overall effect of
2686 * ATA and ATAPI devices appearing as SCSI devices.
2688 * LOCKING:
2689 * Releases scsi-layer-held lock, and obtains host_set lock.
2691 * RETURNS:
2692 * Return value from __ata_scsi_queuecmd() if @cmd can be queued,
2693 * 0 otherwise.
2695 int ata_scsi_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *))
2697 struct ata_port *ap;
2698 struct ata_device *dev;
2699 struct scsi_device *scsidev = cmd->device;
2700 struct Scsi_Host *shost = scsidev->host;
2701 int rc = 0;
2703 ap = ata_shost_to_port(shost);
2705 spin_unlock(shost->host_lock);
2706 spin_lock(ap->lock);
2708 ata_scsi_dump_cdb(ap, cmd);
2710 dev = ata_scsi_find_dev(ap, scsidev);
2711 if (likely(dev))
2712 rc = __ata_scsi_queuecmd(cmd, done, dev);
2713 else {
2714 cmd->result = (DID_BAD_TARGET << 16);
2715 done(cmd);
2718 spin_unlock(ap->lock);
2719 spin_lock(shost->host_lock);
2720 return rc;
2724 * ata_scsi_simulate - simulate SCSI command on ATA device
2725 * @dev: the target device
2726 * @cmd: SCSI command being sent to device.
2727 * @done: SCSI command completion function.
2729 * Interprets and directly executes a select list of SCSI commands
2730 * that can be handled internally.
2732 * LOCKING:
2733 * spin_lock_irqsave(host_set lock)
2736 void ata_scsi_simulate(struct ata_device *dev, struct scsi_cmnd *cmd,
2737 void (*done)(struct scsi_cmnd *))
2739 struct ata_scsi_args args;
2740 const u8 *scsicmd = cmd->cmnd;
2742 args.dev = dev;
2743 args.id = dev->id;
2744 args.cmd = cmd;
2745 args.done = done;
2747 switch(scsicmd[0]) {
2748 /* no-op's, complete with success */
2749 case SYNCHRONIZE_CACHE:
2750 case REZERO_UNIT:
2751 case SEEK_6:
2752 case SEEK_10:
2753 case TEST_UNIT_READY:
2754 case FORMAT_UNIT: /* FIXME: correct? */
2755 case SEND_DIAGNOSTIC: /* FIXME: correct? */
2756 ata_scsi_rbuf_fill(&args, ata_scsiop_noop);
2757 break;
2759 case INQUIRY:
2760 if (scsicmd[1] & 2) /* is CmdDt set? */
2761 ata_scsi_invalid_field(cmd, done);
2762 else if ((scsicmd[1] & 1) == 0) /* is EVPD clear? */
2763 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_std);
2764 else if (scsicmd[2] == 0x00)
2765 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_00);
2766 else if (scsicmd[2] == 0x80)
2767 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_80);
2768 else if (scsicmd[2] == 0x83)
2769 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_83);
2770 else
2771 ata_scsi_invalid_field(cmd, done);
2772 break;
2774 case MODE_SENSE:
2775 case MODE_SENSE_10:
2776 ata_scsi_rbuf_fill(&args, ata_scsiop_mode_sense);
2777 break;
2779 case MODE_SELECT: /* unconditionally return */
2780 case MODE_SELECT_10: /* bad-field-in-cdb */
2781 ata_scsi_invalid_field(cmd, done);
2782 break;
2784 case READ_CAPACITY:
2785 ata_scsi_rbuf_fill(&args, ata_scsiop_read_cap);
2786 break;
2788 case SERVICE_ACTION_IN:
2789 if ((scsicmd[1] & 0x1f) == SAI_READ_CAPACITY_16)
2790 ata_scsi_rbuf_fill(&args, ata_scsiop_read_cap);
2791 else
2792 ata_scsi_invalid_field(cmd, done);
2793 break;
2795 case REPORT_LUNS:
2796 ata_scsi_rbuf_fill(&args, ata_scsiop_report_luns);
2797 break;
2799 /* mandatory commands we haven't implemented yet */
2800 case REQUEST_SENSE:
2802 /* all other commands */
2803 default:
2804 ata_scsi_set_sense(cmd, ILLEGAL_REQUEST, 0x20, 0x0);
2805 /* "Invalid command operation code" */
2806 done(cmd);
2807 break;
2811 void ata_scsi_scan_host(struct ata_port *ap)
2813 unsigned int i;
2815 if (ap->flags & ATA_FLAG_DISABLED)
2816 return;
2818 for (i = 0; i < ATA_MAX_DEVICES; i++) {
2819 struct ata_device *dev = &ap->device[i];
2820 struct scsi_device *sdev;
2822 if (!ata_dev_enabled(dev) || dev->sdev)
2823 continue;
2825 sdev = __scsi_add_device(ap->host, 0, i, 0, NULL);
2826 if (!IS_ERR(sdev)) {
2827 dev->sdev = sdev;
2828 scsi_device_put(sdev);
2834 * ata_scsi_offline_dev - offline attached SCSI device
2835 * @dev: ATA device to offline attached SCSI device for
2837 * This function is called from ata_eh_hotplug() and responsible
2838 * for taking the SCSI device attached to @dev offline. This
2839 * function is called with host_set lock which protects dev->sdev
2840 * against clearing.
2842 * LOCKING:
2843 * spin_lock_irqsave(host_set lock)
2845 * RETURNS:
2846 * 1 if attached SCSI device exists, 0 otherwise.
2848 int ata_scsi_offline_dev(struct ata_device *dev)
2850 if (dev->sdev) {
2851 scsi_device_set_state(dev->sdev, SDEV_OFFLINE);
2852 return 1;
2854 return 0;
2858 * ata_scsi_remove_dev - remove attached SCSI device
2859 * @dev: ATA device to remove attached SCSI device for
2861 * This function is called from ata_eh_scsi_hotplug() and
2862 * responsible for removing the SCSI device attached to @dev.
2864 * LOCKING:
2865 * Kernel thread context (may sleep).
2867 static void ata_scsi_remove_dev(struct ata_device *dev)
2869 struct ata_port *ap = dev->ap;
2870 struct scsi_device *sdev;
2871 unsigned long flags;
2873 /* Alas, we need to grab scan_mutex to ensure SCSI device
2874 * state doesn't change underneath us and thus
2875 * scsi_device_get() always succeeds. The mutex locking can
2876 * be removed if there is __scsi_device_get() interface which
2877 * increments reference counts regardless of device state.
2879 mutex_lock(&ap->host->scan_mutex);
2880 spin_lock_irqsave(ap->lock, flags);
2882 /* clearing dev->sdev is protected by host_set lock */
2883 sdev = dev->sdev;
2884 dev->sdev = NULL;
2886 if (sdev) {
2887 /* If user initiated unplug races with us, sdev can go
2888 * away underneath us after the host_set lock and
2889 * scan_mutex are released. Hold onto it.
2891 if (scsi_device_get(sdev) == 0) {
2892 /* The following ensures the attached sdev is
2893 * offline on return from ata_scsi_offline_dev()
2894 * regardless it wins or loses the race
2895 * against this function.
2897 scsi_device_set_state(sdev, SDEV_OFFLINE);
2898 } else {
2899 WARN_ON(1);
2900 sdev = NULL;
2904 spin_unlock_irqrestore(ap->lock, flags);
2905 mutex_unlock(&ap->host->scan_mutex);
2907 if (sdev) {
2908 ata_dev_printk(dev, KERN_INFO, "detaching (SCSI %s)\n",
2909 sdev->sdev_gendev.bus_id);
2911 scsi_remove_device(sdev);
2912 scsi_device_put(sdev);
2917 * ata_scsi_hotplug - SCSI part of hotplug
2918 * @data: Pointer to ATA port to perform SCSI hotplug on
2920 * Perform SCSI part of hotplug. It's executed from a separate
2921 * workqueue after EH completes. This is necessary because SCSI
2922 * hot plugging requires working EH and hot unplugging is
2923 * synchronized with hot plugging with a mutex.
2925 * LOCKING:
2926 * Kernel thread context (may sleep).
2928 void ata_scsi_hotplug(void *data)
2930 struct ata_port *ap = data;
2931 int i;
2933 if (ap->pflags & ATA_PFLAG_UNLOADING) {
2934 DPRINTK("ENTER/EXIT - unloading\n");
2935 return;
2938 DPRINTK("ENTER\n");
2940 /* unplug detached devices */
2941 for (i = 0; i < ATA_MAX_DEVICES; i++) {
2942 struct ata_device *dev = &ap->device[i];
2943 unsigned long flags;
2945 if (!(dev->flags & ATA_DFLAG_DETACHED))
2946 continue;
2948 spin_lock_irqsave(ap->lock, flags);
2949 dev->flags &= ~ATA_DFLAG_DETACHED;
2950 spin_unlock_irqrestore(ap->lock, flags);
2952 ata_scsi_remove_dev(dev);
2955 /* scan for new ones */
2956 ata_scsi_scan_host(ap);
2958 /* If we scanned while EH was in progress, scan would have
2959 * failed silently. Requeue if there are enabled but
2960 * unattached devices.
2962 for (i = 0; i < ATA_MAX_DEVICES; i++) {
2963 struct ata_device *dev = &ap->device[i];
2964 if (ata_dev_enabled(dev) && !dev->sdev) {
2965 queue_delayed_work(ata_aux_wq, &ap->hotplug_task, HZ);
2966 break;
2970 DPRINTK("EXIT\n");
2974 * ata_scsi_user_scan - indication for user-initiated bus scan
2975 * @shost: SCSI host to scan
2976 * @channel: Channel to scan
2977 * @id: ID to scan
2978 * @lun: LUN to scan
2980 * This function is called when user explicitly requests bus
2981 * scan. Set probe pending flag and invoke EH.
2983 * LOCKING:
2984 * SCSI layer (we don't care)
2986 * RETURNS:
2987 * Zero.
2989 static int ata_scsi_user_scan(struct Scsi_Host *shost, unsigned int channel,
2990 unsigned int id, unsigned int lun)
2992 struct ata_port *ap = ata_shost_to_port(shost);
2993 unsigned long flags;
2994 int rc = 0;
2996 if (!ap->ops->error_handler)
2997 return -EOPNOTSUPP;
2999 if ((channel != SCAN_WILD_CARD && channel != 0) ||
3000 (lun != SCAN_WILD_CARD && lun != 0))
3001 return -EINVAL;
3003 spin_lock_irqsave(ap->lock, flags);
3005 if (id == SCAN_WILD_CARD) {
3006 ap->eh_info.probe_mask |= (1 << ATA_MAX_DEVICES) - 1;
3007 ap->eh_info.action |= ATA_EH_SOFTRESET;
3008 } else {
3009 struct ata_device *dev = ata_find_dev(ap, id);
3011 if (dev) {
3012 ap->eh_info.probe_mask |= 1 << dev->devno;
3013 ap->eh_info.action |= ATA_EH_SOFTRESET;
3014 ap->eh_info.flags |= ATA_EHI_RESUME_LINK;
3015 } else
3016 rc = -EINVAL;
3019 if (rc == 0)
3020 ata_port_schedule_eh(ap);
3022 spin_unlock_irqrestore(ap->lock, flags);
3024 return rc;
3028 * ata_scsi_dev_rescan - initiate scsi_rescan_device()
3029 * @data: Pointer to ATA port to perform scsi_rescan_device()
3031 * After ATA pass thru (SAT) commands are executed successfully,
3032 * libata need to propagate the changes to SCSI layer. This
3033 * function must be executed from ata_aux_wq such that sdev
3034 * attach/detach don't race with rescan.
3036 * LOCKING:
3037 * Kernel thread context (may sleep).
3039 void ata_scsi_dev_rescan(void *data)
3041 struct ata_port *ap = data;
3042 struct ata_device *dev;
3043 unsigned int i;
3045 for (i = 0; i < ATA_MAX_DEVICES; i++) {
3046 dev = &ap->device[i];
3048 if (ata_dev_enabled(dev) && dev->sdev)
3049 scsi_rescan_device(&(dev->sdev->sdev_gendev));