blob: 3aaa74cbef1d2b0b14acdcb363eb8e140298040a [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>
Linus Torvalds1da177e2005-04-16 15:20:36 -070040#include <scsi/scsi_host.h>
Mike Christie85837eb2005-11-11 16:38:53 -060041#include <scsi/scsi_eh.h>
Jeff Garzik005a5a02005-10-30 23:31:48 -050042#include <scsi/scsi_device.h>
Jeff Garzik193515d2005-11-07 00:59:37 -050043#include <scsi/scsi_request.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070044#include <linux/libata.h>
Jeff Garzikb0955182005-05-12 15:45:22 -040045#include <linux/hdreg.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070046#include <asm/uaccess.h>
47
48#include "libata.h"
49
Jeff Garzikb0955182005-05-12 15:45:22 -040050#define SECTOR_SIZE 512
51
Jeff Garzik057ace52005-10-22 14:27:05 -040052typedef unsigned int (*ata_xlat_func_t)(struct ata_queued_cmd *qc, const u8 *scsicmd);
Linus Torvalds1da177e2005-04-16 15:20:36 -070053static struct ata_device *
Jeff Garzik057ace52005-10-22 14:27:05 -040054ata_scsi_find_dev(struct ata_port *ap, const struct scsi_device *scsidev);
Linus Torvalds1da177e2005-04-16 15:20:36 -070055
Douglas Gilbert00ac37f2005-10-28 15:58:28 -040056#define RW_RECOVERY_MPAGE 0x1
57#define RW_RECOVERY_MPAGE_LEN 12
58#define CACHE_MPAGE 0x8
59#define CACHE_MPAGE_LEN 20
60#define CONTROL_MPAGE 0xa
61#define CONTROL_MPAGE_LEN 12
62#define ALL_MPAGES 0x3f
63#define ALL_SUB_MPAGES 0xff
64
65
66static const u8 def_rw_recovery_mpage[] = {
67 RW_RECOVERY_MPAGE,
68 RW_RECOVERY_MPAGE_LEN - 2,
69 (1 << 7) | /* AWRE, sat-r06 say it shall be 0 */
70 (1 << 6), /* ARRE (auto read reallocation) */
71 0, /* read retry count */
72 0, 0, 0, 0,
73 0, /* write retry count */
74 0, 0, 0
75};
76
77static const u8 def_cache_mpage[CACHE_MPAGE_LEN] = {
78 CACHE_MPAGE,
79 CACHE_MPAGE_LEN - 2,
80 0, /* contains WCE, needs to be 0 for logic */
81 0, 0, 0, 0, 0, 0, 0, 0, 0,
82 0, /* contains DRA, needs to be 0 for logic */
83 0, 0, 0, 0, 0, 0, 0
84};
85
86static const u8 def_control_mpage[CONTROL_MPAGE_LEN] = {
87 CONTROL_MPAGE,
88 CONTROL_MPAGE_LEN - 2,
89 2, /* DSENSE=0, GLTSD=1 */
90 0, /* [QAM+QERR may be 1, see 05-359r1] */
91 0, 0, 0, 0, 0xff, 0xff,
92 0, 30 /* extended self test time, see 05-359r1 */
93};
94
Linus Torvalds1da177e2005-04-16 15:20:36 -070095
Douglas Gilbertae006512005-10-09 09:09:35 -040096static void ata_scsi_invalid_field(struct scsi_cmnd *cmd,
97 void (*done)(struct scsi_cmnd *))
98{
99 ata_scsi_set_sense(cmd, ILLEGAL_REQUEST, 0x24, 0x0);
100 /* "Invalid field in cbd" */
101 done(cmd);
102}
103
Linus Torvalds1da177e2005-04-16 15:20:36 -0700104/**
105 * ata_std_bios_param - generic bios head/sector/cylinder calculator used by sd.
106 * @sdev: SCSI device for which BIOS geometry is to be determined
107 * @bdev: block device associated with @sdev
108 * @capacity: capacity of SCSI device
109 * @geom: location to which geometry will be output
110 *
111 * Generic bios head/sector/cylinder calculator
112 * used by sd. Most BIOSes nowadays expect a XXX/255/16 (CHS)
113 * mapping. Some situations may arise where the disk is not
114 * bootable if this is not used.
115 *
116 * LOCKING:
117 * Defined by the SCSI layer. We don't really care.
118 *
119 * RETURNS:
120 * Zero.
121 */
122int ata_std_bios_param(struct scsi_device *sdev, struct block_device *bdev,
123 sector_t capacity, int geom[])
124{
125 geom[0] = 255;
126 geom[1] = 63;
127 sector_div(capacity, 255*63);
128 geom[2] = capacity;
129
130 return 0;
131}
132
Jeff Garzikb0955182005-05-12 15:45:22 -0400133/**
134 * ata_cmd_ioctl - Handler for HDIO_DRIVE_CMD ioctl
Randy Dunlap8e8b77d2005-11-01 21:29:27 -0800135 * @scsidev: Device to which we are issuing command
Jeff Garzikb0955182005-05-12 15:45:22 -0400136 * @arg: User provided data for issuing command
137 *
138 * LOCKING:
139 * Defined by the SCSI layer. We don't really care.
140 *
141 * RETURNS:
142 * Zero on success, negative errno on error.
143 */
144
145int ata_cmd_ioctl(struct scsi_device *scsidev, void __user *arg)
146{
147 int rc = 0;
148 u8 scsi_cmd[MAX_COMMAND_SIZE];
149 u8 args[4], *argbuf = NULL;
150 int argsize = 0;
Mike Christie85837eb2005-11-11 16:38:53 -0600151 struct scsi_sense_hdr sshdr;
152 enum dma_data_direction data_dir;
Jeff Garzikb0955182005-05-12 15:45:22 -0400153
Randy Dunlapc893a3a2006-01-28 13:15:32 -0500154 if (arg == NULL)
Jeff Garzikb0955182005-05-12 15:45:22 -0400155 return -EINVAL;
156
157 if (copy_from_user(args, arg, sizeof(args)))
158 return -EFAULT;
159
Jeff Garzikb0955182005-05-12 15:45:22 -0400160 memset(scsi_cmd, 0, sizeof(scsi_cmd));
161
162 if (args[3]) {
163 argsize = SECTOR_SIZE * args[3];
164 argbuf = kmalloc(argsize, GFP_KERNEL);
Jeff Raubitschek54dac832005-10-04 10:21:19 -0400165 if (argbuf == NULL) {
166 rc = -ENOMEM;
167 goto error;
168 }
Jeff Garzikb0955182005-05-12 15:45:22 -0400169
170 scsi_cmd[1] = (4 << 1); /* PIO Data-in */
171 scsi_cmd[2] = 0x0e; /* no off.line or cc, read from dev,
172 block count in sector count field */
Mike Christie85837eb2005-11-11 16:38:53 -0600173 data_dir = DMA_FROM_DEVICE;
Jeff Garzikb0955182005-05-12 15:45:22 -0400174 } else {
175 scsi_cmd[1] = (3 << 1); /* Non-data */
176 /* scsi_cmd[2] is already 0 -- no off.line, cc, or data xfer */
Mike Christie85837eb2005-11-11 16:38:53 -0600177 data_dir = DMA_NONE;
Jeff Garzikb0955182005-05-12 15:45:22 -0400178 }
179
180 scsi_cmd[0] = ATA_16;
181
182 scsi_cmd[4] = args[2];
183 if (args[0] == WIN_SMART) { /* hack -- ide driver does this too... */
184 scsi_cmd[6] = args[3];
185 scsi_cmd[8] = args[1];
186 scsi_cmd[10] = 0x4f;
187 scsi_cmd[12] = 0xc2;
188 } else {
189 scsi_cmd[6] = args[1];
190 }
191 scsi_cmd[14] = args[0];
192
193 /* Good values for timeout and retries? Values below
194 from scsi_ioctl_send_command() for default case... */
Mike Christie85837eb2005-11-11 16:38:53 -0600195 if (scsi_execute_req(scsidev, scsi_cmd, data_dir, argbuf, argsize,
196 &sshdr, (10*HZ), 5)) {
Jeff Garzikb0955182005-05-12 15:45:22 -0400197 rc = -EIO;
198 goto error;
199 }
200
201 /* Need code to retrieve data from check condition? */
202
203 if ((argbuf)
Randy Dunlapc893a3a2006-01-28 13:15:32 -0500204 && copy_to_user(arg + sizeof(args), argbuf, argsize))
Jeff Garzikb0955182005-05-12 15:45:22 -0400205 rc = -EFAULT;
206error:
Jeff Garzikb0955182005-05-12 15:45:22 -0400207 if (argbuf)
208 kfree(argbuf);
209
210 return rc;
211}
212
213/**
214 * ata_task_ioctl - Handler for HDIO_DRIVE_TASK ioctl
Randy Dunlap8e8b77d2005-11-01 21:29:27 -0800215 * @scsidev: Device to which we are issuing command
Jeff Garzikb0955182005-05-12 15:45:22 -0400216 * @arg: User provided data for issuing command
217 *
218 * LOCKING:
219 * Defined by the SCSI layer. We don't really care.
220 *
221 * RETURNS:
222 * Zero on success, negative errno on error.
223 */
224int ata_task_ioctl(struct scsi_device *scsidev, void __user *arg)
225{
226 int rc = 0;
227 u8 scsi_cmd[MAX_COMMAND_SIZE];
228 u8 args[7];
Mike Christie85837eb2005-11-11 16:38:53 -0600229 struct scsi_sense_hdr sshdr;
Jeff Garzikb0955182005-05-12 15:45:22 -0400230
Randy Dunlapc893a3a2006-01-28 13:15:32 -0500231 if (arg == NULL)
Jeff Garzikb0955182005-05-12 15:45:22 -0400232 return -EINVAL;
233
234 if (copy_from_user(args, arg, sizeof(args)))
235 return -EFAULT;
236
237 memset(scsi_cmd, 0, sizeof(scsi_cmd));
238 scsi_cmd[0] = ATA_16;
239 scsi_cmd[1] = (3 << 1); /* Non-data */
240 /* scsi_cmd[2] is already 0 -- no off.line, cc, or data xfer */
241 scsi_cmd[4] = args[1];
242 scsi_cmd[6] = args[2];
243 scsi_cmd[8] = args[3];
244 scsi_cmd[10] = args[4];
245 scsi_cmd[12] = args[5];
246 scsi_cmd[14] = args[0];
247
Jeff Garzikb0955182005-05-12 15:45:22 -0400248 /* Good values for timeout and retries? Values below
Mike Christie85837eb2005-11-11 16:38:53 -0600249 from scsi_ioctl_send_command() for default case... */
250 if (scsi_execute_req(scsidev, scsi_cmd, DMA_NONE, NULL, 0, &sshdr,
251 (10*HZ), 5))
Jeff Garzikb0955182005-05-12 15:45:22 -0400252 rc = -EIO;
Jeff Garzikb0955182005-05-12 15:45:22 -0400253
254 /* Need code to retrieve data from check condition? */
Jeff Garzikb0955182005-05-12 15:45:22 -0400255 return rc;
256}
257
Linus Torvalds1da177e2005-04-16 15:20:36 -0700258int ata_scsi_ioctl(struct scsi_device *scsidev, int cmd, void __user *arg)
259{
260 struct ata_port *ap;
261 struct ata_device *dev;
262 int val = -EINVAL, rc = -EINVAL;
263
264 ap = (struct ata_port *) &scsidev->host->hostdata[0];
265 if (!ap)
266 goto out;
267
268 dev = ata_scsi_find_dev(ap, scsidev);
269 if (!dev) {
270 rc = -ENODEV;
271 goto out;
272 }
273
274 switch (cmd) {
275 case ATA_IOC_GET_IO32:
276 val = 0;
277 if (copy_to_user(arg, &val, 1))
278 return -EFAULT;
279 return 0;
280
281 case ATA_IOC_SET_IO32:
282 val = (unsigned long) arg;
283 if (val != 0)
284 return -EINVAL;
285 return 0;
286
Jeff Garzikb0955182005-05-12 15:45:22 -0400287 case HDIO_DRIVE_CMD:
288 if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
289 return -EACCES;
290 return ata_cmd_ioctl(scsidev, arg);
291
292 case HDIO_DRIVE_TASK:
293 if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
294 return -EACCES;
295 return ata_task_ioctl(scsidev, arg);
296
Linus Torvalds1da177e2005-04-16 15:20:36 -0700297 default:
298 rc = -ENOTTY;
299 break;
300 }
301
302out:
303 return rc;
304}
305
306/**
307 * ata_scsi_qc_new - acquire new ata_queued_cmd reference
308 * @ap: ATA port to which the new command is attached
309 * @dev: ATA device to which the new command is attached
310 * @cmd: SCSI command that originated this ATA command
311 * @done: SCSI command completion function
312 *
313 * Obtain a reference to an unused ata_queued_cmd structure,
314 * which is the basic libata structure representing a single
315 * ATA command sent to the hardware.
316 *
317 * If a command was available, fill in the SCSI-specific
318 * portions of the structure with information on the
319 * current command.
320 *
321 * LOCKING:
322 * spin_lock_irqsave(host_set lock)
323 *
324 * RETURNS:
325 * Command allocated, or %NULL if none available.
326 */
327struct ata_queued_cmd *ata_scsi_qc_new(struct ata_port *ap,
328 struct ata_device *dev,
329 struct scsi_cmnd *cmd,
330 void (*done)(struct scsi_cmnd *))
331{
332 struct ata_queued_cmd *qc;
333
334 qc = ata_qc_new_init(ap, dev);
335 if (qc) {
336 qc->scsicmd = cmd;
337 qc->scsidone = done;
338
339 if (cmd->use_sg) {
Jeff Garzikcedc9a42005-10-05 07:13:30 -0400340 qc->__sg = (struct scatterlist *) cmd->request_buffer;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700341 qc->n_elem = cmd->use_sg;
342 } else {
Jeff Garzikcedc9a42005-10-05 07:13:30 -0400343 qc->__sg = &qc->sgent;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700344 qc->n_elem = 1;
345 }
346 } else {
347 cmd->result = (DID_OK << 16) | (QUEUE_FULL << 1);
348 done(cmd);
349 }
350
351 return qc;
352}
353
354/**
Jeff Garzikb0955182005-05-12 15:45:22 -0400355 * ata_dump_status - user friendly display of error info
356 * @id: id of the port in question
357 * @tf: ptr to filled out taskfile
Linus Torvalds1da177e2005-04-16 15:20:36 -0700358 *
Jeff Garzikb0955182005-05-12 15:45:22 -0400359 * Decode and dump the ATA error/status registers for the user so
360 * that they have some idea what really happened at the non
361 * make-believe layer.
362 *
363 * LOCKING:
364 * inherited from caller
365 */
366void ata_dump_status(unsigned id, struct ata_taskfile *tf)
367{
368 u8 stat = tf->command, err = tf->feature;
369
370 printk(KERN_WARNING "ata%u: status=0x%02x { ", id, stat);
371 if (stat & ATA_BUSY) {
372 printk("Busy }\n"); /* Data is not valid in this case */
373 } else {
374 if (stat & 0x40) printk("DriveReady ");
375 if (stat & 0x20) printk("DeviceFault ");
376 if (stat & 0x10) printk("SeekComplete ");
377 if (stat & 0x08) printk("DataRequest ");
378 if (stat & 0x04) printk("CorrectedError ");
379 if (stat & 0x02) printk("Index ");
380 if (stat & 0x01) printk("Error ");
381 printk("}\n");
382
383 if (err) {
384 printk(KERN_WARNING "ata%u: error=0x%02x { ", id, err);
385 if (err & 0x04) printk("DriveStatusError ");
386 if (err & 0x80) {
387 if (err & 0x04) printk("BadCRC ");
388 else printk("Sector ");
389 }
390 if (err & 0x40) printk("UncorrectableError ");
391 if (err & 0x10) printk("SectorIdNotFound ");
392 if (err & 0x02) printk("TrackZeroNotFound ");
393 if (err & 0x01) printk("AddrMarkNotFound ");
394 printk("}\n");
395 }
396 }
397}
398
Jens Axboe9b847542006-01-06 09:28:07 +0100399int ata_scsi_device_resume(struct scsi_device *sdev)
400{
401 struct ata_port *ap = (struct ata_port *) &sdev->host->hostdata[0];
402 struct ata_device *dev = &ap->device[sdev->id];
403
404 return ata_device_resume(ap, dev);
405}
406
407int ata_scsi_device_suspend(struct scsi_device *sdev)
408{
409 struct ata_port *ap = (struct ata_port *) &sdev->host->hostdata[0];
410 struct ata_device *dev = &ap->device[sdev->id];
411
412 return ata_device_suspend(ap, dev);
413}
414
Jeff Garzikb0955182005-05-12 15:45:22 -0400415/**
416 * ata_to_sense_error - convert ATA error to SCSI error
Randy Dunlap8e8b77d2005-11-01 21:29:27 -0800417 * @id: ATA device number
Jeff Garzikb0955182005-05-12 15:45:22 -0400418 * @drv_stat: value contained in ATA status register
419 * @drv_err: value contained in ATA error register
420 * @sk: the sense key we'll fill out
421 * @asc: the additional sense code we'll fill out
422 * @ascq: the additional sense code qualifier we'll fill out
423 *
424 * Converts an ATA error into a SCSI error. Fill out pointers to
425 * SK, ASC, and ASCQ bytes for later use in fixed or descriptor
426 * format sense blocks.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700427 *
428 * LOCKING:
429 * spin_lock_irqsave(host_set lock)
430 */
Jeff Garzikb0955182005-05-12 15:45:22 -0400431void ata_to_sense_error(unsigned id, u8 drv_stat, u8 drv_err, u8 *sk, u8 *asc,
432 u8 *ascq)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700433{
Jeff Garzikb0955182005-05-12 15:45:22 -0400434 int i;
Jeff Garzikffe75ef2005-10-09 10:40:44 -0400435
Linus Torvalds1da177e2005-04-16 15:20:36 -0700436 /* Based on the 3ware driver translation table */
Arjan van de Ven98ac62d2005-11-28 10:06:23 +0100437 static const unsigned char sense_table[][4] = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700438 /* BBD|ECC|ID|MAR */
439 {0xd1, ABORTED_COMMAND, 0x00, 0x00}, // Device busy Aborted command
440 /* BBD|ECC|ID */
441 {0xd0, ABORTED_COMMAND, 0x00, 0x00}, // Device busy Aborted command
442 /* ECC|MC|MARK */
443 {0x61, HARDWARE_ERROR, 0x00, 0x00}, // Device fault Hardware error
444 /* ICRC|ABRT */ /* NB: ICRC & !ABRT is BBD */
445 {0x84, ABORTED_COMMAND, 0x47, 0x00}, // Data CRC error SCSI parity error
446 /* MC|ID|ABRT|TRK0|MARK */
447 {0x37, NOT_READY, 0x04, 0x00}, // Unit offline Not ready
448 /* MCR|MARK */
449 {0x09, NOT_READY, 0x04, 0x00}, // Unrecovered disk error Not ready
450 /* Bad address mark */
451 {0x01, MEDIUM_ERROR, 0x13, 0x00}, // Address mark not found Address mark not found for data field
452 /* TRK0 */
453 {0x02, HARDWARE_ERROR, 0x00, 0x00}, // Track 0 not found Hardware error
454 /* Abort & !ICRC */
455 {0x04, ABORTED_COMMAND, 0x00, 0x00}, // Aborted command Aborted command
456 /* Media change request */
457 {0x08, NOT_READY, 0x04, 0x00}, // Media change request FIXME: faking offline
458 /* SRV */
459 {0x10, ABORTED_COMMAND, 0x14, 0x00}, // ID not found Recorded entity not found
460 /* Media change */
461 {0x08, NOT_READY, 0x04, 0x00}, // Media change FIXME: faking offline
462 /* ECC */
463 {0x40, MEDIUM_ERROR, 0x11, 0x04}, // Uncorrectable ECC error Unrecovered read error
464 /* BBD - block marked bad */
465 {0x80, MEDIUM_ERROR, 0x11, 0x04}, // Block marked bad Medium error, unrecovered read error
466 {0xFF, 0xFF, 0xFF, 0xFF}, // END mark
467 };
Arjan van de Ven98ac62d2005-11-28 10:06:23 +0100468 static const unsigned char stat_table[][4] = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700469 /* Must be first because BUSY means no other bits valid */
470 {0x80, ABORTED_COMMAND, 0x47, 0x00}, // Busy, fake parity for now
471 {0x20, HARDWARE_ERROR, 0x00, 0x00}, // Device fault
472 {0x08, ABORTED_COMMAND, 0x47, 0x00}, // Timed out in xfer, fake parity for now
473 {0x04, RECOVERED_ERROR, 0x11, 0x00}, // Recovered ECC error Medium error, recovered
474 {0xFF, 0xFF, 0xFF, 0xFF}, // END mark
475 };
Linus Torvalds1da177e2005-04-16 15:20:36 -0700476
Linus Torvalds1da177e2005-04-16 15:20:36 -0700477 /*
478 * Is this an error we can process/parse
479 */
Jeff Garzikb0955182005-05-12 15:45:22 -0400480 if (drv_stat & ATA_BUSY) {
481 drv_err = 0; /* Ignore the err bits, they're invalid */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700482 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700483
Jeff Garzikb0955182005-05-12 15:45:22 -0400484 if (drv_err) {
485 /* Look for drv_err */
486 for (i = 0; sense_table[i][0] != 0xFF; i++) {
487 /* Look for best matches first */
488 if ((sense_table[i][0] & drv_err) ==
489 sense_table[i][0]) {
490 *sk = sense_table[i][1];
491 *asc = sense_table[i][2];
492 *ascq = sense_table[i][3];
493 goto translate_done;
494 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700495 }
Jeff Garzikb0955182005-05-12 15:45:22 -0400496 /* No immediate match */
497 printk(KERN_WARNING "ata%u: no sense translation for "
498 "error 0x%02x\n", id, drv_err);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700499 }
500
Linus Torvalds1da177e2005-04-16 15:20:36 -0700501 /* Fall back to interpreting status bits */
Jeff Garzikb0955182005-05-12 15:45:22 -0400502 for (i = 0; stat_table[i][0] != 0xFF; i++) {
503 if (stat_table[i][0] & drv_stat) {
504 *sk = stat_table[i][1];
505 *asc = stat_table[i][2];
506 *ascq = stat_table[i][3];
507 goto translate_done;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700508 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700509 }
Jeff Garzikb0955182005-05-12 15:45:22 -0400510 /* No error? Undecoded? */
511 printk(KERN_WARNING "ata%u: no sense translation for status: 0x%02x\n",
512 id, drv_stat);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700513
Jeff Garzikb0955182005-05-12 15:45:22 -0400514 /* For our last chance pick, use medium read error because
515 * it's much more common than an ATA drive telling you a write
516 * has failed.
517 */
518 *sk = MEDIUM_ERROR;
519 *asc = 0x11; /* "unrecovered read error" */
520 *ascq = 0x04; /* "auto-reallocation failed" */
521
522 translate_done:
523 printk(KERN_ERR "ata%u: translated ATA stat/err 0x%02x/%02x to "
524 "SCSI SK/ASC/ASCQ 0x%x/%02x/%02x\n", id, drv_stat, drv_err,
525 *sk, *asc, *ascq);
526 return;
527}
528
529/*
530 * ata_gen_ata_desc_sense - Generate check condition sense block.
531 * @qc: Command that completed.
532 *
533 * This function is specific to the ATA descriptor format sense
534 * block specified for the ATA pass through commands. Regardless
535 * of whether the command errored or not, return a sense
536 * block. Copy all controller registers into the sense
537 * block. Clear sense key, ASC & ASCQ if there is no error.
538 *
539 * LOCKING:
540 * spin_lock_irqsave(host_set lock)
541 */
542void ata_gen_ata_desc_sense(struct ata_queued_cmd *qc)
543{
544 struct scsi_cmnd *cmd = qc->scsicmd;
545 struct ata_taskfile *tf = &qc->tf;
546 unsigned char *sb = cmd->sense_buffer;
547 unsigned char *desc = sb + 8;
548
549 memset(sb, 0, SCSI_SENSE_BUFFERSIZE);
550
Jeff Garzik0e5dec42005-10-06 09:40:20 -0400551 cmd->result = (DRIVER_SENSE << 24) | SAM_STAT_CHECK_CONDITION;
Jeff Garzikb0955182005-05-12 15:45:22 -0400552
553 /*
554 * Read the controller registers.
555 */
Tejun Heoa46314742006-02-11 19:11:13 +0900556 WARN_ON(qc->ap->ops->tf_read == NULL);
Jeff Garzikb0955182005-05-12 15:45:22 -0400557 qc->ap->ops->tf_read(qc->ap, tf);
558
559 /*
560 * Use ata_to_sense_error() to map status register bits
561 * onto sense key, asc & ascq.
562 */
Jeff Garzika7dac442005-10-30 04:44:42 -0500563 if (tf->command & (ATA_BUSY | ATA_DF | ATA_ERR | ATA_DRQ)) {
Jeff Garzikb0955182005-05-12 15:45:22 -0400564 ata_to_sense_error(qc->ap->id, tf->command, tf->feature,
565 &sb[1], &sb[2], &sb[3]);
566 sb[1] &= 0x0f;
567 }
568
569 /*
570 * Sense data is current and format is descriptor.
571 */
572 sb[0] = 0x72;
573
574 desc[0] = 0x09;
575
576 /*
577 * Set length of additional sense data.
578 * Since we only populate descriptor 0, the total
579 * length is the same (fixed) length as descriptor 0.
580 */
581 desc[1] = sb[7] = 14;
582
583 /*
584 * Copy registers into sense buffer.
585 */
586 desc[2] = 0x00;
587 desc[3] = tf->feature; /* == error reg */
588 desc[5] = tf->nsect;
589 desc[7] = tf->lbal;
590 desc[9] = tf->lbam;
591 desc[11] = tf->lbah;
592 desc[12] = tf->device;
593 desc[13] = tf->command; /* == status reg */
594
595 /*
596 * Fill in Extend bit, and the high order bytes
597 * if applicable.
598 */
599 if (tf->flags & ATA_TFLAG_LBA48) {
600 desc[2] |= 0x01;
601 desc[4] = tf->hob_nsect;
602 desc[6] = tf->hob_lbal;
603 desc[8] = tf->hob_lbam;
604 desc[10] = tf->hob_lbah;
605 }
606}
607
608/**
609 * ata_gen_fixed_sense - generate a SCSI fixed sense block
610 * @qc: Command that we are erroring out
611 *
612 * Leverage ata_to_sense_error() to give us the codes. Fit our
613 * LBA in here if there's room.
614 *
615 * LOCKING:
616 * inherited from caller
617 */
618void ata_gen_fixed_sense(struct ata_queued_cmd *qc)
619{
620 struct scsi_cmnd *cmd = qc->scsicmd;
621 struct ata_taskfile *tf = &qc->tf;
622 unsigned char *sb = cmd->sense_buffer;
623
624 memset(sb, 0, SCSI_SENSE_BUFFERSIZE);
625
Jeff Garzik0e5dec42005-10-06 09:40:20 -0400626 cmd->result = (DRIVER_SENSE << 24) | SAM_STAT_CHECK_CONDITION;
Jeff Garzikb0955182005-05-12 15:45:22 -0400627
628 /*
629 * Read the controller registers.
630 */
Tejun Heoa46314742006-02-11 19:11:13 +0900631 WARN_ON(qc->ap->ops->tf_read == NULL);
Jeff Garzikb0955182005-05-12 15:45:22 -0400632 qc->ap->ops->tf_read(qc->ap, tf);
633
634 /*
635 * Use ata_to_sense_error() to map status register bits
636 * onto sense key, asc & ascq.
637 */
Jeff Garzika7dac442005-10-30 04:44:42 -0500638 if (tf->command & (ATA_BUSY | ATA_DF | ATA_ERR | ATA_DRQ)) {
Jeff Garzikb0955182005-05-12 15:45:22 -0400639 ata_to_sense_error(qc->ap->id, tf->command, tf->feature,
640 &sb[2], &sb[12], &sb[13]);
641 sb[2] &= 0x0f;
642 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700643
644 sb[0] = 0x70;
Jeff Garzikb0955182005-05-12 15:45:22 -0400645 sb[7] = 0x0a;
Jeff Garzik0274aa22005-06-22 13:50:56 -0400646
Jeff Garzika7dac442005-10-30 04:44:42 -0500647 if (tf->flags & ATA_TFLAG_LBA48) {
648 /* TODO: find solution for LBA48 descriptors */
649 }
650
651 else if (tf->flags & ATA_TFLAG_LBA) {
Jeff Garzikb0955182005-05-12 15:45:22 -0400652 /* A small (28b) LBA will fit in the 32b info field */
653 sb[0] |= 0x80; /* set valid bit */
654 sb[3] = tf->device & 0x0f;
655 sb[4] = tf->lbah;
656 sb[5] = tf->lbam;
657 sb[6] = tf->lbal;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700658 }
Jeff Garzika7dac442005-10-30 04:44:42 -0500659
660 else {
661 /* TODO: C/H/S */
662 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700663}
664
665/**
666 * ata_scsi_slave_config - Set SCSI device attributes
667 * @sdev: SCSI device to examine
668 *
669 * This is called before we actually start reading
670 * and writing to the device, to configure certain
671 * SCSI mid-layer behaviors.
672 *
673 * LOCKING:
674 * Defined by SCSI layer. We don't really care.
675 */
676
677int ata_scsi_slave_config(struct scsi_device *sdev)
678{
679 sdev->use_10_for_rw = 1;
680 sdev->use_10_for_ms = 1;
681
682 blk_queue_max_phys_segments(sdev->request_queue, LIBATA_MAX_PRD);
683
684 if (sdev->id < ATA_MAX_DEVICES) {
685 struct ata_port *ap;
686 struct ata_device *dev;
Tejun Heob00eec12006-02-12 23:32:59 +0900687 unsigned int max_sectors;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700688
689 ap = (struct ata_port *) &sdev->host->hostdata[0];
690 dev = &ap->device[sdev->id];
691
Tejun Heob00eec12006-02-12 23:32:59 +0900692 /* TODO: 2048 is an arbitrary number, not the
Linus Torvalds1da177e2005-04-16 15:20:36 -0700693 * hardware maximum. This should be increased to
694 * 65534 when Jens Axboe's patch for dynamically
695 * determining max_sectors is merged.
696 */
Tejun Heob00eec12006-02-12 23:32:59 +0900697 max_sectors = ATA_MAX_SECTORS;
698 if (dev->flags & ATA_DFLAG_LBA48)
699 max_sectors = 2048;
700 if (dev->max_sectors)
701 max_sectors = dev->max_sectors;
702
703 blk_queue_max_sectors(sdev->request_queue, max_sectors);
Jeff Garzikcedc9a42005-10-05 07:13:30 -0400704
705 /*
706 * SATA DMA transfers must be multiples of 4 byte, so
707 * we need to pad ATAPI transfers using an extra sg.
708 * Decrement max hw segments accordingly.
709 */
710 if (dev->class == ATA_DEV_ATAPI) {
711 request_queue_t *q = sdev->request_queue;
712 blk_queue_max_hw_segments(q, q->max_hw_segments - 1);
713 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700714 }
715
716 return 0; /* scsi layer doesn't check return value, sigh */
717}
718
719/**
Tejun Heof29841e2006-02-10 15:10:48 +0900720 * ata_scsi_timed_out - SCSI layer time out callback
721 * @cmd: timed out SCSI command
722 *
723 * Handles SCSI layer timeout. We race with normal completion of
724 * the qc for @cmd. If the qc is already gone, we lose and let
725 * the scsi command finish (EH_HANDLED). Otherwise, the qc has
726 * timed out and EH should be invoked. Prevent ata_qc_complete()
727 * from finishing it by setting EH_SCHEDULED and return
728 * EH_NOT_HANDLED.
729 *
730 * LOCKING:
731 * Called from timer context
732 *
733 * RETURNS:
734 * EH_HANDLED or EH_NOT_HANDLED
735 */
736enum scsi_eh_timer_return ata_scsi_timed_out(struct scsi_cmnd *cmd)
737{
738 struct Scsi_Host *host = cmd->device->host;
739 struct ata_port *ap = (struct ata_port *) &host->hostdata[0];
740 unsigned long flags;
741 struct ata_queued_cmd *qc;
742 enum scsi_eh_timer_return ret = EH_HANDLED;
743
744 DPRINTK("ENTER\n");
745
746 spin_lock_irqsave(&ap->host_set->lock, flags);
747 qc = ata_qc_from_tag(ap, ap->active_tag);
748 if (qc) {
Tejun Heoa46314742006-02-11 19:11:13 +0900749 WARN_ON(qc->scsicmd != cmd);
Tejun Heof29841e2006-02-10 15:10:48 +0900750 qc->flags |= ATA_QCFLAG_EH_SCHEDULED;
751 qc->err_mask |= AC_ERR_TIMEOUT;
752 ret = EH_NOT_HANDLED;
753 }
754 spin_unlock_irqrestore(&ap->host_set->lock, flags);
755
756 DPRINTK("EXIT, ret=%d\n", ret);
757 return ret;
758}
759
760/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700761 * ata_scsi_error - SCSI layer error handler callback
762 * @host: SCSI host on which error occurred
763 *
764 * Handles SCSI-layer-thrown error events.
765 *
766 * LOCKING:
767 * Inherited from SCSI layer (none, can sleep)
768 *
769 * RETURNS:
770 * Zero.
771 */
772
773int ata_scsi_error(struct Scsi_Host *host)
774{
775 struct ata_port *ap;
Jeff Garzik51407882006-02-09 01:56:05 -0500776 unsigned long flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700777
778 DPRINTK("ENTER\n");
779
Jeff Garzik51407882006-02-09 01:56:05 -0500780 ap = (struct ata_port *) &host->hostdata[0];
781
Tejun Heodde44582006-02-02 00:56:10 +0900782 spin_lock_irqsave(&ap->host_set->lock, flags);
Tejun Heoa46314742006-02-11 19:11:13 +0900783 WARN_ON(ap->flags & ATA_FLAG_IN_EH);
Tejun Heodde44582006-02-02 00:56:10 +0900784 ap->flags |= ATA_FLAG_IN_EH;
Tejun Heoa46314742006-02-11 19:11:13 +0900785 WARN_ON(ata_qc_from_tag(ap, ap->active_tag) == NULL);
Tejun Heodde44582006-02-02 00:56:10 +0900786 spin_unlock_irqrestore(&ap->host_set->lock, flags);
787
Tejun Heo86e45b62006-03-05 15:29:09 +0900788 ata_port_flush_task(ap);
789
Linus Torvalds1da177e2005-04-16 15:20:36 -0700790 ap->ops->eng_timeout(ap);
791
Tejun Heoa46314742006-02-11 19:11:13 +0900792 WARN_ON(host->host_failed || !list_empty(&host->eh_cmd_q));
Tejun Heoa72ec4c2006-01-23 13:09:37 +0900793
794 scsi_eh_flush_done_q(&ap->eh_done_q);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700795
Tejun Heodde44582006-02-02 00:56:10 +0900796 spin_lock_irqsave(&ap->host_set->lock, flags);
797 ap->flags &= ~ATA_FLAG_IN_EH;
798 spin_unlock_irqrestore(&ap->host_set->lock, flags);
799
Linus Torvalds1da177e2005-04-16 15:20:36 -0700800 DPRINTK("EXIT\n");
801 return 0;
802}
803
Tejun Heoa72ec4c2006-01-23 13:09:37 +0900804static void ata_eh_scsidone(struct scsi_cmnd *scmd)
805{
806 /* nada */
807}
808
809static void __ata_eh_qc_complete(struct ata_queued_cmd *qc)
810{
811 struct ata_port *ap = qc->ap;
812 struct scsi_cmnd *scmd = qc->scsicmd;
813 unsigned long flags;
814
815 spin_lock_irqsave(&ap->host_set->lock, flags);
816 qc->scsidone = ata_eh_scsidone;
Tejun Heo341963b2006-02-10 15:10:48 +0900817 __ata_qc_complete(qc);
Tejun Heoa46314742006-02-11 19:11:13 +0900818 WARN_ON(ata_tag_valid(qc->tag));
Tejun Heoa72ec4c2006-01-23 13:09:37 +0900819 spin_unlock_irqrestore(&ap->host_set->lock, flags);
820
821 scsi_eh_finish_cmd(scmd, &ap->eh_done_q);
822}
823
824/**
825 * ata_eh_qc_complete - Complete an active ATA command from EH
826 * @qc: Command to complete
827 *
828 * Indicate to the mid and upper layers that an ATA command has
829 * completed. To be used from EH.
830 */
831void ata_eh_qc_complete(struct ata_queued_cmd *qc)
832{
833 struct scsi_cmnd *scmd = qc->scsicmd;
834 scmd->retries = scmd->allowed;
835 __ata_eh_qc_complete(qc);
836}
837
838/**
839 * ata_eh_qc_retry - Tell midlayer to retry an ATA command after EH
840 * @qc: Command to retry
841 *
842 * Indicate to the mid and upper layers that an ATA command
843 * should be retried. To be used from EH.
844 *
845 * SCSI midlayer limits the number of retries to scmd->allowed.
846 * This function might need to adjust scmd->retries for commands
847 * which get retried due to unrelated NCQ failures.
848 */
849void ata_eh_qc_retry(struct ata_queued_cmd *qc)
850{
851 __ata_eh_qc_complete(qc);
852}
853
Linus Torvalds1da177e2005-04-16 15:20:36 -0700854/**
Douglas Gilbert972dcaf2005-08-11 03:35:53 -0400855 * ata_scsi_start_stop_xlat - Translate SCSI START STOP UNIT command
856 * @qc: Storage for translated ATA taskfile
857 * @scsicmd: SCSI command to translate
858 *
859 * Sets up an ATA taskfile to issue STANDBY (to stop) or READ VERIFY
860 * (to start). Perhaps these commands should be preceded by
861 * CHECK POWER MODE to see what power mode the device is already in.
862 * [See SAT revision 5 at www.t10.org]
863 *
864 * LOCKING:
865 * spin_lock_irqsave(host_set lock)
866 *
867 * RETURNS:
868 * Zero on success, non-zero on error.
869 */
870
871static unsigned int ata_scsi_start_stop_xlat(struct ata_queued_cmd *qc,
Jeff Garzik057ace52005-10-22 14:27:05 -0400872 const u8 *scsicmd)
Douglas Gilbert972dcaf2005-08-11 03:35:53 -0400873{
874 struct ata_taskfile *tf = &qc->tf;
875
876 tf->flags |= ATA_TFLAG_DEVICE | ATA_TFLAG_ISADDR;
877 tf->protocol = ATA_PROT_NODATA;
878 if (scsicmd[1] & 0x1) {
879 ; /* ignore IMMED bit, violates sat-r05 */
880 }
881 if (scsicmd[4] & 0x2)
Douglas Gilbertae006512005-10-09 09:09:35 -0400882 goto invalid_fld; /* LOEJ bit set not supported */
Douglas Gilbert972dcaf2005-08-11 03:35:53 -0400883 if (((scsicmd[4] >> 4) & 0xf) != 0)
Douglas Gilbertae006512005-10-09 09:09:35 -0400884 goto invalid_fld; /* power conditions not supported */
Douglas Gilbert972dcaf2005-08-11 03:35:53 -0400885 if (scsicmd[4] & 0x1) {
886 tf->nsect = 1; /* 1 sector, lba=0 */
Albert Lee9d5b1302005-10-04 08:48:17 -0400887
888 if (qc->dev->flags & ATA_DFLAG_LBA) {
889 qc->tf.flags |= ATA_TFLAG_LBA;
890
891 tf->lbah = 0x0;
892 tf->lbam = 0x0;
893 tf->lbal = 0x0;
894 tf->device |= ATA_LBA;
895 } else {
896 /* CHS */
897 tf->lbal = 0x1; /* sect */
898 tf->lbam = 0x0; /* cyl low */
899 tf->lbah = 0x0; /* cyl high */
900 }
901
Douglas Gilbert972dcaf2005-08-11 03:35:53 -0400902 tf->command = ATA_CMD_VERIFY; /* READ VERIFY */
903 } else {
904 tf->nsect = 0; /* time period value (0 implies now) */
905 tf->command = ATA_CMD_STANDBY;
906 /* Consider: ATA STANDBY IMMEDIATE command */
907 }
908 /*
909 * Standby and Idle condition timers could be implemented but that
910 * would require libata to implement the Power condition mode page
911 * and allow the user to change it. Changing mode pages requires
912 * MODE SELECT to be implemented.
913 */
914
915 return 0;
Douglas Gilbertae006512005-10-09 09:09:35 -0400916
917invalid_fld:
918 ata_scsi_set_sense(qc->scsicmd, ILLEGAL_REQUEST, 0x24, 0x0);
919 /* "Invalid field in cbd" */
920 return 1;
Douglas Gilbert972dcaf2005-08-11 03:35:53 -0400921}
922
923
924/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700925 * ata_scsi_flush_xlat - Translate SCSI SYNCHRONIZE CACHE command
926 * @qc: Storage for translated ATA taskfile
927 * @scsicmd: SCSI command to translate (ignored)
928 *
929 * Sets up an ATA taskfile to issue FLUSH CACHE or
930 * FLUSH CACHE EXT.
931 *
932 * LOCKING:
933 * spin_lock_irqsave(host_set lock)
934 *
935 * RETURNS:
936 * Zero on success, non-zero on error.
937 */
938
Jeff Garzik057ace52005-10-22 14:27:05 -0400939static unsigned int ata_scsi_flush_xlat(struct ata_queued_cmd *qc, const u8 *scsicmd)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700940{
941 struct ata_taskfile *tf = &qc->tf;
942
943 tf->flags |= ATA_TFLAG_DEVICE;
944 tf->protocol = ATA_PROT_NODATA;
945
Albert Lee07506692005-10-12 15:04:18 +0800946 if ((qc->dev->flags & ATA_DFLAG_LBA48) &&
Linus Torvalds1da177e2005-04-16 15:20:36 -0700947 (ata_id_has_flush_ext(qc->dev->id)))
948 tf->command = ATA_CMD_FLUSH_EXT;
949 else
950 tf->command = ATA_CMD_FLUSH;
951
952 return 0;
953}
954
955/**
Albert Lee3aef5232005-10-04 08:47:43 -0400956 * scsi_6_lba_len - Get LBA and transfer length
957 * @scsicmd: SCSI command to translate
958 *
959 * Calculate LBA and transfer length for 6-byte commands.
960 *
961 * RETURNS:
962 * @plba: the LBA
963 * @plen: the transfer length
964 */
965
Jeff Garzik057ace52005-10-22 14:27:05 -0400966static void scsi_6_lba_len(const u8 *scsicmd, u64 *plba, u32 *plen)
Albert Lee3aef5232005-10-04 08:47:43 -0400967{
968 u64 lba = 0;
969 u32 len = 0;
970
971 VPRINTK("six-byte command\n");
972
973 lba |= ((u64)scsicmd[2]) << 8;
974 lba |= ((u64)scsicmd[3]);
975
976 len |= ((u32)scsicmd[4]);
977
978 *plba = lba;
979 *plen = len;
980}
981
982/**
983 * scsi_10_lba_len - Get LBA and transfer length
984 * @scsicmd: SCSI command to translate
985 *
986 * Calculate LBA and transfer length for 10-byte commands.
987 *
988 * RETURNS:
989 * @plba: the LBA
990 * @plen: the transfer length
991 */
992
Jeff Garzik057ace52005-10-22 14:27:05 -0400993static void scsi_10_lba_len(const u8 *scsicmd, u64 *plba, u32 *plen)
Albert Lee3aef5232005-10-04 08:47:43 -0400994{
995 u64 lba = 0;
996 u32 len = 0;
997
998 VPRINTK("ten-byte command\n");
999
1000 lba |= ((u64)scsicmd[2]) << 24;
1001 lba |= ((u64)scsicmd[3]) << 16;
1002 lba |= ((u64)scsicmd[4]) << 8;
1003 lba |= ((u64)scsicmd[5]);
1004
1005 len |= ((u32)scsicmd[7]) << 8;
1006 len |= ((u32)scsicmd[8]);
1007
1008 *plba = lba;
1009 *plen = len;
1010}
1011
1012/**
1013 * scsi_16_lba_len - Get LBA and transfer length
1014 * @scsicmd: SCSI command to translate
1015 *
1016 * Calculate LBA and transfer length for 16-byte commands.
1017 *
1018 * RETURNS:
1019 * @plba: the LBA
1020 * @plen: the transfer length
1021 */
1022
Jeff Garzik057ace52005-10-22 14:27:05 -04001023static void scsi_16_lba_len(const u8 *scsicmd, u64 *plba, u32 *plen)
Albert Lee3aef5232005-10-04 08:47:43 -04001024{
1025 u64 lba = 0;
1026 u32 len = 0;
1027
1028 VPRINTK("sixteen-byte command\n");
1029
1030 lba |= ((u64)scsicmd[2]) << 56;
1031 lba |= ((u64)scsicmd[3]) << 48;
1032 lba |= ((u64)scsicmd[4]) << 40;
1033 lba |= ((u64)scsicmd[5]) << 32;
1034 lba |= ((u64)scsicmd[6]) << 24;
1035 lba |= ((u64)scsicmd[7]) << 16;
1036 lba |= ((u64)scsicmd[8]) << 8;
1037 lba |= ((u64)scsicmd[9]);
1038
1039 len |= ((u32)scsicmd[10]) << 24;
1040 len |= ((u32)scsicmd[11]) << 16;
1041 len |= ((u32)scsicmd[12]) << 8;
1042 len |= ((u32)scsicmd[13]);
1043
1044 *plba = lba;
1045 *plen = len;
1046}
1047
1048/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07001049 * ata_scsi_verify_xlat - Translate SCSI VERIFY command into an ATA one
1050 * @qc: Storage for translated ATA taskfile
1051 * @scsicmd: SCSI command to translate
1052 *
1053 * Converts SCSI VERIFY command to an ATA READ VERIFY command.
1054 *
1055 * LOCKING:
1056 * spin_lock_irqsave(host_set lock)
1057 *
1058 * RETURNS:
1059 * Zero on success, non-zero on error.
1060 */
1061
Jeff Garzik057ace52005-10-22 14:27:05 -04001062static unsigned int ata_scsi_verify_xlat(struct ata_queued_cmd *qc, const u8 *scsicmd)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001063{
1064 struct ata_taskfile *tf = &qc->tf;
Albert Lee8bf62ece2005-05-12 15:29:42 -04001065 struct ata_device *dev = qc->dev;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001066 u64 dev_sectors = qc->dev->n_sectors;
Albert Lee3aef5232005-10-04 08:47:43 -04001067 u64 block;
1068 u32 n_block;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001069
1070 tf->flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
1071 tf->protocol = ATA_PROT_NODATA;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001072
Albert Lee3aef5232005-10-04 08:47:43 -04001073 if (scsicmd[0] == VERIFY)
1074 scsi_10_lba_len(scsicmd, &block, &n_block);
1075 else if (scsicmd[0] == VERIFY_16)
1076 scsi_16_lba_len(scsicmd, &block, &n_block);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001077 else
Douglas Gilbertae006512005-10-09 09:09:35 -04001078 goto invalid_fld;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001079
Albert Lee8bf62ece2005-05-12 15:29:42 -04001080 if (!n_block)
Douglas Gilbertae006512005-10-09 09:09:35 -04001081 goto nothing_to_do;
Albert Lee8bf62ece2005-05-12 15:29:42 -04001082 if (block >= dev_sectors)
Douglas Gilbertae006512005-10-09 09:09:35 -04001083 goto out_of_range;
Albert Lee8bf62ece2005-05-12 15:29:42 -04001084 if ((block + n_block) > dev_sectors)
Douglas Gilbertae006512005-10-09 09:09:35 -04001085 goto out_of_range;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001086
Albert Lee07506692005-10-12 15:04:18 +08001087 if (dev->flags & ATA_DFLAG_LBA) {
1088 tf->flags |= ATA_TFLAG_LBA;
1089
Albert Leec6a33e22005-10-12 15:12:26 +08001090 if (lba_28_ok(block, n_block)) {
1091 /* use LBA28 */
1092 tf->command = ATA_CMD_VERIFY;
1093 tf->device |= (block >> 24) & 0xf;
1094 } else if (lba_48_ok(block, n_block)) {
1095 if (!(dev->flags & ATA_DFLAG_LBA48))
1096 goto out_of_range;
Albert Lee07506692005-10-12 15:04:18 +08001097
1098 /* use LBA48 */
1099 tf->flags |= ATA_TFLAG_LBA48;
Albert Lee8bf62ece2005-05-12 15:29:42 -04001100 tf->command = ATA_CMD_VERIFY_EXT;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001101
Albert Lee8bf62ece2005-05-12 15:29:42 -04001102 tf->hob_nsect = (n_block >> 8) & 0xff;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001103
Albert Lee8bf62ece2005-05-12 15:29:42 -04001104 tf->hob_lbah = (block >> 40) & 0xff;
1105 tf->hob_lbam = (block >> 32) & 0xff;
1106 tf->hob_lbal = (block >> 24) & 0xff;
Albert Leec6a33e22005-10-12 15:12:26 +08001107 } else
1108 /* request too large even for LBA48 */
1109 goto out_of_range;
Albert Lee8bf62ece2005-05-12 15:29:42 -04001110
1111 tf->nsect = n_block & 0xff;
1112
1113 tf->lbah = (block >> 16) & 0xff;
1114 tf->lbam = (block >> 8) & 0xff;
1115 tf->lbal = block & 0xff;
1116
1117 tf->device |= ATA_LBA;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001118 } else {
Albert Lee8bf62ece2005-05-12 15:29:42 -04001119 /* CHS */
1120 u32 sect, head, cyl, track;
1121
Albert Leec6a33e22005-10-12 15:12:26 +08001122 if (!lba_28_ok(block, n_block))
1123 goto out_of_range;
Albert Lee07506692005-10-12 15:04:18 +08001124
Albert Lee8bf62ece2005-05-12 15:29:42 -04001125 /* Convert LBA to CHS */
1126 track = (u32)block / dev->sectors;
1127 cyl = track / dev->heads;
1128 head = track % dev->heads;
1129 sect = (u32)block % dev->sectors + 1;
1130
Albert Leec187c4b2005-10-04 08:46:51 -04001131 DPRINTK("block %u track %u cyl %u head %u sect %u\n",
1132 (u32)block, track, cyl, head, sect);
Albert Lee8bf62ece2005-05-12 15:29:42 -04001133
1134 /* Check whether the converted CHS can fit.
1135 Cylinder: 0-65535
1136 Head: 0-15
1137 Sector: 1-255*/
1138 if ((cyl >> 16) || (head >> 4) || (sect >> 8) || (!sect))
Douglas Gilbertae006512005-10-09 09:09:35 -04001139 goto out_of_range;
Albert Lee8bf62ece2005-05-12 15:29:42 -04001140
Linus Torvalds1da177e2005-04-16 15:20:36 -07001141 tf->command = ATA_CMD_VERIFY;
Albert Lee8bf62ece2005-05-12 15:29:42 -04001142 tf->nsect = n_block & 0xff; /* Sector count 0 means 256 sectors */
1143 tf->lbal = sect;
1144 tf->lbam = cyl;
1145 tf->lbah = cyl >> 8;
1146 tf->device |= head;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001147 }
1148
Linus Torvalds1da177e2005-04-16 15:20:36 -07001149 return 0;
Douglas Gilbertae006512005-10-09 09:09:35 -04001150
1151invalid_fld:
1152 ata_scsi_set_sense(qc->scsicmd, ILLEGAL_REQUEST, 0x24, 0x0);
1153 /* "Invalid field in cbd" */
1154 return 1;
1155
1156out_of_range:
1157 ata_scsi_set_sense(qc->scsicmd, ILLEGAL_REQUEST, 0x21, 0x0);
1158 /* "Logical Block Address out of range" */
1159 return 1;
1160
1161nothing_to_do:
1162 qc->scsicmd->result = SAM_STAT_GOOD;
1163 return 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001164}
1165
1166/**
1167 * ata_scsi_rw_xlat - Translate SCSI r/w command into an ATA one
1168 * @qc: Storage for translated ATA taskfile
1169 * @scsicmd: SCSI command to translate
1170 *
1171 * Converts any of six SCSI read/write commands into the
1172 * ATA counterpart, including starting sector (LBA),
1173 * sector count, and taking into account the device's LBA48
1174 * support.
1175 *
1176 * Commands %READ_6, %READ_10, %READ_16, %WRITE_6, %WRITE_10, and
1177 * %WRITE_16 are currently supported.
1178 *
1179 * LOCKING:
1180 * spin_lock_irqsave(host_set lock)
1181 *
1182 * RETURNS:
1183 * Zero on success, non-zero on error.
1184 */
1185
Jeff Garzik057ace52005-10-22 14:27:05 -04001186static unsigned int ata_scsi_rw_xlat(struct ata_queued_cmd *qc, const u8 *scsicmd)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001187{
1188 struct ata_taskfile *tf = &qc->tf;
Albert Lee8bf62ece2005-05-12 15:29:42 -04001189 struct ata_device *dev = qc->dev;
Albert Lee3aef5232005-10-04 08:47:43 -04001190 u64 block;
1191 u32 n_block;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001192
1193 tf->flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001194
Albert Lee8cbd6df2005-10-12 15:06:27 +08001195 if (scsicmd[0] == WRITE_10 || scsicmd[0] == WRITE_6 ||
1196 scsicmd[0] == WRITE_16)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001197 tf->flags |= ATA_TFLAG_WRITE;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001198
Tejun Heo9a3dccc2006-01-06 09:56:18 +01001199 /* Calculate the SCSI LBA, transfer length and FUA. */
Albert Lee3aef5232005-10-04 08:47:43 -04001200 switch (scsicmd[0]) {
1201 case READ_10:
1202 case WRITE_10:
1203 scsi_10_lba_len(scsicmd, &block, &n_block);
Tejun Heo9a3dccc2006-01-06 09:56:18 +01001204 if (unlikely(scsicmd[1] & (1 << 3)))
1205 tf->flags |= ATA_TFLAG_FUA;
Albert Lee3aef5232005-10-04 08:47:43 -04001206 break;
1207 case READ_6:
1208 case WRITE_6:
1209 scsi_6_lba_len(scsicmd, &block, &n_block);
Albert Leec187c4b2005-10-04 08:46:51 -04001210
1211 /* for 6-byte r/w commands, transfer length 0
1212 * means 256 blocks of data, not 0 block.
1213 */
Jeff Garzik76b2bf92005-08-29 19:24:43 -04001214 if (!n_block)
1215 n_block = 256;
Albert Lee3aef5232005-10-04 08:47:43 -04001216 break;
1217 case READ_16:
1218 case WRITE_16:
1219 scsi_16_lba_len(scsicmd, &block, &n_block);
Tejun Heo9a3dccc2006-01-06 09:56:18 +01001220 if (unlikely(scsicmd[1] & (1 << 3)))
1221 tf->flags |= ATA_TFLAG_FUA;
Albert Lee3aef5232005-10-04 08:47:43 -04001222 break;
1223 default:
Albert Lee8bf62ece2005-05-12 15:29:42 -04001224 DPRINTK("no-byte command\n");
Douglas Gilbertae006512005-10-09 09:09:35 -04001225 goto invalid_fld;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001226 }
1227
Albert Lee8bf62ece2005-05-12 15:29:42 -04001228 /* Check and compose ATA command */
1229 if (!n_block)
Albert Leec187c4b2005-10-04 08:46:51 -04001230 /* For 10-byte and 16-byte SCSI R/W commands, transfer
1231 * length 0 means transfer 0 block of data.
1232 * However, for ATA R/W commands, sector count 0 means
1233 * 256 or 65536 sectors, not 0 sectors as in SCSI.
Alan Coxf51750d2005-11-07 17:06:33 +00001234 *
1235 * WARNING: one or two older ATA drives treat 0 as 0...
Albert Leec187c4b2005-10-04 08:46:51 -04001236 */
Douglas Gilbertae006512005-10-09 09:09:35 -04001237 goto nothing_to_do;
Albert Lee8bf62ece2005-05-12 15:29:42 -04001238
Albert Lee07506692005-10-12 15:04:18 +08001239 if (dev->flags & ATA_DFLAG_LBA) {
1240 tf->flags |= ATA_TFLAG_LBA;
1241
Albert Leec6a33e22005-10-12 15:12:26 +08001242 if (lba_28_ok(block, n_block)) {
1243 /* use LBA28 */
1244 tf->device |= (block >> 24) & 0xf;
1245 } else if (lba_48_ok(block, n_block)) {
1246 if (!(dev->flags & ATA_DFLAG_LBA48))
Douglas Gilbertae006512005-10-09 09:09:35 -04001247 goto out_of_range;
Albert Lee8bf62ece2005-05-12 15:29:42 -04001248
Albert Lee07506692005-10-12 15:04:18 +08001249 /* use LBA48 */
1250 tf->flags |= ATA_TFLAG_LBA48;
1251
Albert Lee8bf62ece2005-05-12 15:29:42 -04001252 tf->hob_nsect = (n_block >> 8) & 0xff;
1253
1254 tf->hob_lbah = (block >> 40) & 0xff;
1255 tf->hob_lbam = (block >> 32) & 0xff;
1256 tf->hob_lbal = (block >> 24) & 0xff;
Albert Leec6a33e22005-10-12 15:12:26 +08001257 } else
1258 /* request too large even for LBA48 */
1259 goto out_of_range;
Albert Leec187c4b2005-10-04 08:46:51 -04001260
Tejun Heo9a3dccc2006-01-06 09:56:18 +01001261 if (unlikely(ata_rwcmd_protocol(qc) < 0))
1262 goto invalid_fld;
Albert Lee8cbd6df2005-10-12 15:06:27 +08001263
Albert Lee8bf62ece2005-05-12 15:29:42 -04001264 qc->nsect = n_block;
1265 tf->nsect = n_block & 0xff;
1266
1267 tf->lbah = (block >> 16) & 0xff;
1268 tf->lbam = (block >> 8) & 0xff;
1269 tf->lbal = block & 0xff;
1270
1271 tf->device |= ATA_LBA;
1272 } else {
1273 /* CHS */
1274 u32 sect, head, cyl, track;
1275
1276 /* The request -may- be too large for CHS addressing. */
Albert Leec6a33e22005-10-12 15:12:26 +08001277 if (!lba_28_ok(block, n_block))
Douglas Gilbertae006512005-10-09 09:09:35 -04001278 goto out_of_range;
Albert Leec187c4b2005-10-04 08:46:51 -04001279
Tejun Heo9a3dccc2006-01-06 09:56:18 +01001280 if (unlikely(ata_rwcmd_protocol(qc) < 0))
1281 goto invalid_fld;
Albert Lee8cbd6df2005-10-12 15:06:27 +08001282
Albert Lee8bf62ece2005-05-12 15:29:42 -04001283 /* Convert LBA to CHS */
1284 track = (u32)block / dev->sectors;
1285 cyl = track / dev->heads;
1286 head = track % dev->heads;
1287 sect = (u32)block % dev->sectors + 1;
1288
Albert Leec187c4b2005-10-04 08:46:51 -04001289 DPRINTK("block %u track %u cyl %u head %u sect %u\n",
Albert Lee8bf62ece2005-05-12 15:29:42 -04001290 (u32)block, track, cyl, head, sect);
Albert Leec187c4b2005-10-04 08:46:51 -04001291
Albert Lee8bf62ece2005-05-12 15:29:42 -04001292 /* Check whether the converted CHS can fit.
1293 Cylinder: 0-65535
1294 Head: 0-15
1295 Sector: 1-255*/
Albert Leec187c4b2005-10-04 08:46:51 -04001296 if ((cyl >> 16) || (head >> 4) || (sect >> 8) || (!sect))
Douglas Gilbertae006512005-10-09 09:09:35 -04001297 goto out_of_range;
Albert Leec187c4b2005-10-04 08:46:51 -04001298
Albert Lee8bf62ece2005-05-12 15:29:42 -04001299 qc->nsect = n_block;
1300 tf->nsect = n_block & 0xff; /* Sector count 0 means 256 sectors */
1301 tf->lbal = sect;
1302 tf->lbam = cyl;
1303 tf->lbah = cyl >> 8;
1304 tf->device |= head;
1305 }
1306
1307 return 0;
Douglas Gilbertae006512005-10-09 09:09:35 -04001308
1309invalid_fld:
1310 ata_scsi_set_sense(qc->scsicmd, ILLEGAL_REQUEST, 0x24, 0x0);
1311 /* "Invalid field in cbd" */
1312 return 1;
1313
1314out_of_range:
1315 ata_scsi_set_sense(qc->scsicmd, ILLEGAL_REQUEST, 0x21, 0x0);
1316 /* "Logical Block Address out of range" */
1317 return 1;
1318
1319nothing_to_do:
1320 qc->scsicmd->result = SAM_STAT_GOOD;
1321 return 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001322}
1323
Tejun Heo77853bf2006-01-23 13:09:36 +09001324static void ata_scsi_qc_complete(struct ata_queued_cmd *qc)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001325{
1326 struct scsi_cmnd *cmd = qc->scsicmd;
Jeff Garzika7dac442005-10-30 04:44:42 -05001327 u8 *cdb = cmd->cmnd;
Albert Leea22e2eb2005-12-05 15:38:02 +08001328 int need_sense = (qc->err_mask != 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001329
Jeff Garzikb0955182005-05-12 15:45:22 -04001330 /* For ATA pass thru (SAT) commands, generate a sense block if
1331 * user mandated it or if there's an error. Note that if we
1332 * generate because the user forced us to, a check condition
1333 * is generated and the ATA register values are returned
1334 * whether the command completed successfully or not. If there
1335 * was no error, SK, ASC and ASCQ will all be zero.
1336 */
Jeff Garzika7dac442005-10-30 04:44:42 -05001337 if (((cdb[0] == ATA_16) || (cdb[0] == ATA_12)) &&
1338 ((cdb[2] & 0x20) || need_sense)) {
Jeff Garzikb0955182005-05-12 15:45:22 -04001339 ata_gen_ata_desc_sense(qc);
1340 } else {
1341 if (!need_sense) {
1342 cmd->result = SAM_STAT_GOOD;
1343 } else {
1344 /* TODO: decide which descriptor format to use
1345 * for 48b LBA devices and call that here
1346 * instead of the fixed desc, which is only
1347 * good for smaller LBA (and maybe CHS?)
1348 * devices.
1349 */
1350 ata_gen_fixed_sense(qc);
1351 }
1352 }
1353
1354 if (need_sense) {
1355 /* The ata_gen_..._sense routines fill in tf */
1356 ata_dump_status(qc->ap->id, &qc->tf);
1357 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001358
1359 qc->scsidone(cmd);
1360
Tejun Heo77853bf2006-01-23 13:09:36 +09001361 ata_qc_free(qc);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001362}
1363
1364/**
1365 * ata_scsi_translate - Translate then issue SCSI command to ATA device
1366 * @ap: ATA port to which the command is addressed
1367 * @dev: ATA device to which the command is addressed
1368 * @cmd: SCSI command to execute
1369 * @done: SCSI command completion function
1370 * @xlat_func: Actor which translates @cmd to an ATA taskfile
1371 *
1372 * Our ->queuecommand() function has decided that the SCSI
1373 * command issued can be directly translated into an ATA
1374 * command, rather than handled internally.
1375 *
1376 * This function sets up an ata_queued_cmd structure for the
1377 * SCSI command, and sends that ata_queued_cmd to the hardware.
1378 *
Douglas Gilbertae006512005-10-09 09:09:35 -04001379 * The xlat_func argument (actor) returns 0 if ready to execute
1380 * ATA command, else 1 to finish translation. If 1 is returned
1381 * then cmd->result (and possibly cmd->sense_buffer) are assumed
1382 * to be set reflecting an error condition or clean (early)
1383 * termination.
1384 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07001385 * LOCKING:
1386 * spin_lock_irqsave(host_set lock)
1387 */
1388
1389static void ata_scsi_translate(struct ata_port *ap, struct ata_device *dev,
1390 struct scsi_cmnd *cmd,
1391 void (*done)(struct scsi_cmnd *),
1392 ata_xlat_func_t xlat_func)
1393{
1394 struct ata_queued_cmd *qc;
1395 u8 *scsicmd = cmd->cmnd;
1396
1397 VPRINTK("ENTER\n");
1398
1399 qc = ata_scsi_qc_new(ap, dev, cmd, done);
1400 if (!qc)
Douglas Gilbertae006512005-10-09 09:09:35 -04001401 goto err_mem;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001402
1403 /* data is present; dma-map it */
be7db052005-04-17 15:26:13 -05001404 if (cmd->sc_data_direction == DMA_FROM_DEVICE ||
1405 cmd->sc_data_direction == DMA_TO_DEVICE) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001406 if (unlikely(cmd->request_bufflen < 1)) {
1407 printk(KERN_WARNING "ata%u(%u): WARNING: zero len r/w req\n",
1408 ap->id, dev->devno);
Douglas Gilbertae006512005-10-09 09:09:35 -04001409 goto err_did;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001410 }
1411
1412 if (cmd->use_sg)
1413 ata_sg_init(qc, cmd->request_buffer, cmd->use_sg);
1414 else
1415 ata_sg_init_one(qc, cmd->request_buffer,
1416 cmd->request_bufflen);
1417
1418 qc->dma_dir = cmd->sc_data_direction;
1419 }
1420
1421 qc->complete_fn = ata_scsi_qc_complete;
1422
1423 if (xlat_func(qc, scsicmd))
Douglas Gilbertae006512005-10-09 09:09:35 -04001424 goto early_finish;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001425
1426 /* select device, send command to hardware */
Tejun Heo9a3d9eb2006-01-23 13:09:36 +09001427 qc->err_mask = ata_qc_issue(qc);
1428 if (qc->err_mask)
Tejun Heo8e436af2006-01-23 13:09:36 +09001429 ata_qc_complete(qc);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001430
1431 VPRINTK("EXIT\n");
1432 return;
1433
Douglas Gilbertae006512005-10-09 09:09:35 -04001434early_finish:
1435 ata_qc_free(qc);
1436 done(cmd);
1437 DPRINTK("EXIT - early finish (good or error)\n");
1438 return;
1439
1440err_did:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001441 ata_qc_free(qc);
Douglas Gilbertae006512005-10-09 09:09:35 -04001442err_mem:
1443 cmd->result = (DID_ERROR << 16);
1444 done(cmd);
1445 DPRINTK("EXIT - internal\n");
1446 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001447}
1448
1449/**
1450 * ata_scsi_rbuf_get - Map response buffer.
1451 * @cmd: SCSI command containing buffer to be mapped.
1452 * @buf_out: Pointer to mapped area.
1453 *
1454 * Maps buffer contained within SCSI command @cmd.
1455 *
1456 * LOCKING:
1457 * spin_lock_irqsave(host_set lock)
1458 *
1459 * RETURNS:
1460 * Length of response buffer.
1461 */
1462
1463static unsigned int ata_scsi_rbuf_get(struct scsi_cmnd *cmd, u8 **buf_out)
1464{
1465 u8 *buf;
1466 unsigned int buflen;
1467
1468 if (cmd->use_sg) {
1469 struct scatterlist *sg;
1470
1471 sg = (struct scatterlist *) cmd->request_buffer;
1472 buf = kmap_atomic(sg->page, KM_USER0) + sg->offset;
1473 buflen = sg->length;
1474 } else {
1475 buf = cmd->request_buffer;
1476 buflen = cmd->request_bufflen;
1477 }
1478
1479 *buf_out = buf;
1480 return buflen;
1481}
1482
1483/**
1484 * ata_scsi_rbuf_put - Unmap response buffer.
1485 * @cmd: SCSI command containing buffer to be unmapped.
1486 * @buf: buffer to unmap
1487 *
1488 * Unmaps response buffer contained within @cmd.
1489 *
1490 * LOCKING:
1491 * spin_lock_irqsave(host_set lock)
1492 */
1493
1494static inline void ata_scsi_rbuf_put(struct scsi_cmnd *cmd, u8 *buf)
1495{
1496 if (cmd->use_sg) {
1497 struct scatterlist *sg;
1498
1499 sg = (struct scatterlist *) cmd->request_buffer;
1500 kunmap_atomic(buf - sg->offset, KM_USER0);
1501 }
1502}
1503
1504/**
1505 * ata_scsi_rbuf_fill - wrapper for SCSI command simulators
1506 * @args: device IDENTIFY data / SCSI command of interest.
1507 * @actor: Callback hook for desired SCSI command simulator
1508 *
1509 * Takes care of the hard work of simulating a SCSI command...
1510 * Mapping the response buffer, calling the command's handler,
1511 * and handling the handler's return value. This return value
1512 * indicates whether the handler wishes the SCSI command to be
Douglas Gilbertae006512005-10-09 09:09:35 -04001513 * completed successfully (0), or not (in which case cmd->result
1514 * and sense buffer are assumed to be set).
Linus Torvalds1da177e2005-04-16 15:20:36 -07001515 *
1516 * LOCKING:
1517 * spin_lock_irqsave(host_set lock)
1518 */
1519
1520void ata_scsi_rbuf_fill(struct ata_scsi_args *args,
1521 unsigned int (*actor) (struct ata_scsi_args *args,
1522 u8 *rbuf, unsigned int buflen))
1523{
1524 u8 *rbuf;
1525 unsigned int buflen, rc;
1526 struct scsi_cmnd *cmd = args->cmd;
1527
1528 buflen = ata_scsi_rbuf_get(cmd, &rbuf);
1529 memset(rbuf, 0, buflen);
1530 rc = actor(args, rbuf, buflen);
1531 ata_scsi_rbuf_put(cmd, rbuf);
1532
Douglas Gilbertae006512005-10-09 09:09:35 -04001533 if (rc == 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001534 cmd->result = SAM_STAT_GOOD;
Douglas Gilbertae006512005-10-09 09:09:35 -04001535 args->done(cmd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001536}
1537
1538/**
1539 * ata_scsiop_inq_std - Simulate INQUIRY command
1540 * @args: device IDENTIFY data / SCSI command of interest.
1541 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1542 * @buflen: Response buffer length.
1543 *
1544 * Returns standard device identification data associated
Jeff Garzikb142eb62006-03-21 20:37:47 -05001545 * with non-VPD INQUIRY command output.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001546 *
1547 * LOCKING:
1548 * spin_lock_irqsave(host_set lock)
1549 */
1550
1551unsigned int ata_scsiop_inq_std(struct ata_scsi_args *args, u8 *rbuf,
1552 unsigned int buflen)
1553{
1554 u8 hdr[] = {
1555 TYPE_DISK,
1556 0,
1557 0x5, /* claim SPC-3 version compatibility */
1558 2,
1559 95 - 4
1560 };
1561
1562 /* set scsi removeable (RMB) bit per ata bit */
1563 if (ata_id_removeable(args->id))
1564 hdr[1] |= (1 << 7);
1565
1566 VPRINTK("ENTER\n");
1567
1568 memcpy(rbuf, hdr, sizeof(hdr));
1569
1570 if (buflen > 35) {
1571 memcpy(&rbuf[8], "ATA ", 8);
Tejun Heo6a62a042006-02-13 10:02:46 +09001572 ata_id_string(args->id, &rbuf[16], ATA_ID_PROD_OFS, 16);
1573 ata_id_string(args->id, &rbuf[32], ATA_ID_FW_REV_OFS, 4);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001574 if (rbuf[32] == 0 || rbuf[32] == ' ')
1575 memcpy(&rbuf[32], "n/a ", 4);
1576 }
1577
1578 if (buflen > 63) {
1579 const u8 versions[] = {
1580 0x60, /* SAM-3 (no version claimed) */
1581
1582 0x03,
1583 0x20, /* SBC-2 (no version claimed) */
1584
1585 0x02,
1586 0x60 /* SPC-3 (no version claimed) */
1587 };
1588
1589 memcpy(rbuf + 59, versions, sizeof(versions));
1590 }
1591
1592 return 0;
1593}
1594
1595/**
Jeff Garzikb142eb62006-03-21 20:37:47 -05001596 * ata_scsiop_inq_00 - Simulate INQUIRY VPD page 0, list of pages
Linus Torvalds1da177e2005-04-16 15:20:36 -07001597 * @args: device IDENTIFY data / SCSI command of interest.
1598 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1599 * @buflen: Response buffer length.
1600 *
Jeff Garzikb142eb62006-03-21 20:37:47 -05001601 * Returns list of inquiry VPD pages available.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001602 *
1603 * LOCKING:
1604 * spin_lock_irqsave(host_set lock)
1605 */
1606
1607unsigned int ata_scsiop_inq_00(struct ata_scsi_args *args, u8 *rbuf,
1608 unsigned int buflen)
1609{
1610 const u8 pages[] = {
1611 0x00, /* page 0x00, this page */
1612 0x80, /* page 0x80, unit serial no page */
1613 0x83 /* page 0x83, device ident page */
1614 };
Jeff Garzikb142eb62006-03-21 20:37:47 -05001615 rbuf[3] = sizeof(pages); /* number of supported VPD pages */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001616
1617 if (buflen > 6)
1618 memcpy(rbuf + 4, pages, sizeof(pages));
1619
1620 return 0;
1621}
1622
1623/**
Jeff Garzikb142eb62006-03-21 20:37:47 -05001624 * ata_scsiop_inq_80 - Simulate INQUIRY VPD page 80, device serial number
Linus Torvalds1da177e2005-04-16 15:20:36 -07001625 * @args: device IDENTIFY data / SCSI command of interest.
1626 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1627 * @buflen: Response buffer length.
1628 *
1629 * Returns ATA device serial number.
1630 *
1631 * LOCKING:
1632 * spin_lock_irqsave(host_set lock)
1633 */
1634
1635unsigned int ata_scsiop_inq_80(struct ata_scsi_args *args, u8 *rbuf,
1636 unsigned int buflen)
1637{
1638 const u8 hdr[] = {
1639 0,
1640 0x80, /* this page code */
1641 0,
1642 ATA_SERNO_LEN, /* page len */
1643 };
1644 memcpy(rbuf, hdr, sizeof(hdr));
1645
1646 if (buflen > (ATA_SERNO_LEN + 4 - 1))
Tejun Heo6a62a042006-02-13 10:02:46 +09001647 ata_id_string(args->id, (unsigned char *) &rbuf[4],
1648 ATA_ID_SERNO_OFS, ATA_SERNO_LEN);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001649
1650 return 0;
1651}
1652
Linus Torvalds1da177e2005-04-16 15:20:36 -07001653/**
Jeff Garzikb142eb62006-03-21 20:37:47 -05001654 * ata_scsiop_inq_83 - Simulate INQUIRY VPD page 83, device identity
Linus Torvalds1da177e2005-04-16 15:20:36 -07001655 * @args: device IDENTIFY data / SCSI command of interest.
1656 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1657 * @buflen: Response buffer length.
1658 *
Jeff Garzikb142eb62006-03-21 20:37:47 -05001659 * Yields two logical unit device identification designators:
1660 * - vendor specific ASCII containing the ATA serial number
1661 * - SAT defined "t10 vendor id based" containing ASCII vendor
1662 * name ("ATA "), model and serial numbers.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001663 *
1664 * LOCKING:
1665 * spin_lock_irqsave(host_set lock)
1666 */
1667
1668unsigned int ata_scsiop_inq_83(struct ata_scsi_args *args, u8 *rbuf,
1669 unsigned int buflen)
1670{
Jeff Garzikb142eb62006-03-21 20:37:47 -05001671 int num;
1672 const int sat_model_serial_desc_len = 68;
1673 const int ata_model_byte_len = 40;
1674
Linus Torvalds1da177e2005-04-16 15:20:36 -07001675 rbuf[1] = 0x83; /* this page code */
Jeff Garzikb142eb62006-03-21 20:37:47 -05001676 num = 4;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001677
Jeff Garzikb142eb62006-03-21 20:37:47 -05001678 if (buflen > (ATA_SERNO_LEN + num + 3)) {
1679 /* piv=0, assoc=lu, code_set=ACSII, designator=vendor */
1680 rbuf[num + 0] = 2;
1681 rbuf[num + 3] = ATA_SERNO_LEN;
1682 num += 4;
1683 ata_id_string(args->id, (unsigned char *) rbuf + num,
1684 ATA_ID_SERNO_OFS, ATA_SERNO_LEN);
1685 num += ATA_SERNO_LEN;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001686 }
Jeff Garzikb142eb62006-03-21 20:37:47 -05001687 if (buflen > (sat_model_serial_desc_len + num + 3)) {
1688 /* SAT defined lu model and serial numbers descriptor */
1689 /* piv=0, assoc=lu, code_set=ACSII, designator=t10 vendor id */
1690 rbuf[num + 0] = 2;
1691 rbuf[num + 1] = 1;
1692 rbuf[num + 3] = sat_model_serial_desc_len;
1693 num += 4;
1694 memcpy(rbuf + num, "ATA ", 8);
1695 num += 8;
1696 ata_id_string(args->id, (unsigned char *) rbuf + num,
1697 ATA_ID_PROD_OFS, ata_model_byte_len);
1698 num += ata_model_byte_len;
1699 ata_id_string(args->id, (unsigned char *) rbuf + num,
1700 ATA_ID_SERNO_OFS, ATA_SERNO_LEN);
1701 num += ATA_SERNO_LEN;
1702 }
1703 rbuf[3] = num - 4; /* page len (assume less than 256 bytes) */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001704 return 0;
1705}
1706
1707/**
Jeff Garzik0cba6322005-05-30 19:49:12 -04001708 * ata_scsiop_noop - Command handler that simply returns success.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001709 * @args: device IDENTIFY data / SCSI command of interest.
1710 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1711 * @buflen: Response buffer length.
1712 *
1713 * No operation. Simply returns success to caller, to indicate
1714 * that the caller should successfully complete this SCSI command.
1715 *
1716 * LOCKING:
1717 * spin_lock_irqsave(host_set lock)
1718 */
1719
1720unsigned int ata_scsiop_noop(struct ata_scsi_args *args, u8 *rbuf,
1721 unsigned int buflen)
1722{
1723 VPRINTK("ENTER\n");
1724 return 0;
1725}
1726
1727/**
1728 * ata_msense_push - Push data onto MODE SENSE data output buffer
1729 * @ptr_io: (input/output) Location to store more output data
1730 * @last: End of output data buffer
1731 * @buf: Pointer to BLOB being added to output buffer
1732 * @buflen: Length of BLOB
1733 *
1734 * Store MODE SENSE data on an output buffer.
1735 *
1736 * LOCKING:
1737 * None.
1738 */
1739
1740static void ata_msense_push(u8 **ptr_io, const u8 *last,
1741 const u8 *buf, unsigned int buflen)
1742{
1743 u8 *ptr = *ptr_io;
1744
1745 if ((ptr + buflen - 1) > last)
1746 return;
1747
1748 memcpy(ptr, buf, buflen);
1749
1750 ptr += buflen;
1751
1752 *ptr_io = ptr;
1753}
1754
1755/**
1756 * ata_msense_caching - Simulate MODE SENSE caching info page
1757 * @id: device IDENTIFY data
1758 * @ptr_io: (input/output) Location to store more output data
1759 * @last: End of output data buffer
1760 *
1761 * Generate a caching info page, which conditionally indicates
1762 * write caching to the SCSI layer, depending on device
1763 * capabilities.
1764 *
1765 * LOCKING:
1766 * None.
1767 */
1768
1769static unsigned int ata_msense_caching(u16 *id, u8 **ptr_io,
1770 const u8 *last)
1771{
Douglas Gilbert00ac37f2005-10-28 15:58:28 -04001772 u8 page[CACHE_MPAGE_LEN];
Linus Torvalds1da177e2005-04-16 15:20:36 -07001773
Douglas Gilbert00ac37f2005-10-28 15:58:28 -04001774 memcpy(page, def_cache_mpage, sizeof(page));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001775 if (ata_id_wcache_enabled(id))
1776 page[2] |= (1 << 2); /* write cache enable */
1777 if (!ata_id_rahead_enabled(id))
1778 page[12] |= (1 << 5); /* disable read ahead */
1779
1780 ata_msense_push(ptr_io, last, page, sizeof(page));
1781 return sizeof(page);
1782}
1783
1784/**
1785 * ata_msense_ctl_mode - Simulate MODE SENSE control mode page
1786 * @dev: Device associated with this MODE SENSE command
1787 * @ptr_io: (input/output) Location to store more output data
1788 * @last: End of output data buffer
1789 *
1790 * Generate a generic MODE SENSE control mode page.
1791 *
1792 * LOCKING:
1793 * None.
1794 */
1795
1796static unsigned int ata_msense_ctl_mode(u8 **ptr_io, const u8 *last)
1797{
Douglas Gilbert00ac37f2005-10-28 15:58:28 -04001798 ata_msense_push(ptr_io, last, def_control_mpage,
1799 sizeof(def_control_mpage));
1800 return sizeof(def_control_mpage);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001801}
1802
1803/**
1804 * ata_msense_rw_recovery - Simulate MODE SENSE r/w error recovery page
1805 * @dev: Device associated with this MODE SENSE command
1806 * @ptr_io: (input/output) Location to store more output data
1807 * @last: End of output data buffer
1808 *
1809 * Generate a generic MODE SENSE r/w error recovery page.
1810 *
1811 * LOCKING:
1812 * None.
1813 */
1814
1815static unsigned int ata_msense_rw_recovery(u8 **ptr_io, const u8 *last)
1816{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001817
Douglas Gilbert00ac37f2005-10-28 15:58:28 -04001818 ata_msense_push(ptr_io, last, def_rw_recovery_mpage,
1819 sizeof(def_rw_recovery_mpage));
1820 return sizeof(def_rw_recovery_mpage);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001821}
1822
Jens Axboe48bdc8e2006-01-30 16:09:35 +01001823/*
1824 * We can turn this into a real blacklist if it's needed, for now just
1825 * blacklist any Maxtor BANC1G10 revision firmware
1826 */
1827static int ata_dev_supports_fua(u16 *id)
1828{
1829 unsigned char model[41], fw[9];
1830
Jeff Garzikc3c013a2006-02-27 22:31:19 -05001831 if (!libata_fua)
1832 return 0;
Jens Axboe48bdc8e2006-01-30 16:09:35 +01001833 if (!ata_id_has_fua(id))
1834 return 0;
1835
Tejun Heo6a62a042006-02-13 10:02:46 +09001836 ata_id_c_string(id, model, ATA_ID_PROD_OFS, sizeof(model));
1837 ata_id_c_string(id, fw, ATA_ID_FW_REV_OFS, sizeof(fw));
Jens Axboe48bdc8e2006-01-30 16:09:35 +01001838
Tejun Heo2e026712006-02-12 22:47:04 +09001839 if (strcmp(model, "Maxtor"))
Jens Axboe48bdc8e2006-01-30 16:09:35 +01001840 return 1;
Tejun Heo2e026712006-02-12 22:47:04 +09001841 if (strcmp(fw, "BANC1G10"))
Jens Axboe48bdc8e2006-01-30 16:09:35 +01001842 return 1;
1843
1844 return 0; /* blacklisted */
1845}
1846
Linus Torvalds1da177e2005-04-16 15:20:36 -07001847/**
1848 * ata_scsiop_mode_sense - Simulate MODE SENSE 6, 10 commands
1849 * @args: device IDENTIFY data / SCSI command of interest.
1850 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1851 * @buflen: Response buffer length.
1852 *
Douglas Gilbert00ac37f2005-10-28 15:58:28 -04001853 * Simulate MODE SENSE commands. Assume this is invoked for direct
1854 * access devices (e.g. disks) only. There should be no block
1855 * descriptor for other device types.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001856 *
1857 * LOCKING:
1858 * spin_lock_irqsave(host_set lock)
1859 */
1860
1861unsigned int ata_scsiop_mode_sense(struct ata_scsi_args *args, u8 *rbuf,
1862 unsigned int buflen)
1863{
Tejun Heo9a3dccc2006-01-06 09:56:18 +01001864 struct ata_device *dev = args->dev;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001865 u8 *scsicmd = args->cmd->cmnd, *p, *last;
Douglas Gilbert00ac37f2005-10-28 15:58:28 -04001866 const u8 sat_blk_desc[] = {
1867 0, 0, 0, 0, /* number of blocks: sat unspecified */
1868 0,
1869 0, 0x2, 0x0 /* block length: 512 bytes */
1870 };
1871 u8 pg, spg;
1872 unsigned int ebd, page_control, six_byte, output_len, alloc_len, minlen;
Tejun Heo9a3dccc2006-01-06 09:56:18 +01001873 u8 dpofua;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001874
1875 VPRINTK("ENTER\n");
1876
1877 six_byte = (scsicmd[0] == MODE_SENSE);
Douglas Gilbert00ac37f2005-10-28 15:58:28 -04001878 ebd = !(scsicmd[1] & 0x8); /* dbd bit inverted == edb */
1879 /*
1880 * LLBA bit in msense(10) ignored (compliant)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001881 */
Douglas Gilbert00ac37f2005-10-28 15:58:28 -04001882
Linus Torvalds1da177e2005-04-16 15:20:36 -07001883 page_control = scsicmd[2] >> 6;
Douglas Gilbertae006512005-10-09 09:09:35 -04001884 switch (page_control) {
1885 case 0: /* current */
1886 break; /* supported */
1887 case 3: /* saved */
1888 goto saving_not_supp;
1889 case 1: /* changeable */
1890 case 2: /* defaults */
1891 default:
1892 goto invalid_fld;
1893 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001894
Douglas Gilbert00ac37f2005-10-28 15:58:28 -04001895 if (six_byte) {
1896 output_len = 4 + (ebd ? 8 : 0);
1897 alloc_len = scsicmd[4];
1898 } else {
1899 output_len = 8 + (ebd ? 8 : 0);
1900 alloc_len = (scsicmd[7] << 8) + scsicmd[8];
1901 }
1902 minlen = (alloc_len < buflen) ? alloc_len : buflen;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001903
1904 p = rbuf + output_len;
Douglas Gilbert00ac37f2005-10-28 15:58:28 -04001905 last = rbuf + minlen - 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001906
Douglas Gilbert00ac37f2005-10-28 15:58:28 -04001907 pg = scsicmd[2] & 0x3f;
1908 spg = scsicmd[3];
1909 /*
1910 * No mode subpages supported (yet) but asking for _all_
1911 * subpages may be valid
1912 */
1913 if (spg && (spg != ALL_SUB_MPAGES))
1914 goto invalid_fld;
1915
1916 switch(pg) {
1917 case RW_RECOVERY_MPAGE:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001918 output_len += ata_msense_rw_recovery(&p, last);
1919 break;
1920
Douglas Gilbert00ac37f2005-10-28 15:58:28 -04001921 case CACHE_MPAGE:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001922 output_len += ata_msense_caching(args->id, &p, last);
1923 break;
1924
Douglas Gilbert00ac37f2005-10-28 15:58:28 -04001925 case CONTROL_MPAGE: {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001926 output_len += ata_msense_ctl_mode(&p, last);
1927 break;
1928 }
1929
Douglas Gilbert00ac37f2005-10-28 15:58:28 -04001930 case ALL_MPAGES:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001931 output_len += ata_msense_rw_recovery(&p, last);
1932 output_len += ata_msense_caching(args->id, &p, last);
1933 output_len += ata_msense_ctl_mode(&p, last);
1934 break;
1935
1936 default: /* invalid page code */
Douglas Gilbertae006512005-10-09 09:09:35 -04001937 goto invalid_fld;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001938 }
1939
Douglas Gilbert00ac37f2005-10-28 15:58:28 -04001940 if (minlen < 1)
1941 return 0;
Tejun Heo9a3dccc2006-01-06 09:56:18 +01001942
1943 dpofua = 0;
Jens Axboe48bdc8e2006-01-30 16:09:35 +01001944 if (ata_dev_supports_fua(args->id) && dev->flags & ATA_DFLAG_LBA48 &&
Tejun Heo9a3dccc2006-01-06 09:56:18 +01001945 (!(dev->flags & ATA_DFLAG_PIO) || dev->multi_count))
1946 dpofua = 1 << 4;
1947
Linus Torvalds1da177e2005-04-16 15:20:36 -07001948 if (six_byte) {
1949 output_len--;
1950 rbuf[0] = output_len;
Tejun Heo9a3dccc2006-01-06 09:56:18 +01001951 if (minlen > 2)
1952 rbuf[2] |= dpofua;
Douglas Gilbert00ac37f2005-10-28 15:58:28 -04001953 if (ebd) {
1954 if (minlen > 3)
1955 rbuf[3] = sizeof(sat_blk_desc);
1956 if (minlen > 11)
1957 memcpy(rbuf + 4, sat_blk_desc,
1958 sizeof(sat_blk_desc));
1959 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001960 } else {
1961 output_len -= 2;
1962 rbuf[0] = output_len >> 8;
Douglas Gilbert00ac37f2005-10-28 15:58:28 -04001963 if (minlen > 1)
1964 rbuf[1] = output_len;
Tejun Heo9a3dccc2006-01-06 09:56:18 +01001965 if (minlen > 3)
1966 rbuf[3] |= dpofua;
Douglas Gilbert00ac37f2005-10-28 15:58:28 -04001967 if (ebd) {
1968 if (minlen > 7)
1969 rbuf[7] = sizeof(sat_blk_desc);
1970 if (minlen > 15)
1971 memcpy(rbuf + 8, sat_blk_desc,
1972 sizeof(sat_blk_desc));
1973 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001974 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001975 return 0;
Douglas Gilbertae006512005-10-09 09:09:35 -04001976
1977invalid_fld:
1978 ata_scsi_set_sense(args->cmd, ILLEGAL_REQUEST, 0x24, 0x0);
1979 /* "Invalid field in cbd" */
1980 return 1;
1981
1982saving_not_supp:
1983 ata_scsi_set_sense(args->cmd, ILLEGAL_REQUEST, 0x39, 0x0);
1984 /* "Saving parameters not supported" */
1985 return 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001986}
1987
1988/**
1989 * ata_scsiop_read_cap - Simulate READ CAPACITY[ 16] commands
1990 * @args: device IDENTIFY data / SCSI command of interest.
1991 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1992 * @buflen: Response buffer length.
1993 *
1994 * Simulate READ CAPACITY commands.
1995 *
1996 * LOCKING:
1997 * spin_lock_irqsave(host_set lock)
1998 */
1999
2000unsigned int ata_scsiop_read_cap(struct ata_scsi_args *args, u8 *rbuf,
2001 unsigned int buflen)
2002{
2003 u64 n_sectors;
2004 u32 tmp;
2005
2006 VPRINTK("ENTER\n");
2007
Albert Lee8bf62ece2005-05-12 15:29:42 -04002008 if (ata_id_has_lba(args->id)) {
2009 if (ata_id_has_lba48(args->id))
2010 n_sectors = ata_id_u64(args->id, 100);
2011 else
2012 n_sectors = ata_id_u32(args->id, 60);
2013 } else {
2014 /* CHS default translation */
2015 n_sectors = args->id[1] * args->id[3] * args->id[6];
2016
2017 if (ata_id_current_chs_valid(args->id))
2018 /* CHS current translation */
2019 n_sectors = ata_id_u32(args->id, 57);
2020 }
2021
Linus Torvalds1da177e2005-04-16 15:20:36 -07002022 n_sectors--; /* ATA TotalUserSectors - 1 */
2023
Linus Torvalds1da177e2005-04-16 15:20:36 -07002024 if (args->cmd->cmnd[0] == READ_CAPACITY) {
Philip Pokorny0c144d02005-05-28 01:24:47 -07002025 if( n_sectors >= 0xffffffffULL )
2026 tmp = 0xffffffff ; /* Return max count on overflow */
2027 else
2028 tmp = n_sectors ;
2029
Linus Torvalds1da177e2005-04-16 15:20:36 -07002030 /* sector count, 32-bit */
2031 rbuf[0] = tmp >> (8 * 3);
2032 rbuf[1] = tmp >> (8 * 2);
2033 rbuf[2] = tmp >> (8 * 1);
2034 rbuf[3] = tmp;
2035
2036 /* sector size */
2037 tmp = ATA_SECT_SIZE;
2038 rbuf[6] = tmp >> 8;
2039 rbuf[7] = tmp;
2040
2041 } else {
2042 /* sector count, 64-bit */
Philip Pokorny0c144d02005-05-28 01:24:47 -07002043 tmp = n_sectors >> (8 * 4);
2044 rbuf[2] = tmp >> (8 * 3);
2045 rbuf[3] = tmp >> (8 * 2);
2046 rbuf[4] = tmp >> (8 * 1);
2047 rbuf[5] = tmp;
2048 tmp = n_sectors;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002049 rbuf[6] = tmp >> (8 * 3);
2050 rbuf[7] = tmp >> (8 * 2);
2051 rbuf[8] = tmp >> (8 * 1);
2052 rbuf[9] = tmp;
2053
2054 /* sector size */
2055 tmp = ATA_SECT_SIZE;
2056 rbuf[12] = tmp >> 8;
2057 rbuf[13] = tmp;
2058 }
2059
2060 return 0;
2061}
2062
2063/**
2064 * ata_scsiop_report_luns - Simulate REPORT LUNS command
2065 * @args: device IDENTIFY data / SCSI command of interest.
2066 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2067 * @buflen: Response buffer length.
2068 *
2069 * Simulate REPORT LUNS command.
2070 *
2071 * LOCKING:
2072 * spin_lock_irqsave(host_set lock)
2073 */
2074
2075unsigned int ata_scsiop_report_luns(struct ata_scsi_args *args, u8 *rbuf,
2076 unsigned int buflen)
2077{
2078 VPRINTK("ENTER\n");
2079 rbuf[3] = 8; /* just one lun, LUN 0, size 8 bytes */
2080
2081 return 0;
2082}
2083
2084/**
Douglas Gilbert845c5832005-10-09 08:55:41 -04002085 * ata_scsi_set_sense - Set SCSI sense data and status
2086 * @cmd: SCSI request to be handled
2087 * @sk: SCSI-defined sense key
2088 * @asc: SCSI-defined additional sense code
2089 * @ascq: SCSI-defined additional sense code qualifier
2090 *
2091 * Helper function that builds a valid fixed format, current
2092 * response code and the given sense key (sk), additional sense
2093 * code (asc) and additional sense code qualifier (ascq) with
2094 * a SCSI command status of %SAM_STAT_CHECK_CONDITION and
2095 * DRIVER_SENSE set in the upper bits of scsi_cmnd::result .
2096 *
2097 * LOCKING:
2098 * Not required
2099 */
2100
2101void ata_scsi_set_sense(struct scsi_cmnd *cmd, u8 sk, u8 asc, u8 ascq)
2102{
2103 cmd->result = (DRIVER_SENSE << 24) | SAM_STAT_CHECK_CONDITION;
2104
2105 cmd->sense_buffer[0] = 0x70; /* fixed format, current */
2106 cmd->sense_buffer[2] = sk;
2107 cmd->sense_buffer[7] = 18 - 8; /* additional sense length */
2108 cmd->sense_buffer[12] = asc;
2109 cmd->sense_buffer[13] = ascq;
2110}
2111
2112/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07002113 * ata_scsi_badcmd - End a SCSI request with an error
2114 * @cmd: SCSI request to be handled
2115 * @done: SCSI command completion function
2116 * @asc: SCSI-defined additional sense code
2117 * @ascq: SCSI-defined additional sense code qualifier
2118 *
2119 * Helper function that completes a SCSI command with
2120 * %SAM_STAT_CHECK_CONDITION, with a sense key %ILLEGAL_REQUEST
2121 * and the specified additional sense codes.
2122 *
2123 * LOCKING:
2124 * spin_lock_irqsave(host_set lock)
2125 */
2126
2127void ata_scsi_badcmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *), u8 asc, u8 ascq)
2128{
2129 DPRINTK("ENTER\n");
Douglas Gilbertae006512005-10-09 09:09:35 -04002130 ata_scsi_set_sense(cmd, ILLEGAL_REQUEST, asc, ascq);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002131
2132 done(cmd);
2133}
2134
Tejun Heo77853bf2006-01-23 13:09:36 +09002135static void atapi_sense_complete(struct ata_queued_cmd *qc)
Jeff Garzika939c962005-10-05 17:09:16 -04002136{
Albert Leea22e2eb2005-12-05 15:38:02 +08002137 if (qc->err_mask && ((qc->err_mask & AC_ERR_DEV) == 0))
Jeff Garzikc6e6e6662005-11-14 14:50:05 -05002138 /* FIXME: not quite right; we don't want the
2139 * translation of taskfile registers into
2140 * a sense descriptors, since that's only
2141 * correct for ATA, not ATAPI
2142 */
2143 ata_gen_ata_desc_sense(qc);
2144
2145 qc->scsidone(qc->scsicmd);
Tejun Heo77853bf2006-01-23 13:09:36 +09002146 ata_qc_free(qc);
Jeff Garzikc6e6e6662005-11-14 14:50:05 -05002147}
2148
2149/* is it pointless to prefer PIO for "safety reasons"? */
2150static inline int ata_pio_use_silly(struct ata_port *ap)
2151{
2152 return (ap->flags & ATA_FLAG_PIO_DMA);
2153}
2154
2155static void atapi_request_sense(struct ata_queued_cmd *qc)
2156{
2157 struct ata_port *ap = qc->ap;
2158 struct scsi_cmnd *cmd = qc->scsicmd;
Jeff Garzika939c962005-10-05 17:09:16 -04002159
2160 DPRINTK("ATAPI request sense\n");
2161
Jeff Garzika939c962005-10-05 17:09:16 -04002162 /* FIXME: is this needed? */
2163 memset(cmd->sense_buffer, 0, sizeof(cmd->sense_buffer));
2164
Jeff Garzikc6e6e6662005-11-14 14:50:05 -05002165 ap->ops->tf_read(ap, &qc->tf);
2166
2167 /* fill these in, for the case where they are -not- overwritten */
2168 cmd->sense_buffer[0] = 0x70;
2169 cmd->sense_buffer[2] = qc->tf.feature >> 4;
2170
2171 ata_qc_reinit(qc);
2172
Jeff Garzika939c962005-10-05 17:09:16 -04002173 ata_sg_init_one(qc, cmd->sense_buffer, sizeof(cmd->sense_buffer));
2174 qc->dma_dir = DMA_FROM_DEVICE;
2175
Tejun Heo6e7846e2006-02-12 23:32:58 +09002176 memset(&qc->cdb, 0, qc->dev->cdb_len);
Jeff Garzika939c962005-10-05 17:09:16 -04002177 qc->cdb[0] = REQUEST_SENSE;
2178 qc->cdb[4] = SCSI_SENSE_BUFFERSIZE;
2179
2180 qc->tf.flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
2181 qc->tf.command = ATA_CMD_PACKET;
2182
Jeff Garzikc6e6e6662005-11-14 14:50:05 -05002183 if (ata_pio_use_silly(ap)) {
2184 qc->tf.protocol = ATA_PROT_ATAPI_DMA;
2185 qc->tf.feature |= ATAPI_PKT_DMA;
2186 } else {
2187 qc->tf.protocol = ATA_PROT_ATAPI;
2188 qc->tf.lbam = (8 * 1024) & 0xff;
2189 qc->tf.lbah = (8 * 1024) >> 8;
2190 }
Jeff Garzika939c962005-10-05 17:09:16 -04002191 qc->nbytes = SCSI_SENSE_BUFFERSIZE;
2192
Jeff Garzikc6e6e6662005-11-14 14:50:05 -05002193 qc->complete_fn = atapi_sense_complete;
Jeff Garzika939c962005-10-05 17:09:16 -04002194
Tejun Heo9a3d9eb2006-01-23 13:09:36 +09002195 qc->err_mask = ata_qc_issue(qc);
2196 if (qc->err_mask)
Albert Leea22e2eb2005-12-05 15:38:02 +08002197 ata_qc_complete(qc);
Jeff Garzika939c962005-10-05 17:09:16 -04002198
2199 DPRINTK("EXIT\n");
2200}
2201
Tejun Heo77853bf2006-01-23 13:09:36 +09002202static void atapi_qc_complete(struct ata_queued_cmd *qc)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002203{
2204 struct scsi_cmnd *cmd = qc->scsicmd;
Albert Leea22e2eb2005-12-05 15:38:02 +08002205 unsigned int err_mask = qc->err_mask;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002206
Jeff Garzika7dac442005-10-30 04:44:42 -05002207 VPRINTK("ENTER, err_mask 0x%X\n", err_mask);
Jeff Garzike12669e2005-10-05 18:39:23 -04002208
Jeff Garzika7dac442005-10-30 04:44:42 -05002209 if (unlikely(err_mask & AC_ERR_DEV)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002210 cmd->result = SAM_STAT_CHECK_CONDITION;
Jeff Garzikc6e6e6662005-11-14 14:50:05 -05002211 atapi_request_sense(qc);
Tejun Heo77853bf2006-01-23 13:09:36 +09002212 return;
Jeff Garzike12669e2005-10-05 18:39:23 -04002213 }
2214
Jeff Garzika7dac442005-10-30 04:44:42 -05002215 else if (unlikely(err_mask))
2216 /* FIXME: not quite right; we don't want the
2217 * translation of taskfile registers into
2218 * a sense descriptors, since that's only
2219 * correct for ATA, not ATAPI
2220 */
2221 ata_gen_ata_desc_sense(qc);
2222
Jeff Garzike12669e2005-10-05 18:39:23 -04002223 else {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002224 u8 *scsicmd = cmd->cmnd;
2225
Tony Battersbyfd71da42005-12-21 16:35:44 -05002226 if ((scsicmd[0] == INQUIRY) && ((scsicmd[1] & 0x03) == 0)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002227 u8 *buf = NULL;
2228 unsigned int buflen;
2229
2230 buflen = ata_scsi_rbuf_get(cmd, &buf);
Jeff Garzika15dbeb2005-10-05 15:02:14 -04002231
2232 /* ATAPI devices typically report zero for their SCSI version,
2233 * and sometimes deviate from the spec WRT response data
2234 * format. If SCSI version is reported as zero like normal,
2235 * then we make the following fixups: 1) Fake MMC-5 version,
2236 * to indicate to the Linux scsi midlayer this is a modern
2237 * device. 2) Ensure response data format / ATAPI information
2238 * are always correct.
2239 */
Jeff Garzika15dbeb2005-10-05 15:02:14 -04002240 if (buf[2] == 0) {
2241 buf[2] = 0x5;
2242 buf[3] = 0x32;
2243 }
2244
Linus Torvalds1da177e2005-04-16 15:20:36 -07002245 ata_scsi_rbuf_put(cmd, buf);
2246 }
Jeff Garzika15dbeb2005-10-05 15:02:14 -04002247
Linus Torvalds1da177e2005-04-16 15:20:36 -07002248 cmd->result = SAM_STAT_GOOD;
2249 }
2250
2251 qc->scsidone(cmd);
Tejun Heo77853bf2006-01-23 13:09:36 +09002252 ata_qc_free(qc);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002253}
2254/**
2255 * atapi_xlat - Initialize PACKET taskfile
2256 * @qc: command structure to be initialized
2257 * @scsicmd: SCSI CDB associated with this PACKET command
2258 *
2259 * LOCKING:
2260 * spin_lock_irqsave(host_set lock)
2261 *
2262 * RETURNS:
2263 * Zero on success, non-zero on failure.
2264 */
2265
Jeff Garzik057ace52005-10-22 14:27:05 -04002266static unsigned int atapi_xlat(struct ata_queued_cmd *qc, const u8 *scsicmd)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002267{
2268 struct scsi_cmnd *cmd = qc->scsicmd;
2269 struct ata_device *dev = qc->dev;
2270 int using_pio = (dev->flags & ATA_DFLAG_PIO);
be7db052005-04-17 15:26:13 -05002271 int nodata = (cmd->sc_data_direction == DMA_NONE);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002272
2273 if (!using_pio)
2274 /* Check whether ATAPI DMA is safe */
2275 if (ata_check_atapi_dma(qc))
2276 using_pio = 1;
2277
Tejun Heo6e7846e2006-02-12 23:32:58 +09002278 memcpy(&qc->cdb, scsicmd, dev->cdb_len);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002279
2280 qc->complete_fn = atapi_qc_complete;
2281
2282 qc->tf.flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
be7db052005-04-17 15:26:13 -05002283 if (cmd->sc_data_direction == DMA_TO_DEVICE) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002284 qc->tf.flags |= ATA_TFLAG_WRITE;
2285 DPRINTK("direction: write\n");
2286 }
2287
2288 qc->tf.command = ATA_CMD_PACKET;
2289
2290 /* no data, or PIO data xfer */
2291 if (using_pio || nodata) {
2292 if (nodata)
2293 qc->tf.protocol = ATA_PROT_ATAPI_NODATA;
2294 else
2295 qc->tf.protocol = ATA_PROT_ATAPI;
2296 qc->tf.lbam = (8 * 1024) & 0xff;
2297 qc->tf.lbah = (8 * 1024) >> 8;
2298 }
2299
2300 /* DMA data xfer */
2301 else {
2302 qc->tf.protocol = ATA_PROT_ATAPI_DMA;
2303 qc->tf.feature |= ATAPI_PKT_DMA;
2304
2305#ifdef ATAPI_ENABLE_DMADIR
2306 /* some SATA bridges need us to indicate data xfer direction */
be7db052005-04-17 15:26:13 -05002307 if (cmd->sc_data_direction != DMA_TO_DEVICE)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002308 qc->tf.feature |= ATAPI_DMADIR;
2309#endif
2310 }
2311
2312 qc->nbytes = cmd->bufflen;
2313
2314 return 0;
2315}
2316
2317/**
2318 * ata_scsi_find_dev - lookup ata_device from scsi_cmnd
2319 * @ap: ATA port to which the device is attached
2320 * @scsidev: SCSI device from which we derive the ATA device
2321 *
2322 * Given various information provided in struct scsi_cmnd,
2323 * map that onto an ATA bus, and using that mapping
2324 * determine which ata_device is associated with the
2325 * SCSI command to be sent.
2326 *
2327 * LOCKING:
2328 * spin_lock_irqsave(host_set lock)
2329 *
2330 * RETURNS:
2331 * Associated ATA device, or %NULL if not found.
2332 */
2333
2334static struct ata_device *
Jeff Garzik057ace52005-10-22 14:27:05 -04002335ata_scsi_find_dev(struct ata_port *ap, const struct scsi_device *scsidev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002336{
2337 struct ata_device *dev;
2338
2339 /* skip commands not addressed to targets we simulate */
2340 if (likely(scsidev->id < ATA_MAX_DEVICES))
2341 dev = &ap->device[scsidev->id];
2342 else
2343 return NULL;
2344
2345 if (unlikely((scsidev->channel != 0) ||
2346 (scsidev->lun != 0)))
2347 return NULL;
2348
2349 if (unlikely(!ata_dev_present(dev)))
2350 return NULL;
2351
Jeff Garzik50630192005-12-13 02:29:45 -05002352 if (!atapi_enabled || (ap->flags & ATA_FLAG_NO_ATAPI)) {
2353 if (unlikely(dev->class == ATA_DEV_ATAPI)) {
2354 printk(KERN_WARNING "ata%u(%u): WARNING: ATAPI is %s, device ignored.\n",
2355 ap->id, dev->devno, atapi_enabled ? "not supported with this driver" : "disabled");
Jeff Garzik1623c812005-08-30 03:37:42 -04002356 return NULL;
Jeff Garzik50630192005-12-13 02:29:45 -05002357 }
Jeff Garzik1623c812005-08-30 03:37:42 -04002358 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002359
2360 return dev;
2361}
2362
Jeff Garzikb0955182005-05-12 15:45:22 -04002363/*
2364 * ata_scsi_map_proto - Map pass-thru protocol value to taskfile value.
2365 * @byte1: Byte 1 from pass-thru CDB.
2366 *
2367 * RETURNS:
2368 * ATA_PROT_UNKNOWN if mapping failed/unimplemented, protocol otherwise.
2369 */
2370static u8
2371ata_scsi_map_proto(u8 byte1)
2372{
2373 switch((byte1 & 0x1e) >> 1) {
2374 case 3: /* Non-data */
2375 return ATA_PROT_NODATA;
2376
2377 case 6: /* DMA */
2378 return ATA_PROT_DMA;
2379
2380 case 4: /* PIO Data-in */
2381 case 5: /* PIO Data-out */
2382 if (byte1 & 0xe0) {
2383 return ATA_PROT_PIO_MULT;
2384 }
2385 return ATA_PROT_PIO;
2386
2387 case 10: /* Device Reset */
2388 case 0: /* Hard Reset */
2389 case 1: /* SRST */
2390 case 2: /* Bus Idle */
2391 case 7: /* Packet */
2392 case 8: /* DMA Queued */
2393 case 9: /* Device Diagnostic */
2394 case 11: /* UDMA Data-in */
2395 case 12: /* UDMA Data-Out */
2396 case 13: /* FPDMA */
2397 default: /* Reserved */
2398 break;
2399 }
2400
2401 return ATA_PROT_UNKNOWN;
2402}
2403
2404/**
2405 * ata_scsi_pass_thru - convert ATA pass-thru CDB to taskfile
2406 * @qc: command structure to be initialized
Randy Dunlap8e8b77d2005-11-01 21:29:27 -08002407 * @scsicmd: SCSI command to convert
Jeff Garzikb0955182005-05-12 15:45:22 -04002408 *
2409 * Handles either 12 or 16-byte versions of the CDB.
2410 *
2411 * RETURNS:
2412 * Zero on success, non-zero on failure.
2413 */
2414static unsigned int
Douglas Gilbert00ac37f2005-10-28 15:58:28 -04002415ata_scsi_pass_thru(struct ata_queued_cmd *qc, const u8 *scsicmd)
Jeff Garzikb0955182005-05-12 15:45:22 -04002416{
2417 struct ata_taskfile *tf = &(qc->tf);
2418 struct scsi_cmnd *cmd = qc->scsicmd;
2419
2420 if ((tf->protocol = ata_scsi_map_proto(scsicmd[1])) == ATA_PROT_UNKNOWN)
Tejun Heo9a405252005-12-02 11:49:11 +09002421 goto invalid_fld;
Jeff Garzikb0955182005-05-12 15:45:22 -04002422
2423 /*
2424 * 12 and 16 byte CDBs use different offsets to
2425 * provide the various register values.
2426 */
2427 if (scsicmd[0] == ATA_16) {
2428 /*
2429 * 16-byte CDB - may contain extended commands.
2430 *
2431 * If that is the case, copy the upper byte register values.
2432 */
2433 if (scsicmd[1] & 0x01) {
2434 tf->hob_feature = scsicmd[3];
2435 tf->hob_nsect = scsicmd[5];
2436 tf->hob_lbal = scsicmd[7];
2437 tf->hob_lbam = scsicmd[9];
2438 tf->hob_lbah = scsicmd[11];
2439 tf->flags |= ATA_TFLAG_LBA48;
2440 } else
2441 tf->flags &= ~ATA_TFLAG_LBA48;
2442
2443 /*
2444 * Always copy low byte, device and command registers.
2445 */
2446 tf->feature = scsicmd[4];
2447 tf->nsect = scsicmd[6];
2448 tf->lbal = scsicmd[8];
2449 tf->lbam = scsicmd[10];
2450 tf->lbah = scsicmd[12];
2451 tf->device = scsicmd[13];
2452 tf->command = scsicmd[14];
2453 } else {
2454 /*
2455 * 12-byte CDB - incapable of extended commands.
2456 */
2457 tf->flags &= ~ATA_TFLAG_LBA48;
2458
2459 tf->feature = scsicmd[3];
2460 tf->nsect = scsicmd[4];
2461 tf->lbal = scsicmd[5];
2462 tf->lbam = scsicmd[6];
2463 tf->lbah = scsicmd[7];
2464 tf->device = scsicmd[8];
2465 tf->command = scsicmd[9];
2466 }
Mark Lorddcc2d1e2005-11-13 16:22:06 -05002467 /*
2468 * If slave is possible, enforce correct master/slave bit
2469 */
2470 if (qc->ap->flags & ATA_FLAG_SLAVE_POSS)
2471 tf->device = qc->dev->devno ?
2472 tf->device | ATA_DEV1 : tf->device & ~ATA_DEV1;
Jeff Garzikb0955182005-05-12 15:45:22 -04002473
2474 /*
2475 * Filter SET_FEATURES - XFER MODE command -- otherwise,
2476 * SET_FEATURES - XFER MODE must be preceded/succeeded
2477 * by an update to hardware-specific registers for each
2478 * controller (i.e. the reason for ->set_piomode(),
2479 * ->set_dmamode(), and ->post_set_mode() hooks).
2480 */
2481 if ((tf->command == ATA_CMD_SET_FEATURES)
2482 && (tf->feature == SETFEATURES_XFER))
Tejun Heo9a405252005-12-02 11:49:11 +09002483 goto invalid_fld;
Jeff Garzikb0955182005-05-12 15:45:22 -04002484
2485 /*
2486 * Set flags so that all registers will be written,
2487 * and pass on write indication (used for PIO/DMA
2488 * setup.)
2489 */
2490 tf->flags |= (ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE);
2491
Jeff Garzik0274aa22005-06-22 13:50:56 -04002492 if (cmd->sc_data_direction == DMA_TO_DEVICE)
Jeff Garzikb0955182005-05-12 15:45:22 -04002493 tf->flags |= ATA_TFLAG_WRITE;
2494
2495 /*
2496 * Set transfer length.
2497 *
2498 * TODO: find out if we need to do more here to
2499 * cover scatter/gather case.
2500 */
2501 qc->nsect = cmd->bufflen / ATA_SECT_SIZE;
2502
2503 return 0;
Tejun Heo9a405252005-12-02 11:49:11 +09002504
2505 invalid_fld:
2506 ata_scsi_set_sense(qc->scsicmd, ILLEGAL_REQUEST, 0x24, 0x00);
2507 /* "Invalid field in cdb" */
2508 return 1;
Jeff Garzikb0955182005-05-12 15:45:22 -04002509}
2510
Linus Torvalds1da177e2005-04-16 15:20:36 -07002511/**
2512 * ata_get_xlat_func - check if SCSI to ATA translation is possible
2513 * @dev: ATA device
2514 * @cmd: SCSI command opcode to consider
2515 *
2516 * Look up the SCSI command given, and determine whether the
2517 * SCSI command is to be translated or simulated.
2518 *
2519 * RETURNS:
2520 * Pointer to translation function if possible, %NULL if not.
2521 */
2522
2523static inline ata_xlat_func_t ata_get_xlat_func(struct ata_device *dev, u8 cmd)
2524{
2525 switch (cmd) {
2526 case READ_6:
2527 case READ_10:
2528 case READ_16:
2529
2530 case WRITE_6:
2531 case WRITE_10:
2532 case WRITE_16:
2533 return ata_scsi_rw_xlat;
2534
2535 case SYNCHRONIZE_CACHE:
2536 if (ata_try_flush_cache(dev))
2537 return ata_scsi_flush_xlat;
2538 break;
2539
2540 case VERIFY:
2541 case VERIFY_16:
2542 return ata_scsi_verify_xlat;
Jeff Garzikb0955182005-05-12 15:45:22 -04002543
2544 case ATA_12:
2545 case ATA_16:
2546 return ata_scsi_pass_thru;
Jeff Garzikda613962005-08-29 19:01:43 -04002547
Douglas Gilbert972dcaf2005-08-11 03:35:53 -04002548 case START_STOP:
2549 return ata_scsi_start_stop_xlat;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002550 }
2551
2552 return NULL;
2553}
2554
2555/**
2556 * ata_scsi_dump_cdb - dump SCSI command contents to dmesg
2557 * @ap: ATA port to which the command was being sent
2558 * @cmd: SCSI command to dump
2559 *
2560 * Prints the contents of a SCSI command via printk().
2561 */
2562
2563static inline void ata_scsi_dump_cdb(struct ata_port *ap,
2564 struct scsi_cmnd *cmd)
2565{
2566#ifdef ATA_DEBUG
2567 struct scsi_device *scsidev = cmd->device;
2568 u8 *scsicmd = cmd->cmnd;
2569
2570 DPRINTK("CDB (%u:%d,%d,%d) %02x %02x %02x %02x %02x %02x %02x %02x %02x\n",
2571 ap->id,
2572 scsidev->channel, scsidev->id, scsidev->lun,
2573 scsicmd[0], scsicmd[1], scsicmd[2], scsicmd[3],
2574 scsicmd[4], scsicmd[5], scsicmd[6], scsicmd[7],
2575 scsicmd[8]);
2576#endif
2577}
2578
2579/**
2580 * ata_scsi_queuecmd - Issue SCSI cdb to libata-managed device
2581 * @cmd: SCSI command to be sent
2582 * @done: Completion function, called when command is complete
2583 *
2584 * In some cases, this function translates SCSI commands into
2585 * ATA taskfiles, and queues the taskfiles to be sent to
2586 * hardware. In other cases, this function simulates a
2587 * SCSI device by evaluating and responding to certain
2588 * SCSI commands. This creates the overall effect of
2589 * ATA and ATAPI devices appearing as SCSI devices.
2590 *
2591 * LOCKING:
2592 * Releases scsi-layer-held lock, and obtains host_set lock.
2593 *
2594 * RETURNS:
2595 * Zero.
2596 */
2597
2598int ata_scsi_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *))
2599{
2600 struct ata_port *ap;
2601 struct ata_device *dev;
2602 struct scsi_device *scsidev = cmd->device;
Jeff Garzik005a5a02005-10-30 23:31:48 -05002603 struct Scsi_Host *shost = scsidev->host;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002604
Jeff Garzik005a5a02005-10-30 23:31:48 -05002605 ap = (struct ata_port *) &shost->hostdata[0];
2606
2607 spin_unlock(shost->host_lock);
2608 spin_lock(&ap->host_set->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002609
2610 ata_scsi_dump_cdb(ap, cmd);
2611
2612 dev = ata_scsi_find_dev(ap, scsidev);
2613 if (unlikely(!dev)) {
2614 cmd->result = (DID_BAD_TARGET << 16);
2615 done(cmd);
2616 goto out_unlock;
2617 }
2618
2619 if (dev->class == ATA_DEV_ATA) {
2620 ata_xlat_func_t xlat_func = ata_get_xlat_func(dev,
2621 cmd->cmnd[0]);
2622
2623 if (xlat_func)
2624 ata_scsi_translate(ap, dev, cmd, done, xlat_func);
2625 else
Tejun Heo9a3dccc2006-01-06 09:56:18 +01002626 ata_scsi_simulate(ap, dev, cmd, done);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002627 } else
2628 ata_scsi_translate(ap, dev, cmd, done, atapi_xlat);
2629
2630out_unlock:
Jeff Garzik005a5a02005-10-30 23:31:48 -05002631 spin_unlock(&ap->host_set->lock);
2632 spin_lock(shost->host_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002633 return 0;
2634}
2635
2636/**
2637 * ata_scsi_simulate - simulate SCSI command on ATA device
Randy Dunlapc893a3a2006-01-28 13:15:32 -05002638 * @ap: port the device is connected to
2639 * @dev: the target device
Linus Torvalds1da177e2005-04-16 15:20:36 -07002640 * @cmd: SCSI command being sent to device.
2641 * @done: SCSI command completion function.
2642 *
2643 * Interprets and directly executes a select list of SCSI commands
2644 * that can be handled internally.
2645 *
2646 * LOCKING:
2647 * spin_lock_irqsave(host_set lock)
2648 */
2649
Tejun Heo9a3dccc2006-01-06 09:56:18 +01002650void ata_scsi_simulate(struct ata_port *ap, struct ata_device *dev,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002651 struct scsi_cmnd *cmd,
2652 void (*done)(struct scsi_cmnd *))
2653{
2654 struct ata_scsi_args args;
Jeff Garzik057ace52005-10-22 14:27:05 -04002655 const u8 *scsicmd = cmd->cmnd;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002656
Tejun Heo9a3dccc2006-01-06 09:56:18 +01002657 args.ap = ap;
2658 args.dev = dev;
2659 args.id = dev->id;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002660 args.cmd = cmd;
2661 args.done = done;
2662
2663 switch(scsicmd[0]) {
2664 /* no-op's, complete with success */
2665 case SYNCHRONIZE_CACHE:
2666 case REZERO_UNIT:
2667 case SEEK_6:
2668 case SEEK_10:
2669 case TEST_UNIT_READY:
2670 case FORMAT_UNIT: /* FIXME: correct? */
2671 case SEND_DIAGNOSTIC: /* FIXME: correct? */
2672 ata_scsi_rbuf_fill(&args, ata_scsiop_noop);
2673 break;
2674
2675 case INQUIRY:
2676 if (scsicmd[1] & 2) /* is CmdDt set? */
Douglas Gilbertae006512005-10-09 09:09:35 -04002677 ata_scsi_invalid_field(cmd, done);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002678 else if ((scsicmd[1] & 1) == 0) /* is EVPD clear? */
2679 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_std);
2680 else if (scsicmd[2] == 0x00)
2681 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_00);
2682 else if (scsicmd[2] == 0x80)
2683 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_80);
2684 else if (scsicmd[2] == 0x83)
2685 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_83);
2686 else
Douglas Gilbertae006512005-10-09 09:09:35 -04002687 ata_scsi_invalid_field(cmd, done);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002688 break;
2689
2690 case MODE_SENSE:
2691 case MODE_SENSE_10:
2692 ata_scsi_rbuf_fill(&args, ata_scsiop_mode_sense);
2693 break;
2694
2695 case MODE_SELECT: /* unconditionally return */
2696 case MODE_SELECT_10: /* bad-field-in-cdb */
Douglas Gilbertae006512005-10-09 09:09:35 -04002697 ata_scsi_invalid_field(cmd, done);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002698 break;
2699
2700 case READ_CAPACITY:
2701 ata_scsi_rbuf_fill(&args, ata_scsiop_read_cap);
2702 break;
2703
2704 case SERVICE_ACTION_IN:
2705 if ((scsicmd[1] & 0x1f) == SAI_READ_CAPACITY_16)
2706 ata_scsi_rbuf_fill(&args, ata_scsiop_read_cap);
2707 else
Douglas Gilbertae006512005-10-09 09:09:35 -04002708 ata_scsi_invalid_field(cmd, done);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002709 break;
2710
2711 case REPORT_LUNS:
2712 ata_scsi_rbuf_fill(&args, ata_scsiop_report_luns);
2713 break;
2714
Jeff Garzikb0955182005-05-12 15:45:22 -04002715 /* mandatory commands we haven't implemented yet */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002716 case REQUEST_SENSE:
2717
2718 /* all other commands */
2719 default:
Douglas Gilbertae006512005-10-09 09:09:35 -04002720 ata_scsi_set_sense(cmd, ILLEGAL_REQUEST, 0x20, 0x0);
2721 /* "Invalid command operation code" */
2722 done(cmd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002723 break;
2724 }
2725}
2726
Jeff Garzik644dd0c2005-10-03 15:55:19 -04002727void ata_scsi_scan_host(struct ata_port *ap)
2728{
Jeff Garzik3f19ee82005-10-03 21:36:41 -04002729 struct ata_device *dev;
Jeff Garzik644dd0c2005-10-03 15:55:19 -04002730 unsigned int i;
2731
2732 if (ap->flags & ATA_FLAG_PORT_DISABLED)
2733 return;
2734
Jeff Garzik3f19ee82005-10-03 21:36:41 -04002735 for (i = 0; i < ATA_MAX_DEVICES; i++) {
2736 dev = &ap->device[i];
2737
2738 if (ata_dev_present(dev))
2739 scsi_scan_target(&ap->host->shost_gendev, 0, i, 0, 0);
2740 }
Jeff Garzik644dd0c2005-10-03 15:55:19 -04002741}
2742