blob: 90bf22204668c1828934c598db6492a9a1d96de7 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
Jeff Garzikaf36d7f2005-08-28 20:18:39 -04002 * libata-scsi.c - helper library for ATA
3 *
4 * Maintained by: Jeff Garzik <jgarzik@pobox.com>
5 * Please ALWAYS copy linux-ide@vger.kernel.org
6 * on emails.
7 *
8 * Copyright 2003-2004 Red Hat, Inc. All rights reserved.
9 * Copyright 2003-2004 Jeff Garzik
10 *
11 *
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.
16 *
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.
21 *
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.
25 *
26 *
27 * libata documentation is available via 'make {ps|pdf}docs',
28 * as Documentation/DocBook/libata.*
29 *
30 * Hardware documentation available from
31 * - http://www.t10.org/
32 * - http://www.t13.org/
33 *
Linus Torvalds1da177e2005-04-16 15:20:36 -070034 */
35
36#include <linux/kernel.h>
37#include <linux/blkdev.h>
38#include <linux/spinlock.h>
39#include <scsi/scsi.h>
40#include "scsi.h"
41#include <scsi/scsi_host.h>
42#include <linux/libata.h>
43#include <asm/uaccess.h>
44
45#include "libata.h"
46
47typedef unsigned int (*ata_xlat_func_t)(struct ata_queued_cmd *qc, u8 *scsicmd);
48static struct ata_device *
49ata_scsi_find_dev(struct ata_port *ap, struct scsi_device *scsidev);
50
51
Douglas Gilbertae006512005-10-09 09:09:35 -040052static void ata_scsi_invalid_field(struct scsi_cmnd *cmd,
53 void (*done)(struct scsi_cmnd *))
54{
55 ata_scsi_set_sense(cmd, ILLEGAL_REQUEST, 0x24, 0x0);
56 /* "Invalid field in cbd" */
57 done(cmd);
58}
59
Linus Torvalds1da177e2005-04-16 15:20:36 -070060/**
61 * ata_std_bios_param - generic bios head/sector/cylinder calculator used by sd.
62 * @sdev: SCSI device for which BIOS geometry is to be determined
63 * @bdev: block device associated with @sdev
64 * @capacity: capacity of SCSI device
65 * @geom: location to which geometry will be output
66 *
67 * Generic bios head/sector/cylinder calculator
68 * used by sd. Most BIOSes nowadays expect a XXX/255/16 (CHS)
69 * mapping. Some situations may arise where the disk is not
70 * bootable if this is not used.
71 *
72 * LOCKING:
73 * Defined by the SCSI layer. We don't really care.
74 *
75 * RETURNS:
76 * Zero.
77 */
78int ata_std_bios_param(struct scsi_device *sdev, struct block_device *bdev,
79 sector_t capacity, int geom[])
80{
81 geom[0] = 255;
82 geom[1] = 63;
83 sector_div(capacity, 255*63);
84 geom[2] = capacity;
85
86 return 0;
87}
88
89int ata_scsi_ioctl(struct scsi_device *scsidev, int cmd, void __user *arg)
90{
91 struct ata_port *ap;
92 struct ata_device *dev;
93 int val = -EINVAL, rc = -EINVAL;
94
95 ap = (struct ata_port *) &scsidev->host->hostdata[0];
96 if (!ap)
97 goto out;
98
99 dev = ata_scsi_find_dev(ap, scsidev);
100 if (!dev) {
101 rc = -ENODEV;
102 goto out;
103 }
104
105 switch (cmd) {
106 case ATA_IOC_GET_IO32:
107 val = 0;
108 if (copy_to_user(arg, &val, 1))
109 return -EFAULT;
110 return 0;
111
112 case ATA_IOC_SET_IO32:
113 val = (unsigned long) arg;
114 if (val != 0)
115 return -EINVAL;
116 return 0;
117
118 default:
119 rc = -ENOTTY;
120 break;
121 }
122
123out:
124 return rc;
125}
126
127/**
128 * ata_scsi_qc_new - acquire new ata_queued_cmd reference
129 * @ap: ATA port to which the new command is attached
130 * @dev: ATA device to which the new command is attached
131 * @cmd: SCSI command that originated this ATA command
132 * @done: SCSI command completion function
133 *
134 * Obtain a reference to an unused ata_queued_cmd structure,
135 * which is the basic libata structure representing a single
136 * ATA command sent to the hardware.
137 *
138 * If a command was available, fill in the SCSI-specific
139 * portions of the structure with information on the
140 * current command.
141 *
142 * LOCKING:
143 * spin_lock_irqsave(host_set lock)
144 *
145 * RETURNS:
146 * Command allocated, or %NULL if none available.
147 */
148struct ata_queued_cmd *ata_scsi_qc_new(struct ata_port *ap,
149 struct ata_device *dev,
150 struct scsi_cmnd *cmd,
151 void (*done)(struct scsi_cmnd *))
152{
153 struct ata_queued_cmd *qc;
154
155 qc = ata_qc_new_init(ap, dev);
156 if (qc) {
157 qc->scsicmd = cmd;
158 qc->scsidone = done;
159
160 if (cmd->use_sg) {
161 qc->sg = (struct scatterlist *) cmd->request_buffer;
162 qc->n_elem = cmd->use_sg;
163 } else {
164 qc->sg = &qc->sgent;
165 qc->n_elem = 1;
166 }
167 } else {
168 cmd->result = (DID_OK << 16) | (QUEUE_FULL << 1);
169 done(cmd);
170 }
171
172 return qc;
173}
174
175/**
176 * ata_to_sense_error - convert ATA error to SCSI error
177 * @qc: Command that we are erroring out
178 * @drv_stat: value contained in ATA status register
179 *
180 * Converts an ATA error into a SCSI error. While we are at it
181 * we decode and dump the ATA error for the user so that they
182 * have some idea what really happened at the non make-believe
183 * layer.
184 *
185 * LOCKING:
186 * spin_lock_irqsave(host_set lock)
187 */
188
189void ata_to_sense_error(struct ata_queued_cmd *qc, u8 drv_stat)
190{
191 struct scsi_cmnd *cmd = qc->scsicmd;
192 u8 err = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700193 /* Based on the 3ware driver translation table */
194 static unsigned char sense_table[][4] = {
195 /* BBD|ECC|ID|MAR */
196 {0xd1, ABORTED_COMMAND, 0x00, 0x00}, // Device busy Aborted command
197 /* BBD|ECC|ID */
198 {0xd0, ABORTED_COMMAND, 0x00, 0x00}, // Device busy Aborted command
199 /* ECC|MC|MARK */
200 {0x61, HARDWARE_ERROR, 0x00, 0x00}, // Device fault Hardware error
201 /* ICRC|ABRT */ /* NB: ICRC & !ABRT is BBD */
202 {0x84, ABORTED_COMMAND, 0x47, 0x00}, // Data CRC error SCSI parity error
203 /* MC|ID|ABRT|TRK0|MARK */
204 {0x37, NOT_READY, 0x04, 0x00}, // Unit offline Not ready
205 /* MCR|MARK */
206 {0x09, NOT_READY, 0x04, 0x00}, // Unrecovered disk error Not ready
207 /* Bad address mark */
208 {0x01, MEDIUM_ERROR, 0x13, 0x00}, // Address mark not found Address mark not found for data field
209 /* TRK0 */
210 {0x02, HARDWARE_ERROR, 0x00, 0x00}, // Track 0 not found Hardware error
211 /* Abort & !ICRC */
212 {0x04, ABORTED_COMMAND, 0x00, 0x00}, // Aborted command Aborted command
213 /* Media change request */
214 {0x08, NOT_READY, 0x04, 0x00}, // Media change request FIXME: faking offline
215 /* SRV */
216 {0x10, ABORTED_COMMAND, 0x14, 0x00}, // ID not found Recorded entity not found
217 /* Media change */
218 {0x08, NOT_READY, 0x04, 0x00}, // Media change FIXME: faking offline
219 /* ECC */
220 {0x40, MEDIUM_ERROR, 0x11, 0x04}, // Uncorrectable ECC error Unrecovered read error
221 /* BBD - block marked bad */
222 {0x80, MEDIUM_ERROR, 0x11, 0x04}, // Block marked bad Medium error, unrecovered read error
223 {0xFF, 0xFF, 0xFF, 0xFF}, // END mark
224 };
225 static unsigned char stat_table[][4] = {
226 /* Must be first because BUSY means no other bits valid */
227 {0x80, ABORTED_COMMAND, 0x47, 0x00}, // Busy, fake parity for now
228 {0x20, HARDWARE_ERROR, 0x00, 0x00}, // Device fault
229 {0x08, ABORTED_COMMAND, 0x47, 0x00}, // Timed out in xfer, fake parity for now
230 {0x04, RECOVERED_ERROR, 0x11, 0x00}, // Recovered ECC error Medium error, recovered
231 {0xFF, 0xFF, 0xFF, 0xFF}, // END mark
232 };
233 int i = 0;
234
Linus Torvalds1da177e2005-04-16 15:20:36 -0700235 /*
236 * Is this an error we can process/parse
237 */
238
239 if(drv_stat & ATA_ERR)
240 /* Read the err bits */
241 err = ata_chk_err(qc->ap);
242
243 /* Display the ATA level error info */
244
245 printk(KERN_WARNING "ata%u: status=0x%02x { ", qc->ap->id, drv_stat);
246 if(drv_stat & 0x80)
247 {
248 printk("Busy ");
249 err = 0; /* Data is not valid in this case */
250 }
251 else {
252 if(drv_stat & 0x40) printk("DriveReady ");
253 if(drv_stat & 0x20) printk("DeviceFault ");
254 if(drv_stat & 0x10) printk("SeekComplete ");
255 if(drv_stat & 0x08) printk("DataRequest ");
256 if(drv_stat & 0x04) printk("CorrectedError ");
257 if(drv_stat & 0x02) printk("Index ");
258 if(drv_stat & 0x01) printk("Error ");
259 }
260 printk("}\n");
261
262 if(err)
263 {
264 printk(KERN_WARNING "ata%u: error=0x%02x { ", qc->ap->id, err);
265 if(err & 0x04) printk("DriveStatusError ");
266 if(err & 0x80)
267 {
268 if(err & 0x04)
269 printk("BadCRC ");
270 else
271 printk("Sector ");
272 }
273 if(err & 0x40) printk("UncorrectableError ");
274 if(err & 0x10) printk("SectorIdNotFound ");
275 if(err & 0x02) printk("TrackZeroNotFound ");
276 if(err & 0x01) printk("AddrMarkNotFound ");
277 printk("}\n");
278
279 /* Should we dump sector info here too ?? */
280 }
281
282
283 /* Look for err */
284 while(sense_table[i][0] != 0xFF)
285 {
286 /* Look for best matches first */
287 if((sense_table[i][0] & err) == sense_table[i][0])
288 {
Douglas Gilbertae006512005-10-09 09:09:35 -0400289 ata_scsi_set_sense(cmd, sense_table[i][1] /* sk */,
290 sense_table[i][2] /* asc */,
291 sense_table[i][3] /* ascq */ );
Linus Torvalds1da177e2005-04-16 15:20:36 -0700292 return;
293 }
294 i++;
295 }
296 /* No immediate match */
297 if(err)
298 printk(KERN_DEBUG "ata%u: no sense translation for 0x%02x\n", qc->ap->id, err);
299
300 i = 0;
301 /* Fall back to interpreting status bits */
302 while(stat_table[i][0] != 0xFF)
303 {
304 if(stat_table[i][0] & drv_stat)
305 {
Douglas Gilbertae006512005-10-09 09:09:35 -0400306 ata_scsi_set_sense(cmd, sense_table[i][1] /* sk */,
307 sense_table[i][2] /* asc */,
308 sense_table[i][3] /* ascq */ );
Linus Torvalds1da177e2005-04-16 15:20:36 -0700309 return;
310 }
311 i++;
312 }
313 /* No error ?? */
314 printk(KERN_ERR "ata%u: called with no error (%02X)!\n", qc->ap->id, drv_stat);
315 /* additional-sense-code[-qualifier] */
316
be7db052005-04-17 15:26:13 -0500317 if (cmd->sc_data_direction == DMA_FROM_DEVICE) {
Douglas Gilbertae006512005-10-09 09:09:35 -0400318 ata_scsi_set_sense(cmd, MEDIUM_ERROR, 0x11, 0x4);
319 /* "unrecovered read error" */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700320 } else {
Douglas Gilbertae006512005-10-09 09:09:35 -0400321 ata_scsi_set_sense(cmd, MEDIUM_ERROR, 0xc, 0x2);
322 /* "write error - auto-reallocation failed" */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700323 }
324}
325
326/**
327 * ata_scsi_slave_config - Set SCSI device attributes
328 * @sdev: SCSI device to examine
329 *
330 * This is called before we actually start reading
331 * and writing to the device, to configure certain
332 * SCSI mid-layer behaviors.
333 *
334 * LOCKING:
335 * Defined by SCSI layer. We don't really care.
336 */
337
338int ata_scsi_slave_config(struct scsi_device *sdev)
339{
340 sdev->use_10_for_rw = 1;
341 sdev->use_10_for_ms = 1;
342
343 blk_queue_max_phys_segments(sdev->request_queue, LIBATA_MAX_PRD);
344
345 if (sdev->id < ATA_MAX_DEVICES) {
346 struct ata_port *ap;
347 struct ata_device *dev;
348
349 ap = (struct ata_port *) &sdev->host->hostdata[0];
350 dev = &ap->device[sdev->id];
351
352 /* TODO: 1024 is an arbitrary number, not the
353 * hardware maximum. This should be increased to
354 * 65534 when Jens Axboe's patch for dynamically
355 * determining max_sectors is merged.
356 */
357 if ((dev->flags & ATA_DFLAG_LBA48) &&
358 ((dev->flags & ATA_DFLAG_LOCK_SECTORS) == 0)) {
John W. Linvillef85bdb92005-05-12 15:49:54 -0400359 /*
360 * do not overwrite sdev->host->max_sectors, since
361 * other drives on this host may not support LBA48
362 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700363 blk_queue_max_sectors(sdev->request_queue, 2048);
364 }
365 }
366
367 return 0; /* scsi layer doesn't check return value, sigh */
368}
369
370/**
371 * ata_scsi_error - SCSI layer error handler callback
372 * @host: SCSI host on which error occurred
373 *
374 * Handles SCSI-layer-thrown error events.
375 *
376 * LOCKING:
377 * Inherited from SCSI layer (none, can sleep)
378 *
379 * RETURNS:
380 * Zero.
381 */
382
383int ata_scsi_error(struct Scsi_Host *host)
384{
385 struct ata_port *ap;
386
387 DPRINTK("ENTER\n");
388
389 ap = (struct ata_port *) &host->hostdata[0];
390 ap->ops->eng_timeout(ap);
391
392 /* TODO: this is per-command; when queueing is supported
393 * this code will either change or move to a more
394 * appropriate place
395 */
396 host->host_failed--;
Tejun Heo42517432005-08-10 13:38:27 -0400397 INIT_LIST_HEAD(&host->eh_cmd_q);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700398
399 DPRINTK("EXIT\n");
400 return 0;
401}
402
403/**
Douglas Gilbert972dcaf2005-08-11 03:35:53 -0400404 * ata_scsi_start_stop_xlat - Translate SCSI START STOP UNIT command
405 * @qc: Storage for translated ATA taskfile
406 * @scsicmd: SCSI command to translate
407 *
408 * Sets up an ATA taskfile to issue STANDBY (to stop) or READ VERIFY
409 * (to start). Perhaps these commands should be preceded by
410 * CHECK POWER MODE to see what power mode the device is already in.
411 * [See SAT revision 5 at www.t10.org]
412 *
413 * LOCKING:
414 * spin_lock_irqsave(host_set lock)
415 *
416 * RETURNS:
417 * Zero on success, non-zero on error.
418 */
419
420static unsigned int ata_scsi_start_stop_xlat(struct ata_queued_cmd *qc,
421 u8 *scsicmd)
422{
423 struct ata_taskfile *tf = &qc->tf;
424
425 tf->flags |= ATA_TFLAG_DEVICE | ATA_TFLAG_ISADDR;
426 tf->protocol = ATA_PROT_NODATA;
427 if (scsicmd[1] & 0x1) {
428 ; /* ignore IMMED bit, violates sat-r05 */
429 }
430 if (scsicmd[4] & 0x2)
Douglas Gilbertae006512005-10-09 09:09:35 -0400431 goto invalid_fld; /* LOEJ bit set not supported */
Douglas Gilbert972dcaf2005-08-11 03:35:53 -0400432 if (((scsicmd[4] >> 4) & 0xf) != 0)
Douglas Gilbertae006512005-10-09 09:09:35 -0400433 goto invalid_fld; /* power conditions not supported */
Douglas Gilbert972dcaf2005-08-11 03:35:53 -0400434 if (scsicmd[4] & 0x1) {
435 tf->nsect = 1; /* 1 sector, lba=0 */
Albert Lee9d5b1302005-10-04 08:48:17 -0400436
437 if (qc->dev->flags & ATA_DFLAG_LBA) {
438 qc->tf.flags |= ATA_TFLAG_LBA;
439
440 tf->lbah = 0x0;
441 tf->lbam = 0x0;
442 tf->lbal = 0x0;
443 tf->device |= ATA_LBA;
444 } else {
445 /* CHS */
446 tf->lbal = 0x1; /* sect */
447 tf->lbam = 0x0; /* cyl low */
448 tf->lbah = 0x0; /* cyl high */
449 }
450
Douglas Gilbert972dcaf2005-08-11 03:35:53 -0400451 tf->command = ATA_CMD_VERIFY; /* READ VERIFY */
452 } else {
453 tf->nsect = 0; /* time period value (0 implies now) */
454 tf->command = ATA_CMD_STANDBY;
455 /* Consider: ATA STANDBY IMMEDIATE command */
456 }
457 /*
458 * Standby and Idle condition timers could be implemented but that
459 * would require libata to implement the Power condition mode page
460 * and allow the user to change it. Changing mode pages requires
461 * MODE SELECT to be implemented.
462 */
463
464 return 0;
Douglas Gilbertae006512005-10-09 09:09:35 -0400465
466invalid_fld:
467 ata_scsi_set_sense(qc->scsicmd, ILLEGAL_REQUEST, 0x24, 0x0);
468 /* "Invalid field in cbd" */
469 return 1;
Douglas Gilbert972dcaf2005-08-11 03:35:53 -0400470}
471
472
473/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700474 * ata_scsi_flush_xlat - Translate SCSI SYNCHRONIZE CACHE command
475 * @qc: Storage for translated ATA taskfile
476 * @scsicmd: SCSI command to translate (ignored)
477 *
478 * Sets up an ATA taskfile to issue FLUSH CACHE or
479 * FLUSH CACHE EXT.
480 *
481 * LOCKING:
482 * spin_lock_irqsave(host_set lock)
483 *
484 * RETURNS:
485 * Zero on success, non-zero on error.
486 */
487
488static unsigned int ata_scsi_flush_xlat(struct ata_queued_cmd *qc, u8 *scsicmd)
489{
490 struct ata_taskfile *tf = &qc->tf;
491
492 tf->flags |= ATA_TFLAG_DEVICE;
493 tf->protocol = ATA_PROT_NODATA;
494
Albert Lee07506692005-10-12 15:04:18 +0800495 if ((qc->dev->flags & ATA_DFLAG_LBA48) &&
Linus Torvalds1da177e2005-04-16 15:20:36 -0700496 (ata_id_has_flush_ext(qc->dev->id)))
497 tf->command = ATA_CMD_FLUSH_EXT;
498 else
499 tf->command = ATA_CMD_FLUSH;
500
501 return 0;
502}
503
504/**
Albert Lee3aef5232005-10-04 08:47:43 -0400505 * scsi_6_lba_len - Get LBA and transfer length
506 * @scsicmd: SCSI command to translate
507 *
508 * Calculate LBA and transfer length for 6-byte commands.
509 *
510 * RETURNS:
511 * @plba: the LBA
512 * @plen: the transfer length
513 */
514
515static void scsi_6_lba_len(u8 *scsicmd, u64 *plba, u32 *plen)
516{
517 u64 lba = 0;
518 u32 len = 0;
519
520 VPRINTK("six-byte command\n");
521
522 lba |= ((u64)scsicmd[2]) << 8;
523 lba |= ((u64)scsicmd[3]);
524
525 len |= ((u32)scsicmd[4]);
526
527 *plba = lba;
528 *plen = len;
529}
530
531/**
532 * scsi_10_lba_len - Get LBA and transfer length
533 * @scsicmd: SCSI command to translate
534 *
535 * Calculate LBA and transfer length for 10-byte commands.
536 *
537 * RETURNS:
538 * @plba: the LBA
539 * @plen: the transfer length
540 */
541
542static void scsi_10_lba_len(u8 *scsicmd, u64 *plba, u32 *plen)
543{
544 u64 lba = 0;
545 u32 len = 0;
546
547 VPRINTK("ten-byte command\n");
548
549 lba |= ((u64)scsicmd[2]) << 24;
550 lba |= ((u64)scsicmd[3]) << 16;
551 lba |= ((u64)scsicmd[4]) << 8;
552 lba |= ((u64)scsicmd[5]);
553
554 len |= ((u32)scsicmd[7]) << 8;
555 len |= ((u32)scsicmd[8]);
556
557 *plba = lba;
558 *plen = len;
559}
560
561/**
562 * scsi_16_lba_len - Get LBA and transfer length
563 * @scsicmd: SCSI command to translate
564 *
565 * Calculate LBA and transfer length for 16-byte commands.
566 *
567 * RETURNS:
568 * @plba: the LBA
569 * @plen: the transfer length
570 */
571
572static void scsi_16_lba_len(u8 *scsicmd, u64 *plba, u32 *plen)
573{
574 u64 lba = 0;
575 u32 len = 0;
576
577 VPRINTK("sixteen-byte command\n");
578
579 lba |= ((u64)scsicmd[2]) << 56;
580 lba |= ((u64)scsicmd[3]) << 48;
581 lba |= ((u64)scsicmd[4]) << 40;
582 lba |= ((u64)scsicmd[5]) << 32;
583 lba |= ((u64)scsicmd[6]) << 24;
584 lba |= ((u64)scsicmd[7]) << 16;
585 lba |= ((u64)scsicmd[8]) << 8;
586 lba |= ((u64)scsicmd[9]);
587
588 len |= ((u32)scsicmd[10]) << 24;
589 len |= ((u32)scsicmd[11]) << 16;
590 len |= ((u32)scsicmd[12]) << 8;
591 len |= ((u32)scsicmd[13]);
592
593 *plba = lba;
594 *plen = len;
595}
596
597/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700598 * ata_scsi_verify_xlat - Translate SCSI VERIFY command into an ATA one
599 * @qc: Storage for translated ATA taskfile
600 * @scsicmd: SCSI command to translate
601 *
602 * Converts SCSI VERIFY command to an ATA READ VERIFY command.
603 *
604 * LOCKING:
605 * spin_lock_irqsave(host_set lock)
606 *
607 * RETURNS:
608 * Zero on success, non-zero on error.
609 */
610
611static unsigned int ata_scsi_verify_xlat(struct ata_queued_cmd *qc, u8 *scsicmd)
612{
613 struct ata_taskfile *tf = &qc->tf;
Albert Lee8bf62ece2005-05-12 15:29:42 -0400614 struct ata_device *dev = qc->dev;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700615 u64 dev_sectors = qc->dev->n_sectors;
Albert Lee3aef5232005-10-04 08:47:43 -0400616 u64 block;
617 u32 n_block;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700618
619 tf->flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
620 tf->protocol = ATA_PROT_NODATA;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700621
Albert Lee3aef5232005-10-04 08:47:43 -0400622 if (scsicmd[0] == VERIFY)
623 scsi_10_lba_len(scsicmd, &block, &n_block);
624 else if (scsicmd[0] == VERIFY_16)
625 scsi_16_lba_len(scsicmd, &block, &n_block);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700626 else
Douglas Gilbertae006512005-10-09 09:09:35 -0400627 goto invalid_fld;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700628
Albert Lee8bf62ece2005-05-12 15:29:42 -0400629 if (!n_block)
Douglas Gilbertae006512005-10-09 09:09:35 -0400630 goto nothing_to_do;
Albert Lee8bf62ece2005-05-12 15:29:42 -0400631 if (block >= dev_sectors)
Douglas Gilbertae006512005-10-09 09:09:35 -0400632 goto out_of_range;
Albert Lee8bf62ece2005-05-12 15:29:42 -0400633 if ((block + n_block) > dev_sectors)
Douglas Gilbertae006512005-10-09 09:09:35 -0400634 goto out_of_range;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700635
Albert Lee07506692005-10-12 15:04:18 +0800636 if (dev->flags & ATA_DFLAG_LBA) {
637 tf->flags |= ATA_TFLAG_LBA;
638
639 if (dev->flags & ATA_DFLAG_LBA48) {
640 if (n_block > (64 * 1024))
641 goto invalid_fld;
642
643 /* use LBA48 */
644 tf->flags |= ATA_TFLAG_LBA48;
Albert Lee8bf62ece2005-05-12 15:29:42 -0400645 tf->command = ATA_CMD_VERIFY_EXT;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700646
Albert Lee8bf62ece2005-05-12 15:29:42 -0400647 tf->hob_nsect = (n_block >> 8) & 0xff;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700648
Albert Lee8bf62ece2005-05-12 15:29:42 -0400649 tf->hob_lbah = (block >> 40) & 0xff;
650 tf->hob_lbam = (block >> 32) & 0xff;
651 tf->hob_lbal = (block >> 24) & 0xff;
652 } else {
Albert Lee07506692005-10-12 15:04:18 +0800653 if (n_block > 256)
654 goto invalid_fld;
655
656 /* use LBA28 */
Albert Lee8bf62ece2005-05-12 15:29:42 -0400657 tf->command = ATA_CMD_VERIFY;
658
659 tf->device |= (block >> 24) & 0xf;
660 }
661
662 tf->nsect = n_block & 0xff;
663
664 tf->lbah = (block >> 16) & 0xff;
665 tf->lbam = (block >> 8) & 0xff;
666 tf->lbal = block & 0xff;
667
668 tf->device |= ATA_LBA;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700669 } else {
Albert Lee8bf62ece2005-05-12 15:29:42 -0400670 /* CHS */
671 u32 sect, head, cyl, track;
672
Albert Lee07506692005-10-12 15:04:18 +0800673 if (n_block > 256)
674 goto invalid_fld;
675
Albert Lee8bf62ece2005-05-12 15:29:42 -0400676 /* Convert LBA to CHS */
677 track = (u32)block / dev->sectors;
678 cyl = track / dev->heads;
679 head = track % dev->heads;
680 sect = (u32)block % dev->sectors + 1;
681
Albert Leec187c4b2005-10-04 08:46:51 -0400682 DPRINTK("block %u track %u cyl %u head %u sect %u\n",
683 (u32)block, track, cyl, head, sect);
Albert Lee8bf62ece2005-05-12 15:29:42 -0400684
685 /* Check whether the converted CHS can fit.
686 Cylinder: 0-65535
687 Head: 0-15
688 Sector: 1-255*/
689 if ((cyl >> 16) || (head >> 4) || (sect >> 8) || (!sect))
Douglas Gilbertae006512005-10-09 09:09:35 -0400690 goto out_of_range;
Albert Lee8bf62ece2005-05-12 15:29:42 -0400691
Linus Torvalds1da177e2005-04-16 15:20:36 -0700692 tf->command = ATA_CMD_VERIFY;
Albert Lee8bf62ece2005-05-12 15:29:42 -0400693 tf->nsect = n_block & 0xff; /* Sector count 0 means 256 sectors */
694 tf->lbal = sect;
695 tf->lbam = cyl;
696 tf->lbah = cyl >> 8;
697 tf->device |= head;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700698 }
699
Linus Torvalds1da177e2005-04-16 15:20:36 -0700700 return 0;
Douglas Gilbertae006512005-10-09 09:09:35 -0400701
702invalid_fld:
703 ata_scsi_set_sense(qc->scsicmd, ILLEGAL_REQUEST, 0x24, 0x0);
704 /* "Invalid field in cbd" */
705 return 1;
706
707out_of_range:
708 ata_scsi_set_sense(qc->scsicmd, ILLEGAL_REQUEST, 0x21, 0x0);
709 /* "Logical Block Address out of range" */
710 return 1;
711
712nothing_to_do:
713 qc->scsicmd->result = SAM_STAT_GOOD;
714 return 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700715}
716
717/**
718 * ata_scsi_rw_xlat - Translate SCSI r/w command into an ATA one
719 * @qc: Storage for translated ATA taskfile
720 * @scsicmd: SCSI command to translate
721 *
722 * Converts any of six SCSI read/write commands into the
723 * ATA counterpart, including starting sector (LBA),
724 * sector count, and taking into account the device's LBA48
725 * support.
726 *
727 * Commands %READ_6, %READ_10, %READ_16, %WRITE_6, %WRITE_10, and
728 * %WRITE_16 are currently supported.
729 *
730 * LOCKING:
731 * spin_lock_irqsave(host_set lock)
732 *
733 * RETURNS:
734 * Zero on success, non-zero on error.
735 */
736
737static unsigned int ata_scsi_rw_xlat(struct ata_queued_cmd *qc, u8 *scsicmd)
738{
739 struct ata_taskfile *tf = &qc->tf;
Albert Lee8bf62ece2005-05-12 15:29:42 -0400740 struct ata_device *dev = qc->dev;
Albert Lee3aef5232005-10-04 08:47:43 -0400741 u64 block;
742 u32 n_block;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700743
744 tf->flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700745
Albert Lee8cbd6df2005-10-12 15:06:27 +0800746 if (scsicmd[0] == WRITE_10 || scsicmd[0] == WRITE_6 ||
747 scsicmd[0] == WRITE_16)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700748 tf->flags |= ATA_TFLAG_WRITE;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700749
Albert Lee8bf62ece2005-05-12 15:29:42 -0400750 /* Calculate the SCSI LBA and transfer length. */
Albert Lee3aef5232005-10-04 08:47:43 -0400751 switch (scsicmd[0]) {
752 case READ_10:
753 case WRITE_10:
754 scsi_10_lba_len(scsicmd, &block, &n_block);
755 break;
756 case READ_6:
757 case WRITE_6:
758 scsi_6_lba_len(scsicmd, &block, &n_block);
Albert Leec187c4b2005-10-04 08:46:51 -0400759
760 /* for 6-byte r/w commands, transfer length 0
761 * means 256 blocks of data, not 0 block.
762 */
Jeff Garzik76b2bf92005-08-29 19:24:43 -0400763 if (!n_block)
764 n_block = 256;
Albert Lee3aef5232005-10-04 08:47:43 -0400765 break;
766 case READ_16:
767 case WRITE_16:
768 scsi_16_lba_len(scsicmd, &block, &n_block);
769 break;
770 default:
Albert Lee8bf62ece2005-05-12 15:29:42 -0400771 DPRINTK("no-byte command\n");
Douglas Gilbertae006512005-10-09 09:09:35 -0400772 goto invalid_fld;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700773 }
774
Albert Lee8bf62ece2005-05-12 15:29:42 -0400775 /* Check and compose ATA command */
776 if (!n_block)
Albert Leec187c4b2005-10-04 08:46:51 -0400777 /* For 10-byte and 16-byte SCSI R/W commands, transfer
778 * length 0 means transfer 0 block of data.
779 * However, for ATA R/W commands, sector count 0 means
780 * 256 or 65536 sectors, not 0 sectors as in SCSI.
781 */
Douglas Gilbertae006512005-10-09 09:09:35 -0400782 goto nothing_to_do;
Albert Lee8bf62ece2005-05-12 15:29:42 -0400783
Albert Lee07506692005-10-12 15:04:18 +0800784 if (dev->flags & ATA_DFLAG_LBA) {
785 tf->flags |= ATA_TFLAG_LBA;
786
787 if (dev->flags & ATA_DFLAG_LBA48) {
Albert Lee8bf62ece2005-05-12 15:29:42 -0400788 /* The request -may- be too large for LBA48. */
789 if ((block >> 48) || (n_block > 65536))
Douglas Gilbertae006512005-10-09 09:09:35 -0400790 goto out_of_range;
Albert Lee8bf62ece2005-05-12 15:29:42 -0400791
Albert Lee07506692005-10-12 15:04:18 +0800792 /* use LBA48 */
793 tf->flags |= ATA_TFLAG_LBA48;
794
Albert Lee8bf62ece2005-05-12 15:29:42 -0400795 tf->hob_nsect = (n_block >> 8) & 0xff;
796
797 tf->hob_lbah = (block >> 40) & 0xff;
798 tf->hob_lbam = (block >> 32) & 0xff;
799 tf->hob_lbal = (block >> 24) & 0xff;
800 } else {
Albert Lee07506692005-10-12 15:04:18 +0800801 /* use LBA28 */
Albert Lee8bf62ece2005-05-12 15:29:42 -0400802
803 /* The request -may- be too large for LBA28. */
804 if ((block >> 28) || (n_block > 256))
Douglas Gilbertae006512005-10-09 09:09:35 -0400805 goto out_of_range;
Albert Lee8bf62ece2005-05-12 15:29:42 -0400806
807 tf->device |= (block >> 24) & 0xf;
808 }
Albert Leec187c4b2005-10-04 08:46:51 -0400809
Albert Lee8cbd6df2005-10-12 15:06:27 +0800810 ata_rwcmd_protocol(qc);
811
Albert Lee8bf62ece2005-05-12 15:29:42 -0400812 qc->nsect = n_block;
813 tf->nsect = n_block & 0xff;
814
815 tf->lbah = (block >> 16) & 0xff;
816 tf->lbam = (block >> 8) & 0xff;
817 tf->lbal = block & 0xff;
818
819 tf->device |= ATA_LBA;
820 } else {
821 /* CHS */
822 u32 sect, head, cyl, track;
823
824 /* The request -may- be too large for CHS addressing. */
825 if ((block >> 28) || (n_block > 256))
Douglas Gilbertae006512005-10-09 09:09:35 -0400826 goto out_of_range;
Albert Leec187c4b2005-10-04 08:46:51 -0400827
Albert Lee8cbd6df2005-10-12 15:06:27 +0800828 ata_rwcmd_protocol(qc);
829
Albert Lee8bf62ece2005-05-12 15:29:42 -0400830 /* Convert LBA to CHS */
831 track = (u32)block / dev->sectors;
832 cyl = track / dev->heads;
833 head = track % dev->heads;
834 sect = (u32)block % dev->sectors + 1;
835
Albert Leec187c4b2005-10-04 08:46:51 -0400836 DPRINTK("block %u track %u cyl %u head %u sect %u\n",
Albert Lee8bf62ece2005-05-12 15:29:42 -0400837 (u32)block, track, cyl, head, sect);
Albert Leec187c4b2005-10-04 08:46:51 -0400838
Albert Lee8bf62ece2005-05-12 15:29:42 -0400839 /* Check whether the converted CHS can fit.
840 Cylinder: 0-65535
841 Head: 0-15
842 Sector: 1-255*/
Albert Leec187c4b2005-10-04 08:46:51 -0400843 if ((cyl >> 16) || (head >> 4) || (sect >> 8) || (!sect))
Douglas Gilbertae006512005-10-09 09:09:35 -0400844 goto out_of_range;
Albert Leec187c4b2005-10-04 08:46:51 -0400845
Albert Lee8bf62ece2005-05-12 15:29:42 -0400846 qc->nsect = n_block;
847 tf->nsect = n_block & 0xff; /* Sector count 0 means 256 sectors */
848 tf->lbal = sect;
849 tf->lbam = cyl;
850 tf->lbah = cyl >> 8;
851 tf->device |= head;
852 }
853
854 return 0;
Douglas Gilbertae006512005-10-09 09:09:35 -0400855
856invalid_fld:
857 ata_scsi_set_sense(qc->scsicmd, ILLEGAL_REQUEST, 0x24, 0x0);
858 /* "Invalid field in cbd" */
859 return 1;
860
861out_of_range:
862 ata_scsi_set_sense(qc->scsicmd, ILLEGAL_REQUEST, 0x21, 0x0);
863 /* "Logical Block Address out of range" */
864 return 1;
865
866nothing_to_do:
867 qc->scsicmd->result = SAM_STAT_GOOD;
868 return 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700869}
870
871static int ata_scsi_qc_complete(struct ata_queued_cmd *qc, u8 drv_stat)
872{
873 struct scsi_cmnd *cmd = qc->scsicmd;
874
875 if (unlikely(drv_stat & (ATA_ERR | ATA_BUSY | ATA_DRQ)))
876 ata_to_sense_error(qc, drv_stat);
877 else
878 cmd->result = SAM_STAT_GOOD;
879
880 qc->scsidone(cmd);
881
882 return 0;
883}
884
885/**
886 * ata_scsi_translate - Translate then issue SCSI command to ATA device
887 * @ap: ATA port to which the command is addressed
888 * @dev: ATA device to which the command is addressed
889 * @cmd: SCSI command to execute
890 * @done: SCSI command completion function
891 * @xlat_func: Actor which translates @cmd to an ATA taskfile
892 *
893 * Our ->queuecommand() function has decided that the SCSI
894 * command issued can be directly translated into an ATA
895 * command, rather than handled internally.
896 *
897 * This function sets up an ata_queued_cmd structure for the
898 * SCSI command, and sends that ata_queued_cmd to the hardware.
899 *
Douglas Gilbertae006512005-10-09 09:09:35 -0400900 * The xlat_func argument (actor) returns 0 if ready to execute
901 * ATA command, else 1 to finish translation. If 1 is returned
902 * then cmd->result (and possibly cmd->sense_buffer) are assumed
903 * to be set reflecting an error condition or clean (early)
904 * termination.
905 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700906 * LOCKING:
907 * spin_lock_irqsave(host_set lock)
908 */
909
910static void ata_scsi_translate(struct ata_port *ap, struct ata_device *dev,
911 struct scsi_cmnd *cmd,
912 void (*done)(struct scsi_cmnd *),
913 ata_xlat_func_t xlat_func)
914{
915 struct ata_queued_cmd *qc;
916 u8 *scsicmd = cmd->cmnd;
917
918 VPRINTK("ENTER\n");
919
920 qc = ata_scsi_qc_new(ap, dev, cmd, done);
921 if (!qc)
Douglas Gilbertae006512005-10-09 09:09:35 -0400922 goto err_mem;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700923
924 /* data is present; dma-map it */
be7db052005-04-17 15:26:13 -0500925 if (cmd->sc_data_direction == DMA_FROM_DEVICE ||
926 cmd->sc_data_direction == DMA_TO_DEVICE) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700927 if (unlikely(cmd->request_bufflen < 1)) {
928 printk(KERN_WARNING "ata%u(%u): WARNING: zero len r/w req\n",
929 ap->id, dev->devno);
Douglas Gilbertae006512005-10-09 09:09:35 -0400930 goto err_did;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700931 }
932
933 if (cmd->use_sg)
934 ata_sg_init(qc, cmd->request_buffer, cmd->use_sg);
935 else
936 ata_sg_init_one(qc, cmd->request_buffer,
937 cmd->request_bufflen);
938
939 qc->dma_dir = cmd->sc_data_direction;
940 }
941
942 qc->complete_fn = ata_scsi_qc_complete;
943
944 if (xlat_func(qc, scsicmd))
Douglas Gilbertae006512005-10-09 09:09:35 -0400945 goto early_finish;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700946
947 /* select device, send command to hardware */
948 if (ata_qc_issue(qc))
Douglas Gilbertae006512005-10-09 09:09:35 -0400949 goto err_did;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700950
951 VPRINTK("EXIT\n");
952 return;
953
Douglas Gilbertae006512005-10-09 09:09:35 -0400954early_finish:
955 ata_qc_free(qc);
956 done(cmd);
957 DPRINTK("EXIT - early finish (good or error)\n");
958 return;
959
960err_did:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700961 ata_qc_free(qc);
Douglas Gilbertae006512005-10-09 09:09:35 -0400962err_mem:
963 cmd->result = (DID_ERROR << 16);
964 done(cmd);
965 DPRINTK("EXIT - internal\n");
966 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700967}
968
969/**
970 * ata_scsi_rbuf_get - Map response buffer.
971 * @cmd: SCSI command containing buffer to be mapped.
972 * @buf_out: Pointer to mapped area.
973 *
974 * Maps buffer contained within SCSI command @cmd.
975 *
976 * LOCKING:
977 * spin_lock_irqsave(host_set lock)
978 *
979 * RETURNS:
980 * Length of response buffer.
981 */
982
983static unsigned int ata_scsi_rbuf_get(struct scsi_cmnd *cmd, u8 **buf_out)
984{
985 u8 *buf;
986 unsigned int buflen;
987
988 if (cmd->use_sg) {
989 struct scatterlist *sg;
990
991 sg = (struct scatterlist *) cmd->request_buffer;
992 buf = kmap_atomic(sg->page, KM_USER0) + sg->offset;
993 buflen = sg->length;
994 } else {
995 buf = cmd->request_buffer;
996 buflen = cmd->request_bufflen;
997 }
998
999 *buf_out = buf;
1000 return buflen;
1001}
1002
1003/**
1004 * ata_scsi_rbuf_put - Unmap response buffer.
1005 * @cmd: SCSI command containing buffer to be unmapped.
1006 * @buf: buffer to unmap
1007 *
1008 * Unmaps response buffer contained within @cmd.
1009 *
1010 * LOCKING:
1011 * spin_lock_irqsave(host_set lock)
1012 */
1013
1014static inline void ata_scsi_rbuf_put(struct scsi_cmnd *cmd, u8 *buf)
1015{
1016 if (cmd->use_sg) {
1017 struct scatterlist *sg;
1018
1019 sg = (struct scatterlist *) cmd->request_buffer;
1020 kunmap_atomic(buf - sg->offset, KM_USER0);
1021 }
1022}
1023
1024/**
1025 * ata_scsi_rbuf_fill - wrapper for SCSI command simulators
1026 * @args: device IDENTIFY data / SCSI command of interest.
1027 * @actor: Callback hook for desired SCSI command simulator
1028 *
1029 * Takes care of the hard work of simulating a SCSI command...
1030 * Mapping the response buffer, calling the command's handler,
1031 * and handling the handler's return value. This return value
1032 * indicates whether the handler wishes the SCSI command to be
Douglas Gilbertae006512005-10-09 09:09:35 -04001033 * completed successfully (0), or not (in which case cmd->result
1034 * and sense buffer are assumed to be set).
Linus Torvalds1da177e2005-04-16 15:20:36 -07001035 *
1036 * LOCKING:
1037 * spin_lock_irqsave(host_set lock)
1038 */
1039
1040void ata_scsi_rbuf_fill(struct ata_scsi_args *args,
1041 unsigned int (*actor) (struct ata_scsi_args *args,
1042 u8 *rbuf, unsigned int buflen))
1043{
1044 u8 *rbuf;
1045 unsigned int buflen, rc;
1046 struct scsi_cmnd *cmd = args->cmd;
1047
1048 buflen = ata_scsi_rbuf_get(cmd, &rbuf);
1049 memset(rbuf, 0, buflen);
1050 rc = actor(args, rbuf, buflen);
1051 ata_scsi_rbuf_put(cmd, rbuf);
1052
Douglas Gilbertae006512005-10-09 09:09:35 -04001053 if (rc == 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001054 cmd->result = SAM_STAT_GOOD;
Douglas Gilbertae006512005-10-09 09:09:35 -04001055 args->done(cmd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001056}
1057
1058/**
1059 * ata_scsiop_inq_std - Simulate INQUIRY command
1060 * @args: device IDENTIFY data / SCSI command of interest.
1061 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1062 * @buflen: Response buffer length.
1063 *
1064 * Returns standard device identification data associated
1065 * with non-EVPD INQUIRY command output.
1066 *
1067 * LOCKING:
1068 * spin_lock_irqsave(host_set lock)
1069 */
1070
1071unsigned int ata_scsiop_inq_std(struct ata_scsi_args *args, u8 *rbuf,
1072 unsigned int buflen)
1073{
1074 u8 hdr[] = {
1075 TYPE_DISK,
1076 0,
1077 0x5, /* claim SPC-3 version compatibility */
1078 2,
1079 95 - 4
1080 };
1081
1082 /* set scsi removeable (RMB) bit per ata bit */
1083 if (ata_id_removeable(args->id))
1084 hdr[1] |= (1 << 7);
1085
1086 VPRINTK("ENTER\n");
1087
1088 memcpy(rbuf, hdr, sizeof(hdr));
1089
1090 if (buflen > 35) {
1091 memcpy(&rbuf[8], "ATA ", 8);
1092 ata_dev_id_string(args->id, &rbuf[16], ATA_ID_PROD_OFS, 16);
1093 ata_dev_id_string(args->id, &rbuf[32], ATA_ID_FW_REV_OFS, 4);
1094 if (rbuf[32] == 0 || rbuf[32] == ' ')
1095 memcpy(&rbuf[32], "n/a ", 4);
1096 }
1097
1098 if (buflen > 63) {
1099 const u8 versions[] = {
1100 0x60, /* SAM-3 (no version claimed) */
1101
1102 0x03,
1103 0x20, /* SBC-2 (no version claimed) */
1104
1105 0x02,
1106 0x60 /* SPC-3 (no version claimed) */
1107 };
1108
1109 memcpy(rbuf + 59, versions, sizeof(versions));
1110 }
1111
1112 return 0;
1113}
1114
1115/**
1116 * ata_scsiop_inq_00 - Simulate INQUIRY EVPD page 0, list of pages
1117 * @args: device IDENTIFY data / SCSI command of interest.
1118 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1119 * @buflen: Response buffer length.
1120 *
1121 * Returns list of inquiry EVPD pages available.
1122 *
1123 * LOCKING:
1124 * spin_lock_irqsave(host_set lock)
1125 */
1126
1127unsigned int ata_scsiop_inq_00(struct ata_scsi_args *args, u8 *rbuf,
1128 unsigned int buflen)
1129{
1130 const u8 pages[] = {
1131 0x00, /* page 0x00, this page */
1132 0x80, /* page 0x80, unit serial no page */
1133 0x83 /* page 0x83, device ident page */
1134 };
1135 rbuf[3] = sizeof(pages); /* number of supported EVPD pages */
1136
1137 if (buflen > 6)
1138 memcpy(rbuf + 4, pages, sizeof(pages));
1139
1140 return 0;
1141}
1142
1143/**
1144 * ata_scsiop_inq_80 - Simulate INQUIRY EVPD page 80, device serial number
1145 * @args: device IDENTIFY data / SCSI command of interest.
1146 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1147 * @buflen: Response buffer length.
1148 *
1149 * Returns ATA device serial number.
1150 *
1151 * LOCKING:
1152 * spin_lock_irqsave(host_set lock)
1153 */
1154
1155unsigned int ata_scsiop_inq_80(struct ata_scsi_args *args, u8 *rbuf,
1156 unsigned int buflen)
1157{
1158 const u8 hdr[] = {
1159 0,
1160 0x80, /* this page code */
1161 0,
1162 ATA_SERNO_LEN, /* page len */
1163 };
1164 memcpy(rbuf, hdr, sizeof(hdr));
1165
1166 if (buflen > (ATA_SERNO_LEN + 4 - 1))
1167 ata_dev_id_string(args->id, (unsigned char *) &rbuf[4],
1168 ATA_ID_SERNO_OFS, ATA_SERNO_LEN);
1169
1170 return 0;
1171}
1172
1173static const char *inq_83_str = "Linux ATA-SCSI simulator";
1174
1175/**
1176 * ata_scsiop_inq_83 - Simulate INQUIRY EVPD page 83, device identity
1177 * @args: device IDENTIFY data / SCSI command of interest.
1178 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1179 * @buflen: Response buffer length.
1180 *
1181 * Returns device identification. Currently hardcoded to
1182 * return "Linux ATA-SCSI simulator".
1183 *
1184 * LOCKING:
1185 * spin_lock_irqsave(host_set lock)
1186 */
1187
1188unsigned int ata_scsiop_inq_83(struct ata_scsi_args *args, u8 *rbuf,
1189 unsigned int buflen)
1190{
1191 rbuf[1] = 0x83; /* this page code */
1192 rbuf[3] = 4 + strlen(inq_83_str); /* page len */
1193
1194 /* our one and only identification descriptor (vendor-specific) */
1195 if (buflen > (strlen(inq_83_str) + 4 + 4 - 1)) {
1196 rbuf[4 + 0] = 2; /* code set: ASCII */
1197 rbuf[4 + 3] = strlen(inq_83_str);
1198 memcpy(rbuf + 4 + 4, inq_83_str, strlen(inq_83_str));
1199 }
1200
1201 return 0;
1202}
1203
1204/**
Jeff Garzik0cba6322005-05-30 19:49:12 -04001205 * ata_scsiop_noop - Command handler that simply returns success.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001206 * @args: device IDENTIFY data / SCSI command of interest.
1207 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1208 * @buflen: Response buffer length.
1209 *
1210 * No operation. Simply returns success to caller, to indicate
1211 * that the caller should successfully complete this SCSI command.
1212 *
1213 * LOCKING:
1214 * spin_lock_irqsave(host_set lock)
1215 */
1216
1217unsigned int ata_scsiop_noop(struct ata_scsi_args *args, u8 *rbuf,
1218 unsigned int buflen)
1219{
1220 VPRINTK("ENTER\n");
1221 return 0;
1222}
1223
1224/**
1225 * ata_msense_push - Push data onto MODE SENSE data output buffer
1226 * @ptr_io: (input/output) Location to store more output data
1227 * @last: End of output data buffer
1228 * @buf: Pointer to BLOB being added to output buffer
1229 * @buflen: Length of BLOB
1230 *
1231 * Store MODE SENSE data on an output buffer.
1232 *
1233 * LOCKING:
1234 * None.
1235 */
1236
1237static void ata_msense_push(u8 **ptr_io, const u8 *last,
1238 const u8 *buf, unsigned int buflen)
1239{
1240 u8 *ptr = *ptr_io;
1241
1242 if ((ptr + buflen - 1) > last)
1243 return;
1244
1245 memcpy(ptr, buf, buflen);
1246
1247 ptr += buflen;
1248
1249 *ptr_io = ptr;
1250}
1251
1252/**
1253 * ata_msense_caching - Simulate MODE SENSE caching info page
1254 * @id: device IDENTIFY data
1255 * @ptr_io: (input/output) Location to store more output data
1256 * @last: End of output data buffer
1257 *
1258 * Generate a caching info page, which conditionally indicates
1259 * write caching to the SCSI layer, depending on device
1260 * capabilities.
1261 *
1262 * LOCKING:
1263 * None.
1264 */
1265
1266static unsigned int ata_msense_caching(u16 *id, u8 **ptr_io,
1267 const u8 *last)
1268{
1269 u8 page[] = {
1270 0x8, /* page code */
1271 0x12, /* page length */
1272 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 10 zeroes */
1273 0, 0, 0, 0, 0, 0, 0, 0 /* 8 zeroes */
1274 };
1275
1276 if (ata_id_wcache_enabled(id))
1277 page[2] |= (1 << 2); /* write cache enable */
1278 if (!ata_id_rahead_enabled(id))
1279 page[12] |= (1 << 5); /* disable read ahead */
1280
1281 ata_msense_push(ptr_io, last, page, sizeof(page));
1282 return sizeof(page);
1283}
1284
1285/**
1286 * ata_msense_ctl_mode - Simulate MODE SENSE control mode page
1287 * @dev: Device associated with this MODE SENSE command
1288 * @ptr_io: (input/output) Location to store more output data
1289 * @last: End of output data buffer
1290 *
1291 * Generate a generic MODE SENSE control mode page.
1292 *
1293 * LOCKING:
1294 * None.
1295 */
1296
1297static unsigned int ata_msense_ctl_mode(u8 **ptr_io, const u8 *last)
1298{
1299 const u8 page[] = {0xa, 0xa, 6, 0, 0, 0, 0, 0, 0xff, 0xff, 0, 30};
1300
1301 /* byte 2: set the descriptor format sense data bit (bit 2)
1302 * since we need to support returning this format for SAT
1303 * commands and any SCSI commands against a 48b LBA device.
1304 */
1305
1306 ata_msense_push(ptr_io, last, page, sizeof(page));
1307 return sizeof(page);
1308}
1309
1310/**
1311 * ata_msense_rw_recovery - Simulate MODE SENSE r/w error recovery page
1312 * @dev: Device associated with this MODE SENSE command
1313 * @ptr_io: (input/output) Location to store more output data
1314 * @last: End of output data buffer
1315 *
1316 * Generate a generic MODE SENSE r/w error recovery page.
1317 *
1318 * LOCKING:
1319 * None.
1320 */
1321
1322static unsigned int ata_msense_rw_recovery(u8 **ptr_io, const u8 *last)
1323{
1324 const u8 page[] = {
1325 0x1, /* page code */
1326 0xa, /* page length */
1327 (1 << 7) | (1 << 6), /* note auto r/w reallocation */
1328 0, 0, 0, 0, 0, 0, 0, 0, 0 /* 9 zeroes */
1329 };
1330
1331 ata_msense_push(ptr_io, last, page, sizeof(page));
1332 return sizeof(page);
1333}
1334
1335/**
1336 * ata_scsiop_mode_sense - Simulate MODE SENSE 6, 10 commands
1337 * @args: device IDENTIFY data / SCSI command of interest.
1338 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1339 * @buflen: Response buffer length.
1340 *
1341 * Simulate MODE SENSE commands.
1342 *
1343 * LOCKING:
1344 * spin_lock_irqsave(host_set lock)
1345 */
1346
1347unsigned int ata_scsiop_mode_sense(struct ata_scsi_args *args, u8 *rbuf,
1348 unsigned int buflen)
1349{
1350 u8 *scsicmd = args->cmd->cmnd, *p, *last;
1351 unsigned int page_control, six_byte, output_len;
1352
1353 VPRINTK("ENTER\n");
1354
1355 six_byte = (scsicmd[0] == MODE_SENSE);
1356
1357 /* we only support saved and current values (which we treat
1358 * in the same manner)
1359 */
1360 page_control = scsicmd[2] >> 6;
Douglas Gilbertae006512005-10-09 09:09:35 -04001361 switch (page_control) {
1362 case 0: /* current */
1363 break; /* supported */
1364 case 3: /* saved */
1365 goto saving_not_supp;
1366 case 1: /* changeable */
1367 case 2: /* defaults */
1368 default:
1369 goto invalid_fld;
1370 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001371
1372 if (six_byte)
1373 output_len = 4;
1374 else
1375 output_len = 8;
1376
1377 p = rbuf + output_len;
1378 last = rbuf + buflen - 1;
1379
1380 switch(scsicmd[2] & 0x3f) {
1381 case 0x01: /* r/w error recovery */
1382 output_len += ata_msense_rw_recovery(&p, last);
1383 break;
1384
1385 case 0x08: /* caching */
1386 output_len += ata_msense_caching(args->id, &p, last);
1387 break;
1388
1389 case 0x0a: { /* control mode */
1390 output_len += ata_msense_ctl_mode(&p, last);
1391 break;
1392 }
1393
1394 case 0x3f: /* all pages */
1395 output_len += ata_msense_rw_recovery(&p, last);
1396 output_len += ata_msense_caching(args->id, &p, last);
1397 output_len += ata_msense_ctl_mode(&p, last);
1398 break;
1399
1400 default: /* invalid page code */
Douglas Gilbertae006512005-10-09 09:09:35 -04001401 goto invalid_fld;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001402 }
1403
1404 if (six_byte) {
1405 output_len--;
1406 rbuf[0] = output_len;
1407 } else {
1408 output_len -= 2;
1409 rbuf[0] = output_len >> 8;
1410 rbuf[1] = output_len;
1411 }
1412
1413 return 0;
Douglas Gilbertae006512005-10-09 09:09:35 -04001414
1415invalid_fld:
1416 ata_scsi_set_sense(args->cmd, ILLEGAL_REQUEST, 0x24, 0x0);
1417 /* "Invalid field in cbd" */
1418 return 1;
1419
1420saving_not_supp:
1421 ata_scsi_set_sense(args->cmd, ILLEGAL_REQUEST, 0x39, 0x0);
1422 /* "Saving parameters not supported" */
1423 return 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001424}
1425
1426/**
1427 * ata_scsiop_read_cap - Simulate READ CAPACITY[ 16] commands
1428 * @args: device IDENTIFY data / SCSI command of interest.
1429 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1430 * @buflen: Response buffer length.
1431 *
1432 * Simulate READ CAPACITY commands.
1433 *
1434 * LOCKING:
1435 * spin_lock_irqsave(host_set lock)
1436 */
1437
1438unsigned int ata_scsiop_read_cap(struct ata_scsi_args *args, u8 *rbuf,
1439 unsigned int buflen)
1440{
1441 u64 n_sectors;
1442 u32 tmp;
1443
1444 VPRINTK("ENTER\n");
1445
Albert Lee8bf62ece2005-05-12 15:29:42 -04001446 if (ata_id_has_lba(args->id)) {
1447 if (ata_id_has_lba48(args->id))
1448 n_sectors = ata_id_u64(args->id, 100);
1449 else
1450 n_sectors = ata_id_u32(args->id, 60);
1451 } else {
1452 /* CHS default translation */
1453 n_sectors = args->id[1] * args->id[3] * args->id[6];
1454
1455 if (ata_id_current_chs_valid(args->id))
1456 /* CHS current translation */
1457 n_sectors = ata_id_u32(args->id, 57);
1458 }
1459
Linus Torvalds1da177e2005-04-16 15:20:36 -07001460 n_sectors--; /* ATA TotalUserSectors - 1 */
1461
Linus Torvalds1da177e2005-04-16 15:20:36 -07001462 if (args->cmd->cmnd[0] == READ_CAPACITY) {
Philip Pokorny0c144d02005-05-28 01:24:47 -07001463 if( n_sectors >= 0xffffffffULL )
1464 tmp = 0xffffffff ; /* Return max count on overflow */
1465 else
1466 tmp = n_sectors ;
1467
Linus Torvalds1da177e2005-04-16 15:20:36 -07001468 /* sector count, 32-bit */
1469 rbuf[0] = tmp >> (8 * 3);
1470 rbuf[1] = tmp >> (8 * 2);
1471 rbuf[2] = tmp >> (8 * 1);
1472 rbuf[3] = tmp;
1473
1474 /* sector size */
1475 tmp = ATA_SECT_SIZE;
1476 rbuf[6] = tmp >> 8;
1477 rbuf[7] = tmp;
1478
1479 } else {
1480 /* sector count, 64-bit */
Philip Pokorny0c144d02005-05-28 01:24:47 -07001481 tmp = n_sectors >> (8 * 4);
1482 rbuf[2] = tmp >> (8 * 3);
1483 rbuf[3] = tmp >> (8 * 2);
1484 rbuf[4] = tmp >> (8 * 1);
1485 rbuf[5] = tmp;
1486 tmp = n_sectors;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001487 rbuf[6] = tmp >> (8 * 3);
1488 rbuf[7] = tmp >> (8 * 2);
1489 rbuf[8] = tmp >> (8 * 1);
1490 rbuf[9] = tmp;
1491
1492 /* sector size */
1493 tmp = ATA_SECT_SIZE;
1494 rbuf[12] = tmp >> 8;
1495 rbuf[13] = tmp;
1496 }
1497
1498 return 0;
1499}
1500
1501/**
1502 * ata_scsiop_report_luns - Simulate REPORT LUNS command
1503 * @args: device IDENTIFY data / SCSI command of interest.
1504 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1505 * @buflen: Response buffer length.
1506 *
1507 * Simulate REPORT LUNS command.
1508 *
1509 * LOCKING:
1510 * spin_lock_irqsave(host_set lock)
1511 */
1512
1513unsigned int ata_scsiop_report_luns(struct ata_scsi_args *args, u8 *rbuf,
1514 unsigned int buflen)
1515{
1516 VPRINTK("ENTER\n");
1517 rbuf[3] = 8; /* just one lun, LUN 0, size 8 bytes */
1518
1519 return 0;
1520}
1521
1522/**
Douglas Gilbert845c5832005-10-09 08:55:41 -04001523 * ata_scsi_set_sense - Set SCSI sense data and status
1524 * @cmd: SCSI request to be handled
1525 * @sk: SCSI-defined sense key
1526 * @asc: SCSI-defined additional sense code
1527 * @ascq: SCSI-defined additional sense code qualifier
1528 *
1529 * Helper function that builds a valid fixed format, current
1530 * response code and the given sense key (sk), additional sense
1531 * code (asc) and additional sense code qualifier (ascq) with
1532 * a SCSI command status of %SAM_STAT_CHECK_CONDITION and
1533 * DRIVER_SENSE set in the upper bits of scsi_cmnd::result .
1534 *
1535 * LOCKING:
1536 * Not required
1537 */
1538
1539void ata_scsi_set_sense(struct scsi_cmnd *cmd, u8 sk, u8 asc, u8 ascq)
1540{
1541 cmd->result = (DRIVER_SENSE << 24) | SAM_STAT_CHECK_CONDITION;
1542
1543 cmd->sense_buffer[0] = 0x70; /* fixed format, current */
1544 cmd->sense_buffer[2] = sk;
1545 cmd->sense_buffer[7] = 18 - 8; /* additional sense length */
1546 cmd->sense_buffer[12] = asc;
1547 cmd->sense_buffer[13] = ascq;
1548}
1549
1550/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07001551 * ata_scsi_badcmd - End a SCSI request with an error
1552 * @cmd: SCSI request to be handled
1553 * @done: SCSI command completion function
1554 * @asc: SCSI-defined additional sense code
1555 * @ascq: SCSI-defined additional sense code qualifier
1556 *
1557 * Helper function that completes a SCSI command with
1558 * %SAM_STAT_CHECK_CONDITION, with a sense key %ILLEGAL_REQUEST
1559 * and the specified additional sense codes.
1560 *
1561 * LOCKING:
1562 * spin_lock_irqsave(host_set lock)
1563 */
1564
1565void ata_scsi_badcmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *), u8 asc, u8 ascq)
1566{
1567 DPRINTK("ENTER\n");
Douglas Gilbertae006512005-10-09 09:09:35 -04001568 ata_scsi_set_sense(cmd, ILLEGAL_REQUEST, asc, ascq);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001569
1570 done(cmd);
1571}
1572
Jeff Garzika939c962005-10-05 17:09:16 -04001573void atapi_request_sense(struct ata_port *ap, struct ata_device *dev,
1574 struct scsi_cmnd *cmd)
1575{
1576 DECLARE_COMPLETION(wait);
1577 struct ata_queued_cmd *qc;
1578 unsigned long flags;
1579 int rc;
1580
1581 DPRINTK("ATAPI request sense\n");
1582
1583 qc = ata_qc_new_init(ap, dev);
1584 BUG_ON(qc == NULL);
1585
1586 /* FIXME: is this needed? */
1587 memset(cmd->sense_buffer, 0, sizeof(cmd->sense_buffer));
1588
1589 ata_sg_init_one(qc, cmd->sense_buffer, sizeof(cmd->sense_buffer));
1590 qc->dma_dir = DMA_FROM_DEVICE;
1591
1592 memset(&qc->cdb, 0, ap->cdb_len);
1593 qc->cdb[0] = REQUEST_SENSE;
1594 qc->cdb[4] = SCSI_SENSE_BUFFERSIZE;
1595
1596 qc->tf.flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
1597 qc->tf.command = ATA_CMD_PACKET;
1598
1599 qc->tf.protocol = ATA_PROT_ATAPI;
1600 qc->tf.lbam = (8 * 1024) & 0xff;
1601 qc->tf.lbah = (8 * 1024) >> 8;
1602 qc->nbytes = SCSI_SENSE_BUFFERSIZE;
1603
1604 qc->waiting = &wait;
1605 qc->complete_fn = ata_qc_complete_noop;
1606
1607 spin_lock_irqsave(&ap->host_set->lock, flags);
1608 rc = ata_qc_issue(qc);
1609 spin_unlock_irqrestore(&ap->host_set->lock, flags);
1610
1611 if (rc)
1612 ata_port_disable(ap);
1613 else
1614 wait_for_completion(&wait);
1615
1616 DPRINTK("EXIT\n");
1617}
1618
Linus Torvalds1da177e2005-04-16 15:20:36 -07001619static int atapi_qc_complete(struct ata_queued_cmd *qc, u8 drv_stat)
1620{
1621 struct scsi_cmnd *cmd = qc->scsicmd;
1622
Jeff Garzike12669e2005-10-05 18:39:23 -04001623 VPRINTK("ENTER, drv_stat == 0x%x\n", drv_stat);
1624
Jeff Garzika15dbeb2005-10-05 15:02:14 -04001625 if (unlikely(drv_stat & (ATA_BUSY | ATA_DRQ)))
1626 ata_to_sense_error(qc, drv_stat);
Jeff Garzike12669e2005-10-05 18:39:23 -04001627
Jeff Garzika15dbeb2005-10-05 15:02:14 -04001628 else if (unlikely(drv_stat & ATA_ERR)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001629 DPRINTK("request check condition\n");
1630
Jeff Garzika15dbeb2005-10-05 15:02:14 -04001631 /* FIXME: command completion with check condition
1632 * but no sense causes the error handler to run,
1633 * which then issues REQUEST SENSE, fills in the sense
1634 * buffer, and completes the command (for the second
1635 * time). We need to issue REQUEST SENSE some other
1636 * way, to avoid completing the command twice.
1637 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001638 cmd->result = SAM_STAT_CHECK_CONDITION;
1639
1640 qc->scsidone(cmd);
1641
1642 return 1;
Jeff Garzike12669e2005-10-05 18:39:23 -04001643 }
1644
1645 else {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001646 u8 *scsicmd = cmd->cmnd;
1647
1648 if (scsicmd[0] == INQUIRY) {
1649 u8 *buf = NULL;
1650 unsigned int buflen;
1651
1652 buflen = ata_scsi_rbuf_get(cmd, &buf);
Jeff Garzika15dbeb2005-10-05 15:02:14 -04001653
1654 /* ATAPI devices typically report zero for their SCSI version,
1655 * and sometimes deviate from the spec WRT response data
1656 * format. If SCSI version is reported as zero like normal,
1657 * then we make the following fixups: 1) Fake MMC-5 version,
1658 * to indicate to the Linux scsi midlayer this is a modern
1659 * device. 2) Ensure response data format / ATAPI information
1660 * are always correct.
1661 */
1662 /* FIXME: do we ever override EVPD pages and the like, with
1663 * this code?
1664 */
1665 if (buf[2] == 0) {
1666 buf[2] = 0x5;
1667 buf[3] = 0x32;
1668 }
1669
Linus Torvalds1da177e2005-04-16 15:20:36 -07001670 ata_scsi_rbuf_put(cmd, buf);
1671 }
Jeff Garzika15dbeb2005-10-05 15:02:14 -04001672
Linus Torvalds1da177e2005-04-16 15:20:36 -07001673 cmd->result = SAM_STAT_GOOD;
1674 }
1675
1676 qc->scsidone(cmd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001677 return 0;
1678}
1679/**
1680 * atapi_xlat - Initialize PACKET taskfile
1681 * @qc: command structure to be initialized
1682 * @scsicmd: SCSI CDB associated with this PACKET command
1683 *
1684 * LOCKING:
1685 * spin_lock_irqsave(host_set lock)
1686 *
1687 * RETURNS:
1688 * Zero on success, non-zero on failure.
1689 */
1690
1691static unsigned int atapi_xlat(struct ata_queued_cmd *qc, u8 *scsicmd)
1692{
1693 struct scsi_cmnd *cmd = qc->scsicmd;
1694 struct ata_device *dev = qc->dev;
1695 int using_pio = (dev->flags & ATA_DFLAG_PIO);
be7db052005-04-17 15:26:13 -05001696 int nodata = (cmd->sc_data_direction == DMA_NONE);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001697
1698 if (!using_pio)
1699 /* Check whether ATAPI DMA is safe */
1700 if (ata_check_atapi_dma(qc))
1701 using_pio = 1;
1702
1703 memcpy(&qc->cdb, scsicmd, qc->ap->cdb_len);
1704
1705 qc->complete_fn = atapi_qc_complete;
1706
1707 qc->tf.flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
be7db052005-04-17 15:26:13 -05001708 if (cmd->sc_data_direction == DMA_TO_DEVICE) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001709 qc->tf.flags |= ATA_TFLAG_WRITE;
1710 DPRINTK("direction: write\n");
1711 }
1712
1713 qc->tf.command = ATA_CMD_PACKET;
1714
1715 /* no data, or PIO data xfer */
1716 if (using_pio || nodata) {
1717 if (nodata)
1718 qc->tf.protocol = ATA_PROT_ATAPI_NODATA;
1719 else
1720 qc->tf.protocol = ATA_PROT_ATAPI;
1721 qc->tf.lbam = (8 * 1024) & 0xff;
1722 qc->tf.lbah = (8 * 1024) >> 8;
1723 }
1724
1725 /* DMA data xfer */
1726 else {
1727 qc->tf.protocol = ATA_PROT_ATAPI_DMA;
1728 qc->tf.feature |= ATAPI_PKT_DMA;
1729
1730#ifdef ATAPI_ENABLE_DMADIR
1731 /* some SATA bridges need us to indicate data xfer direction */
be7db052005-04-17 15:26:13 -05001732 if (cmd->sc_data_direction != DMA_TO_DEVICE)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001733 qc->tf.feature |= ATAPI_DMADIR;
1734#endif
1735 }
1736
1737 qc->nbytes = cmd->bufflen;
1738
1739 return 0;
1740}
1741
1742/**
1743 * ata_scsi_find_dev - lookup ata_device from scsi_cmnd
1744 * @ap: ATA port to which the device is attached
1745 * @scsidev: SCSI device from which we derive the ATA device
1746 *
1747 * Given various information provided in struct scsi_cmnd,
1748 * map that onto an ATA bus, and using that mapping
1749 * determine which ata_device is associated with the
1750 * SCSI command to be sent.
1751 *
1752 * LOCKING:
1753 * spin_lock_irqsave(host_set lock)
1754 *
1755 * RETURNS:
1756 * Associated ATA device, or %NULL if not found.
1757 */
1758
1759static struct ata_device *
1760ata_scsi_find_dev(struct ata_port *ap, struct scsi_device *scsidev)
1761{
1762 struct ata_device *dev;
1763
1764 /* skip commands not addressed to targets we simulate */
1765 if (likely(scsidev->id < ATA_MAX_DEVICES))
1766 dev = &ap->device[scsidev->id];
1767 else
1768 return NULL;
1769
1770 if (unlikely((scsidev->channel != 0) ||
1771 (scsidev->lun != 0)))
1772 return NULL;
1773
1774 if (unlikely(!ata_dev_present(dev)))
1775 return NULL;
1776
Jeff Garzik6f106232005-08-30 21:52:18 -04001777 if (!atapi_enabled) {
Jeff Garzik1623c812005-08-30 03:37:42 -04001778 if (unlikely(dev->class == ATA_DEV_ATAPI))
1779 return NULL;
1780 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001781
1782 return dev;
1783}
1784
1785/**
1786 * ata_get_xlat_func - check if SCSI to ATA translation is possible
1787 * @dev: ATA device
1788 * @cmd: SCSI command opcode to consider
1789 *
1790 * Look up the SCSI command given, and determine whether the
1791 * SCSI command is to be translated or simulated.
1792 *
1793 * RETURNS:
1794 * Pointer to translation function if possible, %NULL if not.
1795 */
1796
1797static inline ata_xlat_func_t ata_get_xlat_func(struct ata_device *dev, u8 cmd)
1798{
1799 switch (cmd) {
1800 case READ_6:
1801 case READ_10:
1802 case READ_16:
1803
1804 case WRITE_6:
1805 case WRITE_10:
1806 case WRITE_16:
1807 return ata_scsi_rw_xlat;
1808
1809 case SYNCHRONIZE_CACHE:
1810 if (ata_try_flush_cache(dev))
1811 return ata_scsi_flush_xlat;
1812 break;
1813
1814 case VERIFY:
1815 case VERIFY_16:
1816 return ata_scsi_verify_xlat;
Douglas Gilbert972dcaf2005-08-11 03:35:53 -04001817 case START_STOP:
1818 return ata_scsi_start_stop_xlat;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001819 }
1820
1821 return NULL;
1822}
1823
1824/**
1825 * ata_scsi_dump_cdb - dump SCSI command contents to dmesg
1826 * @ap: ATA port to which the command was being sent
1827 * @cmd: SCSI command to dump
1828 *
1829 * Prints the contents of a SCSI command via printk().
1830 */
1831
1832static inline void ata_scsi_dump_cdb(struct ata_port *ap,
1833 struct scsi_cmnd *cmd)
1834{
1835#ifdef ATA_DEBUG
1836 struct scsi_device *scsidev = cmd->device;
1837 u8 *scsicmd = cmd->cmnd;
1838
1839 DPRINTK("CDB (%u:%d,%d,%d) %02x %02x %02x %02x %02x %02x %02x %02x %02x\n",
1840 ap->id,
1841 scsidev->channel, scsidev->id, scsidev->lun,
1842 scsicmd[0], scsicmd[1], scsicmd[2], scsicmd[3],
1843 scsicmd[4], scsicmd[5], scsicmd[6], scsicmd[7],
1844 scsicmd[8]);
1845#endif
1846}
1847
1848/**
1849 * ata_scsi_queuecmd - Issue SCSI cdb to libata-managed device
1850 * @cmd: SCSI command to be sent
1851 * @done: Completion function, called when command is complete
1852 *
1853 * In some cases, this function translates SCSI commands into
1854 * ATA taskfiles, and queues the taskfiles to be sent to
1855 * hardware. In other cases, this function simulates a
1856 * SCSI device by evaluating and responding to certain
1857 * SCSI commands. This creates the overall effect of
1858 * ATA and ATAPI devices appearing as SCSI devices.
1859 *
1860 * LOCKING:
1861 * Releases scsi-layer-held lock, and obtains host_set lock.
1862 *
1863 * RETURNS:
1864 * Zero.
1865 */
1866
1867int ata_scsi_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *))
1868{
1869 struct ata_port *ap;
1870 struct ata_device *dev;
1871 struct scsi_device *scsidev = cmd->device;
1872
1873 ap = (struct ata_port *) &scsidev->host->hostdata[0];
1874
1875 ata_scsi_dump_cdb(ap, cmd);
1876
1877 dev = ata_scsi_find_dev(ap, scsidev);
1878 if (unlikely(!dev)) {
1879 cmd->result = (DID_BAD_TARGET << 16);
1880 done(cmd);
1881 goto out_unlock;
1882 }
1883
1884 if (dev->class == ATA_DEV_ATA) {
1885 ata_xlat_func_t xlat_func = ata_get_xlat_func(dev,
1886 cmd->cmnd[0]);
1887
1888 if (xlat_func)
1889 ata_scsi_translate(ap, dev, cmd, done, xlat_func);
1890 else
1891 ata_scsi_simulate(dev->id, cmd, done);
1892 } else
1893 ata_scsi_translate(ap, dev, cmd, done, atapi_xlat);
1894
1895out_unlock:
1896 return 0;
1897}
1898
1899/**
1900 * ata_scsi_simulate - simulate SCSI command on ATA device
1901 * @id: current IDENTIFY data for target device.
1902 * @cmd: SCSI command being sent to device.
1903 * @done: SCSI command completion function.
1904 *
1905 * Interprets and directly executes a select list of SCSI commands
1906 * that can be handled internally.
1907 *
1908 * LOCKING:
1909 * spin_lock_irqsave(host_set lock)
1910 */
1911
1912void ata_scsi_simulate(u16 *id,
1913 struct scsi_cmnd *cmd,
1914 void (*done)(struct scsi_cmnd *))
1915{
1916 struct ata_scsi_args args;
1917 u8 *scsicmd = cmd->cmnd;
1918
1919 args.id = id;
1920 args.cmd = cmd;
1921 args.done = done;
1922
1923 switch(scsicmd[0]) {
1924 /* no-op's, complete with success */
1925 case SYNCHRONIZE_CACHE:
1926 case REZERO_UNIT:
1927 case SEEK_6:
1928 case SEEK_10:
1929 case TEST_UNIT_READY:
1930 case FORMAT_UNIT: /* FIXME: correct? */
1931 case SEND_DIAGNOSTIC: /* FIXME: correct? */
1932 ata_scsi_rbuf_fill(&args, ata_scsiop_noop);
1933 break;
1934
1935 case INQUIRY:
1936 if (scsicmd[1] & 2) /* is CmdDt set? */
Douglas Gilbertae006512005-10-09 09:09:35 -04001937 ata_scsi_invalid_field(cmd, done);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001938 else if ((scsicmd[1] & 1) == 0) /* is EVPD clear? */
1939 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_std);
1940 else if (scsicmd[2] == 0x00)
1941 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_00);
1942 else if (scsicmd[2] == 0x80)
1943 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_80);
1944 else if (scsicmd[2] == 0x83)
1945 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_83);
1946 else
Douglas Gilbertae006512005-10-09 09:09:35 -04001947 ata_scsi_invalid_field(cmd, done);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001948 break;
1949
1950 case MODE_SENSE:
1951 case MODE_SENSE_10:
1952 ata_scsi_rbuf_fill(&args, ata_scsiop_mode_sense);
1953 break;
1954
1955 case MODE_SELECT: /* unconditionally return */
1956 case MODE_SELECT_10: /* bad-field-in-cdb */
Douglas Gilbertae006512005-10-09 09:09:35 -04001957 ata_scsi_invalid_field(cmd, done);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001958 break;
1959
1960 case READ_CAPACITY:
1961 ata_scsi_rbuf_fill(&args, ata_scsiop_read_cap);
1962 break;
1963
1964 case SERVICE_ACTION_IN:
1965 if ((scsicmd[1] & 0x1f) == SAI_READ_CAPACITY_16)
1966 ata_scsi_rbuf_fill(&args, ata_scsiop_read_cap);
1967 else
Douglas Gilbertae006512005-10-09 09:09:35 -04001968 ata_scsi_invalid_field(cmd, done);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001969 break;
1970
1971 case REPORT_LUNS:
1972 ata_scsi_rbuf_fill(&args, ata_scsiop_report_luns);
1973 break;
1974
1975 /* mandantory commands we haven't implemented yet */
1976 case REQUEST_SENSE:
1977
1978 /* all other commands */
1979 default:
Douglas Gilbertae006512005-10-09 09:09:35 -04001980 ata_scsi_set_sense(cmd, ILLEGAL_REQUEST, 0x20, 0x0);
1981 /* "Invalid command operation code" */
1982 done(cmd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001983 break;
1984 }
1985}
1986
Jeff Garzik644dd0c2005-10-03 15:55:19 -04001987void ata_scsi_scan_host(struct ata_port *ap)
1988{
Jeff Garzik3f19ee82005-10-03 21:36:41 -04001989 struct ata_device *dev;
Jeff Garzik644dd0c2005-10-03 15:55:19 -04001990 unsigned int i;
1991
1992 if (ap->flags & ATA_FLAG_PORT_DISABLED)
1993 return;
1994
Jeff Garzik3f19ee82005-10-03 21:36:41 -04001995 for (i = 0; i < ATA_MAX_DEVICES; i++) {
1996 dev = &ap->device[i];
1997
1998 if (ata_dev_present(dev))
1999 scsi_scan_target(&ap->host->shost_gendev, 0, i, 0, 0);
2000 }
Jeff Garzik644dd0c2005-10-03 15:55:19 -04002001}
2002