blob: dd954a23b357a17ab4870b14954039b2e472dfba [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
Alan Cox2d202022006-03-21 15:53:46 +0000514 /* We need a sensible error return here, which is tricky, and one
515 that won't cause people to do things like return a disk wrongly */
516 *sk = ABORTED_COMMAND;
517 *asc = 0x00;
518 *ascq = 0x00;
Jeff Garzikb0955182005-05-12 15:45:22 -0400519
520 translate_done:
521 printk(KERN_ERR "ata%u: translated ATA stat/err 0x%02x/%02x to "
522 "SCSI SK/ASC/ASCQ 0x%x/%02x/%02x\n", id, drv_stat, drv_err,
523 *sk, *asc, *ascq);
524 return;
525}
526
527/*
528 * ata_gen_ata_desc_sense - Generate check condition sense block.
529 * @qc: Command that completed.
530 *
531 * This function is specific to the ATA descriptor format sense
532 * block specified for the ATA pass through commands. Regardless
533 * of whether the command errored or not, return a sense
534 * block. Copy all controller registers into the sense
535 * block. Clear sense key, ASC & ASCQ if there is no error.
536 *
537 * LOCKING:
538 * spin_lock_irqsave(host_set lock)
539 */
540void ata_gen_ata_desc_sense(struct ata_queued_cmd *qc)
541{
542 struct scsi_cmnd *cmd = qc->scsicmd;
543 struct ata_taskfile *tf = &qc->tf;
544 unsigned char *sb = cmd->sense_buffer;
545 unsigned char *desc = sb + 8;
546
547 memset(sb, 0, SCSI_SENSE_BUFFERSIZE);
548
Jeff Garzik0e5dec42005-10-06 09:40:20 -0400549 cmd->result = (DRIVER_SENSE << 24) | SAM_STAT_CHECK_CONDITION;
Jeff Garzikb0955182005-05-12 15:45:22 -0400550
551 /*
552 * Read the controller registers.
553 */
Tejun Heoa46314742006-02-11 19:11:13 +0900554 WARN_ON(qc->ap->ops->tf_read == NULL);
Jeff Garzikb0955182005-05-12 15:45:22 -0400555 qc->ap->ops->tf_read(qc->ap, tf);
556
557 /*
558 * Use ata_to_sense_error() to map status register bits
559 * onto sense key, asc & ascq.
560 */
Jeff Garzika7dac442005-10-30 04:44:42 -0500561 if (tf->command & (ATA_BUSY | ATA_DF | ATA_ERR | ATA_DRQ)) {
Jeff Garzikb0955182005-05-12 15:45:22 -0400562 ata_to_sense_error(qc->ap->id, tf->command, tf->feature,
563 &sb[1], &sb[2], &sb[3]);
564 sb[1] &= 0x0f;
565 }
566
567 /*
568 * Sense data is current and format is descriptor.
569 */
570 sb[0] = 0x72;
571
572 desc[0] = 0x09;
573
574 /*
575 * Set length of additional sense data.
576 * Since we only populate descriptor 0, the total
577 * length is the same (fixed) length as descriptor 0.
578 */
579 desc[1] = sb[7] = 14;
580
581 /*
582 * Copy registers into sense buffer.
583 */
584 desc[2] = 0x00;
585 desc[3] = tf->feature; /* == error reg */
586 desc[5] = tf->nsect;
587 desc[7] = tf->lbal;
588 desc[9] = tf->lbam;
589 desc[11] = tf->lbah;
590 desc[12] = tf->device;
591 desc[13] = tf->command; /* == status reg */
592
593 /*
594 * Fill in Extend bit, and the high order bytes
595 * if applicable.
596 */
597 if (tf->flags & ATA_TFLAG_LBA48) {
598 desc[2] |= 0x01;
599 desc[4] = tf->hob_nsect;
600 desc[6] = tf->hob_lbal;
601 desc[8] = tf->hob_lbam;
602 desc[10] = tf->hob_lbah;
603 }
604}
605
606/**
607 * ata_gen_fixed_sense - generate a SCSI fixed sense block
608 * @qc: Command that we are erroring out
609 *
610 * Leverage ata_to_sense_error() to give us the codes. Fit our
611 * LBA in here if there's room.
612 *
613 * LOCKING:
614 * inherited from caller
615 */
616void ata_gen_fixed_sense(struct ata_queued_cmd *qc)
617{
618 struct scsi_cmnd *cmd = qc->scsicmd;
619 struct ata_taskfile *tf = &qc->tf;
620 unsigned char *sb = cmd->sense_buffer;
621
622 memset(sb, 0, SCSI_SENSE_BUFFERSIZE);
623
Jeff Garzik0e5dec42005-10-06 09:40:20 -0400624 cmd->result = (DRIVER_SENSE << 24) | SAM_STAT_CHECK_CONDITION;
Jeff Garzikb0955182005-05-12 15:45:22 -0400625
626 /*
627 * Read the controller registers.
628 */
Tejun Heoa46314742006-02-11 19:11:13 +0900629 WARN_ON(qc->ap->ops->tf_read == NULL);
Jeff Garzikb0955182005-05-12 15:45:22 -0400630 qc->ap->ops->tf_read(qc->ap, tf);
631
632 /*
633 * Use ata_to_sense_error() to map status register bits
634 * onto sense key, asc & ascq.
635 */
Jeff Garzika7dac442005-10-30 04:44:42 -0500636 if (tf->command & (ATA_BUSY | ATA_DF | ATA_ERR | ATA_DRQ)) {
Jeff Garzikb0955182005-05-12 15:45:22 -0400637 ata_to_sense_error(qc->ap->id, tf->command, tf->feature,
638 &sb[2], &sb[12], &sb[13]);
639 sb[2] &= 0x0f;
640 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700641
642 sb[0] = 0x70;
Jeff Garzikb0955182005-05-12 15:45:22 -0400643 sb[7] = 0x0a;
Jeff Garzik0274aa22005-06-22 13:50:56 -0400644
Jeff Garzika7dac442005-10-30 04:44:42 -0500645 if (tf->flags & ATA_TFLAG_LBA48) {
646 /* TODO: find solution for LBA48 descriptors */
647 }
648
649 else if (tf->flags & ATA_TFLAG_LBA) {
Jeff Garzikb0955182005-05-12 15:45:22 -0400650 /* A small (28b) LBA will fit in the 32b info field */
651 sb[0] |= 0x80; /* set valid bit */
652 sb[3] = tf->device & 0x0f;
653 sb[4] = tf->lbah;
654 sb[5] = tf->lbam;
655 sb[6] = tf->lbal;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700656 }
Jeff Garzika7dac442005-10-30 04:44:42 -0500657
658 else {
659 /* TODO: C/H/S */
660 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700661}
662
Brian Kinga6cce2a2006-03-17 17:04:15 -0600663static void ata_scsi_sdev_config(struct scsi_device *sdev)
664{
665 sdev->use_10_for_rw = 1;
666 sdev->use_10_for_ms = 1;
667}
668
669static void ata_scsi_dev_config(struct scsi_device *sdev,
670 struct ata_device *dev)
671{
672 unsigned int max_sectors;
673
674 /* TODO: 2048 is an arbitrary number, not the
675 * hardware maximum. This should be increased to
676 * 65534 when Jens Axboe's patch for dynamically
677 * determining max_sectors is merged.
678 */
679 max_sectors = ATA_MAX_SECTORS;
680 if (dev->flags & ATA_DFLAG_LBA48)
681 max_sectors = 2048;
682 if (dev->max_sectors)
683 max_sectors = dev->max_sectors;
684
685 blk_queue_max_sectors(sdev->request_queue, max_sectors);
686
687 /*
688 * SATA DMA transfers must be multiples of 4 byte, so
689 * we need to pad ATAPI transfers using an extra sg.
690 * Decrement max hw segments accordingly.
691 */
692 if (dev->class == ATA_DEV_ATAPI) {
693 request_queue_t *q = sdev->request_queue;
694 blk_queue_max_hw_segments(q, q->max_hw_segments - 1);
695 }
696}
697
Linus Torvalds1da177e2005-04-16 15:20:36 -0700698/**
699 * ata_scsi_slave_config - Set SCSI device attributes
700 * @sdev: SCSI device to examine
701 *
702 * This is called before we actually start reading
703 * and writing to the device, to configure certain
704 * SCSI mid-layer behaviors.
705 *
706 * LOCKING:
707 * Defined by SCSI layer. We don't really care.
708 */
709
710int ata_scsi_slave_config(struct scsi_device *sdev)
711{
Brian Kinga6cce2a2006-03-17 17:04:15 -0600712 ata_scsi_sdev_config(sdev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700713
714 blk_queue_max_phys_segments(sdev->request_queue, LIBATA_MAX_PRD);
715
716 if (sdev->id < ATA_MAX_DEVICES) {
717 struct ata_port *ap;
718 struct ata_device *dev;
719
720 ap = (struct ata_port *) &sdev->host->hostdata[0];
721 dev = &ap->device[sdev->id];
722
Brian Kinga6cce2a2006-03-17 17:04:15 -0600723 ata_scsi_dev_config(sdev, dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700724 }
725
726 return 0; /* scsi layer doesn't check return value, sigh */
727}
728
729/**
Tejun Heof29841e2006-02-10 15:10:48 +0900730 * ata_scsi_timed_out - SCSI layer time out callback
731 * @cmd: timed out SCSI command
732 *
733 * Handles SCSI layer timeout. We race with normal completion of
734 * the qc for @cmd. If the qc is already gone, we lose and let
735 * the scsi command finish (EH_HANDLED). Otherwise, the qc has
736 * timed out and EH should be invoked. Prevent ata_qc_complete()
737 * from finishing it by setting EH_SCHEDULED and return
738 * EH_NOT_HANDLED.
739 *
740 * LOCKING:
741 * Called from timer context
742 *
743 * RETURNS:
744 * EH_HANDLED or EH_NOT_HANDLED
745 */
746enum scsi_eh_timer_return ata_scsi_timed_out(struct scsi_cmnd *cmd)
747{
748 struct Scsi_Host *host = cmd->device->host;
749 struct ata_port *ap = (struct ata_port *) &host->hostdata[0];
750 unsigned long flags;
751 struct ata_queued_cmd *qc;
752 enum scsi_eh_timer_return ret = EH_HANDLED;
753
754 DPRINTK("ENTER\n");
755
756 spin_lock_irqsave(&ap->host_set->lock, flags);
757 qc = ata_qc_from_tag(ap, ap->active_tag);
758 if (qc) {
Tejun Heoa46314742006-02-11 19:11:13 +0900759 WARN_ON(qc->scsicmd != cmd);
Tejun Heof29841e2006-02-10 15:10:48 +0900760 qc->flags |= ATA_QCFLAG_EH_SCHEDULED;
761 qc->err_mask |= AC_ERR_TIMEOUT;
762 ret = EH_NOT_HANDLED;
763 }
764 spin_unlock_irqrestore(&ap->host_set->lock, flags);
765
766 DPRINTK("EXIT, ret=%d\n", ret);
767 return ret;
768}
769
770/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700771 * ata_scsi_error - SCSI layer error handler callback
772 * @host: SCSI host on which error occurred
773 *
774 * Handles SCSI-layer-thrown error events.
775 *
776 * LOCKING:
777 * Inherited from SCSI layer (none, can sleep)
778 *
779 * RETURNS:
780 * Zero.
781 */
782
783int ata_scsi_error(struct Scsi_Host *host)
784{
785 struct ata_port *ap;
Jeff Garzik51407882006-02-09 01:56:05 -0500786 unsigned long flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700787
788 DPRINTK("ENTER\n");
789
Jeff Garzik51407882006-02-09 01:56:05 -0500790 ap = (struct ata_port *) &host->hostdata[0];
791
Tejun Heodde44582006-02-02 00:56:10 +0900792 spin_lock_irqsave(&ap->host_set->lock, flags);
Tejun Heoa46314742006-02-11 19:11:13 +0900793 WARN_ON(ap->flags & ATA_FLAG_IN_EH);
Tejun Heodde44582006-02-02 00:56:10 +0900794 ap->flags |= ATA_FLAG_IN_EH;
Tejun Heoa46314742006-02-11 19:11:13 +0900795 WARN_ON(ata_qc_from_tag(ap, ap->active_tag) == NULL);
Tejun Heodde44582006-02-02 00:56:10 +0900796 spin_unlock_irqrestore(&ap->host_set->lock, flags);
797
Tejun Heo86e45b62006-03-05 15:29:09 +0900798 ata_port_flush_task(ap);
799
Linus Torvalds1da177e2005-04-16 15:20:36 -0700800 ap->ops->eng_timeout(ap);
801
Tejun Heoa46314742006-02-11 19:11:13 +0900802 WARN_ON(host->host_failed || !list_empty(&host->eh_cmd_q));
Tejun Heoa72ec4c2006-01-23 13:09:37 +0900803
804 scsi_eh_flush_done_q(&ap->eh_done_q);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700805
Tejun Heodde44582006-02-02 00:56:10 +0900806 spin_lock_irqsave(&ap->host_set->lock, flags);
807 ap->flags &= ~ATA_FLAG_IN_EH;
808 spin_unlock_irqrestore(&ap->host_set->lock, flags);
809
Linus Torvalds1da177e2005-04-16 15:20:36 -0700810 DPRINTK("EXIT\n");
811 return 0;
812}
813
Tejun Heoa72ec4c2006-01-23 13:09:37 +0900814static void ata_eh_scsidone(struct scsi_cmnd *scmd)
815{
816 /* nada */
817}
818
819static void __ata_eh_qc_complete(struct ata_queued_cmd *qc)
820{
821 struct ata_port *ap = qc->ap;
822 struct scsi_cmnd *scmd = qc->scsicmd;
823 unsigned long flags;
824
825 spin_lock_irqsave(&ap->host_set->lock, flags);
826 qc->scsidone = ata_eh_scsidone;
Tejun Heo341963b2006-02-10 15:10:48 +0900827 __ata_qc_complete(qc);
Tejun Heoa46314742006-02-11 19:11:13 +0900828 WARN_ON(ata_tag_valid(qc->tag));
Tejun Heoa72ec4c2006-01-23 13:09:37 +0900829 spin_unlock_irqrestore(&ap->host_set->lock, flags);
830
831 scsi_eh_finish_cmd(scmd, &ap->eh_done_q);
832}
833
834/**
835 * ata_eh_qc_complete - Complete an active ATA command from EH
836 * @qc: Command to complete
837 *
838 * Indicate to the mid and upper layers that an ATA command has
839 * completed. To be used from EH.
840 */
841void ata_eh_qc_complete(struct ata_queued_cmd *qc)
842{
843 struct scsi_cmnd *scmd = qc->scsicmd;
844 scmd->retries = scmd->allowed;
845 __ata_eh_qc_complete(qc);
846}
847
848/**
849 * ata_eh_qc_retry - Tell midlayer to retry an ATA command after EH
850 * @qc: Command to retry
851 *
852 * Indicate to the mid and upper layers that an ATA command
853 * should be retried. To be used from EH.
854 *
855 * SCSI midlayer limits the number of retries to scmd->allowed.
856 * This function might need to adjust scmd->retries for commands
857 * which get retried due to unrelated NCQ failures.
858 */
859void ata_eh_qc_retry(struct ata_queued_cmd *qc)
860{
861 __ata_eh_qc_complete(qc);
862}
863
Linus Torvalds1da177e2005-04-16 15:20:36 -0700864/**
Douglas Gilbert972dcaf2005-08-11 03:35:53 -0400865 * ata_scsi_start_stop_xlat - Translate SCSI START STOP UNIT command
866 * @qc: Storage for translated ATA taskfile
867 * @scsicmd: SCSI command to translate
868 *
869 * Sets up an ATA taskfile to issue STANDBY (to stop) or READ VERIFY
870 * (to start). Perhaps these commands should be preceded by
871 * CHECK POWER MODE to see what power mode the device is already in.
872 * [See SAT revision 5 at www.t10.org]
873 *
874 * LOCKING:
875 * spin_lock_irqsave(host_set lock)
876 *
877 * RETURNS:
878 * Zero on success, non-zero on error.
879 */
880
881static unsigned int ata_scsi_start_stop_xlat(struct ata_queued_cmd *qc,
Jeff Garzik057ace52005-10-22 14:27:05 -0400882 const u8 *scsicmd)
Douglas Gilbert972dcaf2005-08-11 03:35:53 -0400883{
884 struct ata_taskfile *tf = &qc->tf;
885
886 tf->flags |= ATA_TFLAG_DEVICE | ATA_TFLAG_ISADDR;
887 tf->protocol = ATA_PROT_NODATA;
888 if (scsicmd[1] & 0x1) {
889 ; /* ignore IMMED bit, violates sat-r05 */
890 }
891 if (scsicmd[4] & 0x2)
Douglas Gilbertae006512005-10-09 09:09:35 -0400892 goto invalid_fld; /* LOEJ bit set not supported */
Douglas Gilbert972dcaf2005-08-11 03:35:53 -0400893 if (((scsicmd[4] >> 4) & 0xf) != 0)
Douglas Gilbertae006512005-10-09 09:09:35 -0400894 goto invalid_fld; /* power conditions not supported */
Douglas Gilbert972dcaf2005-08-11 03:35:53 -0400895 if (scsicmd[4] & 0x1) {
896 tf->nsect = 1; /* 1 sector, lba=0 */
Albert Lee9d5b1302005-10-04 08:48:17 -0400897
898 if (qc->dev->flags & ATA_DFLAG_LBA) {
899 qc->tf.flags |= ATA_TFLAG_LBA;
900
901 tf->lbah = 0x0;
902 tf->lbam = 0x0;
903 tf->lbal = 0x0;
904 tf->device |= ATA_LBA;
905 } else {
906 /* CHS */
907 tf->lbal = 0x1; /* sect */
908 tf->lbam = 0x0; /* cyl low */
909 tf->lbah = 0x0; /* cyl high */
910 }
911
Douglas Gilbert972dcaf2005-08-11 03:35:53 -0400912 tf->command = ATA_CMD_VERIFY; /* READ VERIFY */
913 } else {
914 tf->nsect = 0; /* time period value (0 implies now) */
915 tf->command = ATA_CMD_STANDBY;
916 /* Consider: ATA STANDBY IMMEDIATE command */
917 }
918 /*
919 * Standby and Idle condition timers could be implemented but that
920 * would require libata to implement the Power condition mode page
921 * and allow the user to change it. Changing mode pages requires
922 * MODE SELECT to be implemented.
923 */
924
925 return 0;
Douglas Gilbertae006512005-10-09 09:09:35 -0400926
927invalid_fld:
928 ata_scsi_set_sense(qc->scsicmd, ILLEGAL_REQUEST, 0x24, 0x0);
929 /* "Invalid field in cbd" */
930 return 1;
Douglas Gilbert972dcaf2005-08-11 03:35:53 -0400931}
932
933
934/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700935 * ata_scsi_flush_xlat - Translate SCSI SYNCHRONIZE CACHE command
936 * @qc: Storage for translated ATA taskfile
937 * @scsicmd: SCSI command to translate (ignored)
938 *
939 * Sets up an ATA taskfile to issue FLUSH CACHE or
940 * FLUSH CACHE EXT.
941 *
942 * LOCKING:
943 * spin_lock_irqsave(host_set lock)
944 *
945 * RETURNS:
946 * Zero on success, non-zero on error.
947 */
948
Jeff Garzik057ace52005-10-22 14:27:05 -0400949static unsigned int ata_scsi_flush_xlat(struct ata_queued_cmd *qc, const u8 *scsicmd)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700950{
951 struct ata_taskfile *tf = &qc->tf;
952
953 tf->flags |= ATA_TFLAG_DEVICE;
954 tf->protocol = ATA_PROT_NODATA;
955
Albert Lee07506692005-10-12 15:04:18 +0800956 if ((qc->dev->flags & ATA_DFLAG_LBA48) &&
Linus Torvalds1da177e2005-04-16 15:20:36 -0700957 (ata_id_has_flush_ext(qc->dev->id)))
958 tf->command = ATA_CMD_FLUSH_EXT;
959 else
960 tf->command = ATA_CMD_FLUSH;
961
962 return 0;
963}
964
965/**
Albert Lee3aef5232005-10-04 08:47:43 -0400966 * scsi_6_lba_len - Get LBA and transfer length
967 * @scsicmd: SCSI command to translate
968 *
969 * Calculate LBA and transfer length for 6-byte commands.
970 *
971 * RETURNS:
972 * @plba: the LBA
973 * @plen: the transfer length
974 */
975
Jeff Garzik057ace52005-10-22 14:27:05 -0400976static void scsi_6_lba_len(const u8 *scsicmd, u64 *plba, u32 *plen)
Albert Lee3aef5232005-10-04 08:47:43 -0400977{
978 u64 lba = 0;
979 u32 len = 0;
980
981 VPRINTK("six-byte command\n");
982
983 lba |= ((u64)scsicmd[2]) << 8;
984 lba |= ((u64)scsicmd[3]);
985
986 len |= ((u32)scsicmd[4]);
987
988 *plba = lba;
989 *plen = len;
990}
991
992/**
993 * scsi_10_lba_len - Get LBA and transfer length
994 * @scsicmd: SCSI command to translate
995 *
996 * Calculate LBA and transfer length for 10-byte commands.
997 *
998 * RETURNS:
999 * @plba: the LBA
1000 * @plen: the transfer length
1001 */
1002
Jeff Garzik057ace52005-10-22 14:27:05 -04001003static void scsi_10_lba_len(const u8 *scsicmd, u64 *plba, u32 *plen)
Albert Lee3aef5232005-10-04 08:47:43 -04001004{
1005 u64 lba = 0;
1006 u32 len = 0;
1007
1008 VPRINTK("ten-byte command\n");
1009
1010 lba |= ((u64)scsicmd[2]) << 24;
1011 lba |= ((u64)scsicmd[3]) << 16;
1012 lba |= ((u64)scsicmd[4]) << 8;
1013 lba |= ((u64)scsicmd[5]);
1014
1015 len |= ((u32)scsicmd[7]) << 8;
1016 len |= ((u32)scsicmd[8]);
1017
1018 *plba = lba;
1019 *plen = len;
1020}
1021
1022/**
1023 * scsi_16_lba_len - Get LBA and transfer length
1024 * @scsicmd: SCSI command to translate
1025 *
1026 * Calculate LBA and transfer length for 16-byte commands.
1027 *
1028 * RETURNS:
1029 * @plba: the LBA
1030 * @plen: the transfer length
1031 */
1032
Jeff Garzik057ace52005-10-22 14:27:05 -04001033static void scsi_16_lba_len(const u8 *scsicmd, u64 *plba, u32 *plen)
Albert Lee3aef5232005-10-04 08:47:43 -04001034{
1035 u64 lba = 0;
1036 u32 len = 0;
1037
1038 VPRINTK("sixteen-byte command\n");
1039
1040 lba |= ((u64)scsicmd[2]) << 56;
1041 lba |= ((u64)scsicmd[3]) << 48;
1042 lba |= ((u64)scsicmd[4]) << 40;
1043 lba |= ((u64)scsicmd[5]) << 32;
1044 lba |= ((u64)scsicmd[6]) << 24;
1045 lba |= ((u64)scsicmd[7]) << 16;
1046 lba |= ((u64)scsicmd[8]) << 8;
1047 lba |= ((u64)scsicmd[9]);
1048
1049 len |= ((u32)scsicmd[10]) << 24;
1050 len |= ((u32)scsicmd[11]) << 16;
1051 len |= ((u32)scsicmd[12]) << 8;
1052 len |= ((u32)scsicmd[13]);
1053
1054 *plba = lba;
1055 *plen = len;
1056}
1057
1058/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07001059 * ata_scsi_verify_xlat - Translate SCSI VERIFY command into an ATA one
1060 * @qc: Storage for translated ATA taskfile
1061 * @scsicmd: SCSI command to translate
1062 *
1063 * Converts SCSI VERIFY command to an ATA READ VERIFY command.
1064 *
1065 * LOCKING:
1066 * spin_lock_irqsave(host_set lock)
1067 *
1068 * RETURNS:
1069 * Zero on success, non-zero on error.
1070 */
1071
Jeff Garzik057ace52005-10-22 14:27:05 -04001072static unsigned int ata_scsi_verify_xlat(struct ata_queued_cmd *qc, const u8 *scsicmd)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001073{
1074 struct ata_taskfile *tf = &qc->tf;
Albert Lee8bf62ece2005-05-12 15:29:42 -04001075 struct ata_device *dev = qc->dev;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001076 u64 dev_sectors = qc->dev->n_sectors;
Albert Lee3aef5232005-10-04 08:47:43 -04001077 u64 block;
1078 u32 n_block;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001079
1080 tf->flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
1081 tf->protocol = ATA_PROT_NODATA;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001082
Albert Lee3aef5232005-10-04 08:47:43 -04001083 if (scsicmd[0] == VERIFY)
1084 scsi_10_lba_len(scsicmd, &block, &n_block);
1085 else if (scsicmd[0] == VERIFY_16)
1086 scsi_16_lba_len(scsicmd, &block, &n_block);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001087 else
Douglas Gilbertae006512005-10-09 09:09:35 -04001088 goto invalid_fld;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001089
Albert Lee8bf62ece2005-05-12 15:29:42 -04001090 if (!n_block)
Douglas Gilbertae006512005-10-09 09:09:35 -04001091 goto nothing_to_do;
Albert Lee8bf62ece2005-05-12 15:29:42 -04001092 if (block >= dev_sectors)
Douglas Gilbertae006512005-10-09 09:09:35 -04001093 goto out_of_range;
Albert Lee8bf62ece2005-05-12 15:29:42 -04001094 if ((block + n_block) > dev_sectors)
Douglas Gilbertae006512005-10-09 09:09:35 -04001095 goto out_of_range;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001096
Albert Lee07506692005-10-12 15:04:18 +08001097 if (dev->flags & ATA_DFLAG_LBA) {
1098 tf->flags |= ATA_TFLAG_LBA;
1099
Albert Leec6a33e22005-10-12 15:12:26 +08001100 if (lba_28_ok(block, n_block)) {
1101 /* use LBA28 */
1102 tf->command = ATA_CMD_VERIFY;
1103 tf->device |= (block >> 24) & 0xf;
1104 } else if (lba_48_ok(block, n_block)) {
1105 if (!(dev->flags & ATA_DFLAG_LBA48))
1106 goto out_of_range;
Albert Lee07506692005-10-12 15:04:18 +08001107
1108 /* use LBA48 */
1109 tf->flags |= ATA_TFLAG_LBA48;
Albert Lee8bf62ece2005-05-12 15:29:42 -04001110 tf->command = ATA_CMD_VERIFY_EXT;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001111
Albert Lee8bf62ece2005-05-12 15:29:42 -04001112 tf->hob_nsect = (n_block >> 8) & 0xff;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001113
Albert Lee8bf62ece2005-05-12 15:29:42 -04001114 tf->hob_lbah = (block >> 40) & 0xff;
1115 tf->hob_lbam = (block >> 32) & 0xff;
1116 tf->hob_lbal = (block >> 24) & 0xff;
Albert Leec6a33e22005-10-12 15:12:26 +08001117 } else
1118 /* request too large even for LBA48 */
1119 goto out_of_range;
Albert Lee8bf62ece2005-05-12 15:29:42 -04001120
1121 tf->nsect = n_block & 0xff;
1122
1123 tf->lbah = (block >> 16) & 0xff;
1124 tf->lbam = (block >> 8) & 0xff;
1125 tf->lbal = block & 0xff;
1126
1127 tf->device |= ATA_LBA;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001128 } else {
Albert Lee8bf62ece2005-05-12 15:29:42 -04001129 /* CHS */
1130 u32 sect, head, cyl, track;
1131
Albert Leec6a33e22005-10-12 15:12:26 +08001132 if (!lba_28_ok(block, n_block))
1133 goto out_of_range;
Albert Lee07506692005-10-12 15:04:18 +08001134
Albert Lee8bf62ece2005-05-12 15:29:42 -04001135 /* Convert LBA to CHS */
1136 track = (u32)block / dev->sectors;
1137 cyl = track / dev->heads;
1138 head = track % dev->heads;
1139 sect = (u32)block % dev->sectors + 1;
1140
Albert Leec187c4b2005-10-04 08:46:51 -04001141 DPRINTK("block %u track %u cyl %u head %u sect %u\n",
1142 (u32)block, track, cyl, head, sect);
Albert Lee8bf62ece2005-05-12 15:29:42 -04001143
1144 /* Check whether the converted CHS can fit.
1145 Cylinder: 0-65535
1146 Head: 0-15
1147 Sector: 1-255*/
1148 if ((cyl >> 16) || (head >> 4) || (sect >> 8) || (!sect))
Douglas Gilbertae006512005-10-09 09:09:35 -04001149 goto out_of_range;
Albert Lee8bf62ece2005-05-12 15:29:42 -04001150
Linus Torvalds1da177e2005-04-16 15:20:36 -07001151 tf->command = ATA_CMD_VERIFY;
Albert Lee8bf62ece2005-05-12 15:29:42 -04001152 tf->nsect = n_block & 0xff; /* Sector count 0 means 256 sectors */
1153 tf->lbal = sect;
1154 tf->lbam = cyl;
1155 tf->lbah = cyl >> 8;
1156 tf->device |= head;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001157 }
1158
Linus Torvalds1da177e2005-04-16 15:20:36 -07001159 return 0;
Douglas Gilbertae006512005-10-09 09:09:35 -04001160
1161invalid_fld:
1162 ata_scsi_set_sense(qc->scsicmd, ILLEGAL_REQUEST, 0x24, 0x0);
1163 /* "Invalid field in cbd" */
1164 return 1;
1165
1166out_of_range:
1167 ata_scsi_set_sense(qc->scsicmd, ILLEGAL_REQUEST, 0x21, 0x0);
1168 /* "Logical Block Address out of range" */
1169 return 1;
1170
1171nothing_to_do:
1172 qc->scsicmd->result = SAM_STAT_GOOD;
1173 return 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001174}
1175
1176/**
1177 * ata_scsi_rw_xlat - Translate SCSI r/w command into an ATA one
1178 * @qc: Storage for translated ATA taskfile
1179 * @scsicmd: SCSI command to translate
1180 *
1181 * Converts any of six SCSI read/write commands into the
1182 * ATA counterpart, including starting sector (LBA),
1183 * sector count, and taking into account the device's LBA48
1184 * support.
1185 *
1186 * Commands %READ_6, %READ_10, %READ_16, %WRITE_6, %WRITE_10, and
1187 * %WRITE_16 are currently supported.
1188 *
1189 * LOCKING:
1190 * spin_lock_irqsave(host_set lock)
1191 *
1192 * RETURNS:
1193 * Zero on success, non-zero on error.
1194 */
1195
Jeff Garzik057ace52005-10-22 14:27:05 -04001196static unsigned int ata_scsi_rw_xlat(struct ata_queued_cmd *qc, const u8 *scsicmd)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001197{
1198 struct ata_taskfile *tf = &qc->tf;
Albert Lee8bf62ece2005-05-12 15:29:42 -04001199 struct ata_device *dev = qc->dev;
Albert Lee3aef5232005-10-04 08:47:43 -04001200 u64 block;
1201 u32 n_block;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001202
1203 tf->flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001204
Albert Lee8cbd6df2005-10-12 15:06:27 +08001205 if (scsicmd[0] == WRITE_10 || scsicmd[0] == WRITE_6 ||
1206 scsicmd[0] == WRITE_16)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001207 tf->flags |= ATA_TFLAG_WRITE;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001208
Tejun Heo9a3dccc2006-01-06 09:56:18 +01001209 /* Calculate the SCSI LBA, transfer length and FUA. */
Albert Lee3aef5232005-10-04 08:47:43 -04001210 switch (scsicmd[0]) {
1211 case READ_10:
1212 case WRITE_10:
1213 scsi_10_lba_len(scsicmd, &block, &n_block);
Tejun Heo9a3dccc2006-01-06 09:56:18 +01001214 if (unlikely(scsicmd[1] & (1 << 3)))
1215 tf->flags |= ATA_TFLAG_FUA;
Albert Lee3aef5232005-10-04 08:47:43 -04001216 break;
1217 case READ_6:
1218 case WRITE_6:
1219 scsi_6_lba_len(scsicmd, &block, &n_block);
Albert Leec187c4b2005-10-04 08:46:51 -04001220
1221 /* for 6-byte r/w commands, transfer length 0
1222 * means 256 blocks of data, not 0 block.
1223 */
Jeff Garzik76b2bf92005-08-29 19:24:43 -04001224 if (!n_block)
1225 n_block = 256;
Albert Lee3aef5232005-10-04 08:47:43 -04001226 break;
1227 case READ_16:
1228 case WRITE_16:
1229 scsi_16_lba_len(scsicmd, &block, &n_block);
Tejun Heo9a3dccc2006-01-06 09:56:18 +01001230 if (unlikely(scsicmd[1] & (1 << 3)))
1231 tf->flags |= ATA_TFLAG_FUA;
Albert Lee3aef5232005-10-04 08:47:43 -04001232 break;
1233 default:
Albert Lee8bf62ece2005-05-12 15:29:42 -04001234 DPRINTK("no-byte command\n");
Douglas Gilbertae006512005-10-09 09:09:35 -04001235 goto invalid_fld;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001236 }
1237
Albert Lee8bf62ece2005-05-12 15:29:42 -04001238 /* Check and compose ATA command */
1239 if (!n_block)
Albert Leec187c4b2005-10-04 08:46:51 -04001240 /* For 10-byte and 16-byte SCSI R/W commands, transfer
1241 * length 0 means transfer 0 block of data.
1242 * However, for ATA R/W commands, sector count 0 means
1243 * 256 or 65536 sectors, not 0 sectors as in SCSI.
Alan Coxf51750d2005-11-07 17:06:33 +00001244 *
1245 * WARNING: one or two older ATA drives treat 0 as 0...
Albert Leec187c4b2005-10-04 08:46:51 -04001246 */
Douglas Gilbertae006512005-10-09 09:09:35 -04001247 goto nothing_to_do;
Albert Lee8bf62ece2005-05-12 15:29:42 -04001248
Albert Lee07506692005-10-12 15:04:18 +08001249 if (dev->flags & ATA_DFLAG_LBA) {
1250 tf->flags |= ATA_TFLAG_LBA;
1251
Albert Leec6a33e22005-10-12 15:12:26 +08001252 if (lba_28_ok(block, n_block)) {
1253 /* use LBA28 */
1254 tf->device |= (block >> 24) & 0xf;
1255 } else if (lba_48_ok(block, n_block)) {
1256 if (!(dev->flags & ATA_DFLAG_LBA48))
Douglas Gilbertae006512005-10-09 09:09:35 -04001257 goto out_of_range;
Albert Lee8bf62ece2005-05-12 15:29:42 -04001258
Albert Lee07506692005-10-12 15:04:18 +08001259 /* use LBA48 */
1260 tf->flags |= ATA_TFLAG_LBA48;
1261
Albert Lee8bf62ece2005-05-12 15:29:42 -04001262 tf->hob_nsect = (n_block >> 8) & 0xff;
1263
1264 tf->hob_lbah = (block >> 40) & 0xff;
1265 tf->hob_lbam = (block >> 32) & 0xff;
1266 tf->hob_lbal = (block >> 24) & 0xff;
Albert Leec6a33e22005-10-12 15:12:26 +08001267 } else
1268 /* request too large even for LBA48 */
1269 goto out_of_range;
Albert Leec187c4b2005-10-04 08:46:51 -04001270
Tejun Heo9a3dccc2006-01-06 09:56:18 +01001271 if (unlikely(ata_rwcmd_protocol(qc) < 0))
1272 goto invalid_fld;
Albert Lee8cbd6df2005-10-12 15:06:27 +08001273
Albert Lee8bf62ece2005-05-12 15:29:42 -04001274 qc->nsect = n_block;
1275 tf->nsect = n_block & 0xff;
1276
1277 tf->lbah = (block >> 16) & 0xff;
1278 tf->lbam = (block >> 8) & 0xff;
1279 tf->lbal = block & 0xff;
1280
1281 tf->device |= ATA_LBA;
1282 } else {
1283 /* CHS */
1284 u32 sect, head, cyl, track;
1285
1286 /* The request -may- be too large for CHS addressing. */
Albert Leec6a33e22005-10-12 15:12:26 +08001287 if (!lba_28_ok(block, n_block))
Douglas Gilbertae006512005-10-09 09:09:35 -04001288 goto out_of_range;
Albert Leec187c4b2005-10-04 08:46:51 -04001289
Tejun Heo9a3dccc2006-01-06 09:56:18 +01001290 if (unlikely(ata_rwcmd_protocol(qc) < 0))
1291 goto invalid_fld;
Albert Lee8cbd6df2005-10-12 15:06:27 +08001292
Albert Lee8bf62ece2005-05-12 15:29:42 -04001293 /* Convert LBA to CHS */
1294 track = (u32)block / dev->sectors;
1295 cyl = track / dev->heads;
1296 head = track % dev->heads;
1297 sect = (u32)block % dev->sectors + 1;
1298
Albert Leec187c4b2005-10-04 08:46:51 -04001299 DPRINTK("block %u track %u cyl %u head %u sect %u\n",
Albert Lee8bf62ece2005-05-12 15:29:42 -04001300 (u32)block, track, cyl, head, sect);
Albert Leec187c4b2005-10-04 08:46:51 -04001301
Albert Lee8bf62ece2005-05-12 15:29:42 -04001302 /* Check whether the converted CHS can fit.
1303 Cylinder: 0-65535
1304 Head: 0-15
1305 Sector: 1-255*/
Albert Leec187c4b2005-10-04 08:46:51 -04001306 if ((cyl >> 16) || (head >> 4) || (sect >> 8) || (!sect))
Douglas Gilbertae006512005-10-09 09:09:35 -04001307 goto out_of_range;
Albert Leec187c4b2005-10-04 08:46:51 -04001308
Albert Lee8bf62ece2005-05-12 15:29:42 -04001309 qc->nsect = n_block;
1310 tf->nsect = n_block & 0xff; /* Sector count 0 means 256 sectors */
1311 tf->lbal = sect;
1312 tf->lbam = cyl;
1313 tf->lbah = cyl >> 8;
1314 tf->device |= head;
1315 }
1316
1317 return 0;
Douglas Gilbertae006512005-10-09 09:09:35 -04001318
1319invalid_fld:
1320 ata_scsi_set_sense(qc->scsicmd, ILLEGAL_REQUEST, 0x24, 0x0);
1321 /* "Invalid field in cbd" */
1322 return 1;
1323
1324out_of_range:
1325 ata_scsi_set_sense(qc->scsicmd, ILLEGAL_REQUEST, 0x21, 0x0);
1326 /* "Logical Block Address out of range" */
1327 return 1;
1328
1329nothing_to_do:
1330 qc->scsicmd->result = SAM_STAT_GOOD;
1331 return 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001332}
1333
Tejun Heo77853bf2006-01-23 13:09:36 +09001334static void ata_scsi_qc_complete(struct ata_queued_cmd *qc)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001335{
1336 struct scsi_cmnd *cmd = qc->scsicmd;
Jeff Garzika7dac442005-10-30 04:44:42 -05001337 u8 *cdb = cmd->cmnd;
Albert Leea22e2eb2005-12-05 15:38:02 +08001338 int need_sense = (qc->err_mask != 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001339
Jeff Garzikb0955182005-05-12 15:45:22 -04001340 /* For ATA pass thru (SAT) commands, generate a sense block if
1341 * user mandated it or if there's an error. Note that if we
1342 * generate because the user forced us to, a check condition
1343 * is generated and the ATA register values are returned
1344 * whether the command completed successfully or not. If there
1345 * was no error, SK, ASC and ASCQ will all be zero.
1346 */
Jeff Garzika7dac442005-10-30 04:44:42 -05001347 if (((cdb[0] == ATA_16) || (cdb[0] == ATA_12)) &&
1348 ((cdb[2] & 0x20) || need_sense)) {
Jeff Garzikb0955182005-05-12 15:45:22 -04001349 ata_gen_ata_desc_sense(qc);
1350 } else {
1351 if (!need_sense) {
1352 cmd->result = SAM_STAT_GOOD;
1353 } else {
1354 /* TODO: decide which descriptor format to use
1355 * for 48b LBA devices and call that here
1356 * instead of the fixed desc, which is only
1357 * good for smaller LBA (and maybe CHS?)
1358 * devices.
1359 */
1360 ata_gen_fixed_sense(qc);
1361 }
1362 }
1363
1364 if (need_sense) {
1365 /* The ata_gen_..._sense routines fill in tf */
1366 ata_dump_status(qc->ap->id, &qc->tf);
1367 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001368
1369 qc->scsidone(cmd);
1370
Tejun Heo77853bf2006-01-23 13:09:36 +09001371 ata_qc_free(qc);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001372}
1373
1374/**
1375 * ata_scsi_translate - Translate then issue SCSI command to ATA device
1376 * @ap: ATA port to which the command is addressed
1377 * @dev: ATA device to which the command is addressed
1378 * @cmd: SCSI command to execute
1379 * @done: SCSI command completion function
1380 * @xlat_func: Actor which translates @cmd to an ATA taskfile
1381 *
1382 * Our ->queuecommand() function has decided that the SCSI
1383 * command issued can be directly translated into an ATA
1384 * command, rather than handled internally.
1385 *
1386 * This function sets up an ata_queued_cmd structure for the
1387 * SCSI command, and sends that ata_queued_cmd to the hardware.
1388 *
Douglas Gilbertae006512005-10-09 09:09:35 -04001389 * The xlat_func argument (actor) returns 0 if ready to execute
1390 * ATA command, else 1 to finish translation. If 1 is returned
1391 * then cmd->result (and possibly cmd->sense_buffer) are assumed
1392 * to be set reflecting an error condition or clean (early)
1393 * termination.
1394 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07001395 * LOCKING:
1396 * spin_lock_irqsave(host_set lock)
1397 */
1398
1399static void ata_scsi_translate(struct ata_port *ap, struct ata_device *dev,
1400 struct scsi_cmnd *cmd,
1401 void (*done)(struct scsi_cmnd *),
1402 ata_xlat_func_t xlat_func)
1403{
1404 struct ata_queued_cmd *qc;
1405 u8 *scsicmd = cmd->cmnd;
1406
1407 VPRINTK("ENTER\n");
1408
1409 qc = ata_scsi_qc_new(ap, dev, cmd, done);
1410 if (!qc)
Douglas Gilbertae006512005-10-09 09:09:35 -04001411 goto err_mem;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001412
1413 /* data is present; dma-map it */
be7db052005-04-17 15:26:13 -05001414 if (cmd->sc_data_direction == DMA_FROM_DEVICE ||
1415 cmd->sc_data_direction == DMA_TO_DEVICE) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001416 if (unlikely(cmd->request_bufflen < 1)) {
1417 printk(KERN_WARNING "ata%u(%u): WARNING: zero len r/w req\n",
1418 ap->id, dev->devno);
Douglas Gilbertae006512005-10-09 09:09:35 -04001419 goto err_did;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001420 }
1421
1422 if (cmd->use_sg)
1423 ata_sg_init(qc, cmd->request_buffer, cmd->use_sg);
1424 else
1425 ata_sg_init_one(qc, cmd->request_buffer,
1426 cmd->request_bufflen);
1427
1428 qc->dma_dir = cmd->sc_data_direction;
1429 }
1430
1431 qc->complete_fn = ata_scsi_qc_complete;
1432
1433 if (xlat_func(qc, scsicmd))
Douglas Gilbertae006512005-10-09 09:09:35 -04001434 goto early_finish;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001435
1436 /* select device, send command to hardware */
Tejun Heo9a3d9eb2006-01-23 13:09:36 +09001437 qc->err_mask = ata_qc_issue(qc);
1438 if (qc->err_mask)
Tejun Heo8e436af2006-01-23 13:09:36 +09001439 ata_qc_complete(qc);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001440
1441 VPRINTK("EXIT\n");
1442 return;
1443
Douglas Gilbertae006512005-10-09 09:09:35 -04001444early_finish:
1445 ata_qc_free(qc);
1446 done(cmd);
1447 DPRINTK("EXIT - early finish (good or error)\n");
1448 return;
1449
1450err_did:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001451 ata_qc_free(qc);
Douglas Gilbertae006512005-10-09 09:09:35 -04001452err_mem:
1453 cmd->result = (DID_ERROR << 16);
1454 done(cmd);
1455 DPRINTK("EXIT - internal\n");
1456 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001457}
1458
1459/**
1460 * ata_scsi_rbuf_get - Map response buffer.
1461 * @cmd: SCSI command containing buffer to be mapped.
1462 * @buf_out: Pointer to mapped area.
1463 *
1464 * Maps buffer contained within SCSI command @cmd.
1465 *
1466 * LOCKING:
1467 * spin_lock_irqsave(host_set lock)
1468 *
1469 * RETURNS:
1470 * Length of response buffer.
1471 */
1472
1473static unsigned int ata_scsi_rbuf_get(struct scsi_cmnd *cmd, u8 **buf_out)
1474{
1475 u8 *buf;
1476 unsigned int buflen;
1477
1478 if (cmd->use_sg) {
1479 struct scatterlist *sg;
1480
1481 sg = (struct scatterlist *) cmd->request_buffer;
1482 buf = kmap_atomic(sg->page, KM_USER0) + sg->offset;
1483 buflen = sg->length;
1484 } else {
1485 buf = cmd->request_buffer;
1486 buflen = cmd->request_bufflen;
1487 }
1488
1489 *buf_out = buf;
1490 return buflen;
1491}
1492
1493/**
1494 * ata_scsi_rbuf_put - Unmap response buffer.
1495 * @cmd: SCSI command containing buffer to be unmapped.
1496 * @buf: buffer to unmap
1497 *
1498 * Unmaps response buffer contained within @cmd.
1499 *
1500 * LOCKING:
1501 * spin_lock_irqsave(host_set lock)
1502 */
1503
1504static inline void ata_scsi_rbuf_put(struct scsi_cmnd *cmd, u8 *buf)
1505{
1506 if (cmd->use_sg) {
1507 struct scatterlist *sg;
1508
1509 sg = (struct scatterlist *) cmd->request_buffer;
1510 kunmap_atomic(buf - sg->offset, KM_USER0);
1511 }
1512}
1513
1514/**
1515 * ata_scsi_rbuf_fill - wrapper for SCSI command simulators
1516 * @args: device IDENTIFY data / SCSI command of interest.
1517 * @actor: Callback hook for desired SCSI command simulator
1518 *
1519 * Takes care of the hard work of simulating a SCSI command...
1520 * Mapping the response buffer, calling the command's handler,
1521 * and handling the handler's return value. This return value
1522 * indicates whether the handler wishes the SCSI command to be
Douglas Gilbertae006512005-10-09 09:09:35 -04001523 * completed successfully (0), or not (in which case cmd->result
1524 * and sense buffer are assumed to be set).
Linus Torvalds1da177e2005-04-16 15:20:36 -07001525 *
1526 * LOCKING:
1527 * spin_lock_irqsave(host_set lock)
1528 */
1529
1530void ata_scsi_rbuf_fill(struct ata_scsi_args *args,
1531 unsigned int (*actor) (struct ata_scsi_args *args,
1532 u8 *rbuf, unsigned int buflen))
1533{
1534 u8 *rbuf;
1535 unsigned int buflen, rc;
1536 struct scsi_cmnd *cmd = args->cmd;
1537
1538 buflen = ata_scsi_rbuf_get(cmd, &rbuf);
1539 memset(rbuf, 0, buflen);
1540 rc = actor(args, rbuf, buflen);
1541 ata_scsi_rbuf_put(cmd, rbuf);
1542
Douglas Gilbertae006512005-10-09 09:09:35 -04001543 if (rc == 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001544 cmd->result = SAM_STAT_GOOD;
Douglas Gilbertae006512005-10-09 09:09:35 -04001545 args->done(cmd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001546}
1547
1548/**
1549 * ata_scsiop_inq_std - Simulate INQUIRY command
1550 * @args: device IDENTIFY data / SCSI command of interest.
1551 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1552 * @buflen: Response buffer length.
1553 *
1554 * Returns standard device identification data associated
Jeff Garzikb142eb62006-03-21 20:37:47 -05001555 * with non-VPD INQUIRY command output.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001556 *
1557 * LOCKING:
1558 * spin_lock_irqsave(host_set lock)
1559 */
1560
1561unsigned int ata_scsiop_inq_std(struct ata_scsi_args *args, u8 *rbuf,
1562 unsigned int buflen)
1563{
1564 u8 hdr[] = {
1565 TYPE_DISK,
1566 0,
1567 0x5, /* claim SPC-3 version compatibility */
1568 2,
1569 95 - 4
1570 };
1571
1572 /* set scsi removeable (RMB) bit per ata bit */
1573 if (ata_id_removeable(args->id))
1574 hdr[1] |= (1 << 7);
1575
1576 VPRINTK("ENTER\n");
1577
1578 memcpy(rbuf, hdr, sizeof(hdr));
1579
1580 if (buflen > 35) {
1581 memcpy(&rbuf[8], "ATA ", 8);
Tejun Heo6a62a042006-02-13 10:02:46 +09001582 ata_id_string(args->id, &rbuf[16], ATA_ID_PROD_OFS, 16);
1583 ata_id_string(args->id, &rbuf[32], ATA_ID_FW_REV_OFS, 4);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001584 if (rbuf[32] == 0 || rbuf[32] == ' ')
1585 memcpy(&rbuf[32], "n/a ", 4);
1586 }
1587
1588 if (buflen > 63) {
1589 const u8 versions[] = {
1590 0x60, /* SAM-3 (no version claimed) */
1591
1592 0x03,
1593 0x20, /* SBC-2 (no version claimed) */
1594
1595 0x02,
1596 0x60 /* SPC-3 (no version claimed) */
1597 };
1598
1599 memcpy(rbuf + 59, versions, sizeof(versions));
1600 }
1601
1602 return 0;
1603}
1604
1605/**
Jeff Garzikb142eb62006-03-21 20:37:47 -05001606 * ata_scsiop_inq_00 - Simulate INQUIRY VPD page 0, list of pages
Linus Torvalds1da177e2005-04-16 15:20:36 -07001607 * @args: device IDENTIFY data / SCSI command of interest.
1608 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1609 * @buflen: Response buffer length.
1610 *
Jeff Garzikb142eb62006-03-21 20:37:47 -05001611 * Returns list of inquiry VPD pages available.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001612 *
1613 * LOCKING:
1614 * spin_lock_irqsave(host_set lock)
1615 */
1616
1617unsigned int ata_scsiop_inq_00(struct ata_scsi_args *args, u8 *rbuf,
1618 unsigned int buflen)
1619{
1620 const u8 pages[] = {
1621 0x00, /* page 0x00, this page */
1622 0x80, /* page 0x80, unit serial no page */
1623 0x83 /* page 0x83, device ident page */
1624 };
Jeff Garzikb142eb62006-03-21 20:37:47 -05001625 rbuf[3] = sizeof(pages); /* number of supported VPD pages */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001626
1627 if (buflen > 6)
1628 memcpy(rbuf + 4, pages, sizeof(pages));
1629
1630 return 0;
1631}
1632
1633/**
Jeff Garzikb142eb62006-03-21 20:37:47 -05001634 * ata_scsiop_inq_80 - Simulate INQUIRY VPD page 80, device serial number
Linus Torvalds1da177e2005-04-16 15:20:36 -07001635 * @args: device IDENTIFY data / SCSI command of interest.
1636 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1637 * @buflen: Response buffer length.
1638 *
1639 * Returns ATA device serial number.
1640 *
1641 * LOCKING:
1642 * spin_lock_irqsave(host_set lock)
1643 */
1644
1645unsigned int ata_scsiop_inq_80(struct ata_scsi_args *args, u8 *rbuf,
1646 unsigned int buflen)
1647{
1648 const u8 hdr[] = {
1649 0,
1650 0x80, /* this page code */
1651 0,
1652 ATA_SERNO_LEN, /* page len */
1653 };
1654 memcpy(rbuf, hdr, sizeof(hdr));
1655
1656 if (buflen > (ATA_SERNO_LEN + 4 - 1))
Tejun Heo6a62a042006-02-13 10:02:46 +09001657 ata_id_string(args->id, (unsigned char *) &rbuf[4],
1658 ATA_ID_SERNO_OFS, ATA_SERNO_LEN);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001659
1660 return 0;
1661}
1662
Linus Torvalds1da177e2005-04-16 15:20:36 -07001663/**
Jeff Garzikb142eb62006-03-21 20:37:47 -05001664 * ata_scsiop_inq_83 - Simulate INQUIRY VPD page 83, device identity
Linus Torvalds1da177e2005-04-16 15:20:36 -07001665 * @args: device IDENTIFY data / SCSI command of interest.
1666 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1667 * @buflen: Response buffer length.
1668 *
Jeff Garzikb142eb62006-03-21 20:37:47 -05001669 * Yields two logical unit device identification designators:
1670 * - vendor specific ASCII containing the ATA serial number
1671 * - SAT defined "t10 vendor id based" containing ASCII vendor
1672 * name ("ATA "), model and serial numbers.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001673 *
1674 * LOCKING:
1675 * spin_lock_irqsave(host_set lock)
1676 */
1677
1678unsigned int ata_scsiop_inq_83(struct ata_scsi_args *args, u8 *rbuf,
1679 unsigned int buflen)
1680{
Jeff Garzikb142eb62006-03-21 20:37:47 -05001681 int num;
1682 const int sat_model_serial_desc_len = 68;
1683 const int ata_model_byte_len = 40;
1684
Linus Torvalds1da177e2005-04-16 15:20:36 -07001685 rbuf[1] = 0x83; /* this page code */
Jeff Garzikb142eb62006-03-21 20:37:47 -05001686 num = 4;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001687
Jeff Garzikb142eb62006-03-21 20:37:47 -05001688 if (buflen > (ATA_SERNO_LEN + num + 3)) {
1689 /* piv=0, assoc=lu, code_set=ACSII, designator=vendor */
1690 rbuf[num + 0] = 2;
1691 rbuf[num + 3] = ATA_SERNO_LEN;
1692 num += 4;
1693 ata_id_string(args->id, (unsigned char *) rbuf + num,
1694 ATA_ID_SERNO_OFS, ATA_SERNO_LEN);
1695 num += ATA_SERNO_LEN;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001696 }
Jeff Garzikb142eb62006-03-21 20:37:47 -05001697 if (buflen > (sat_model_serial_desc_len + num + 3)) {
1698 /* SAT defined lu model and serial numbers descriptor */
1699 /* piv=0, assoc=lu, code_set=ACSII, designator=t10 vendor id */
1700 rbuf[num + 0] = 2;
1701 rbuf[num + 1] = 1;
1702 rbuf[num + 3] = sat_model_serial_desc_len;
1703 num += 4;
1704 memcpy(rbuf + num, "ATA ", 8);
1705 num += 8;
1706 ata_id_string(args->id, (unsigned char *) rbuf + num,
1707 ATA_ID_PROD_OFS, ata_model_byte_len);
1708 num += ata_model_byte_len;
1709 ata_id_string(args->id, (unsigned char *) rbuf + num,
1710 ATA_ID_SERNO_OFS, ATA_SERNO_LEN);
1711 num += ATA_SERNO_LEN;
1712 }
1713 rbuf[3] = num - 4; /* page len (assume less than 256 bytes) */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001714 return 0;
1715}
1716
1717/**
Jeff Garzik0cba6322005-05-30 19:49:12 -04001718 * ata_scsiop_noop - Command handler that simply returns success.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001719 * @args: device IDENTIFY data / SCSI command of interest.
1720 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1721 * @buflen: Response buffer length.
1722 *
1723 * No operation. Simply returns success to caller, to indicate
1724 * that the caller should successfully complete this SCSI command.
1725 *
1726 * LOCKING:
1727 * spin_lock_irqsave(host_set lock)
1728 */
1729
1730unsigned int ata_scsiop_noop(struct ata_scsi_args *args, u8 *rbuf,
1731 unsigned int buflen)
1732{
1733 VPRINTK("ENTER\n");
1734 return 0;
1735}
1736
1737/**
1738 * ata_msense_push - Push data onto MODE SENSE data output buffer
1739 * @ptr_io: (input/output) Location to store more output data
1740 * @last: End of output data buffer
1741 * @buf: Pointer to BLOB being added to output buffer
1742 * @buflen: Length of BLOB
1743 *
1744 * Store MODE SENSE data on an output buffer.
1745 *
1746 * LOCKING:
1747 * None.
1748 */
1749
1750static void ata_msense_push(u8 **ptr_io, const u8 *last,
1751 const u8 *buf, unsigned int buflen)
1752{
1753 u8 *ptr = *ptr_io;
1754
1755 if ((ptr + buflen - 1) > last)
1756 return;
1757
1758 memcpy(ptr, buf, buflen);
1759
1760 ptr += buflen;
1761
1762 *ptr_io = ptr;
1763}
1764
1765/**
1766 * ata_msense_caching - Simulate MODE SENSE caching info page
1767 * @id: device IDENTIFY data
1768 * @ptr_io: (input/output) Location to store more output data
1769 * @last: End of output data buffer
1770 *
1771 * Generate a caching info page, which conditionally indicates
1772 * write caching to the SCSI layer, depending on device
1773 * capabilities.
1774 *
1775 * LOCKING:
1776 * None.
1777 */
1778
1779static unsigned int ata_msense_caching(u16 *id, u8 **ptr_io,
1780 const u8 *last)
1781{
Douglas Gilbert00ac37f2005-10-28 15:58:28 -04001782 u8 page[CACHE_MPAGE_LEN];
Linus Torvalds1da177e2005-04-16 15:20:36 -07001783
Douglas Gilbert00ac37f2005-10-28 15:58:28 -04001784 memcpy(page, def_cache_mpage, sizeof(page));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001785 if (ata_id_wcache_enabled(id))
1786 page[2] |= (1 << 2); /* write cache enable */
1787 if (!ata_id_rahead_enabled(id))
1788 page[12] |= (1 << 5); /* disable read ahead */
1789
1790 ata_msense_push(ptr_io, last, page, sizeof(page));
1791 return sizeof(page);
1792}
1793
1794/**
1795 * ata_msense_ctl_mode - Simulate MODE SENSE control mode page
1796 * @dev: Device associated with this MODE SENSE command
1797 * @ptr_io: (input/output) Location to store more output data
1798 * @last: End of output data buffer
1799 *
1800 * Generate a generic MODE SENSE control mode page.
1801 *
1802 * LOCKING:
1803 * None.
1804 */
1805
1806static unsigned int ata_msense_ctl_mode(u8 **ptr_io, const u8 *last)
1807{
Douglas Gilbert00ac37f2005-10-28 15:58:28 -04001808 ata_msense_push(ptr_io, last, def_control_mpage,
1809 sizeof(def_control_mpage));
1810 return sizeof(def_control_mpage);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001811}
1812
1813/**
1814 * ata_msense_rw_recovery - Simulate MODE SENSE r/w error recovery page
1815 * @dev: Device associated with this MODE SENSE command
1816 * @ptr_io: (input/output) Location to store more output data
1817 * @last: End of output data buffer
1818 *
1819 * Generate a generic MODE SENSE r/w error recovery page.
1820 *
1821 * LOCKING:
1822 * None.
1823 */
1824
1825static unsigned int ata_msense_rw_recovery(u8 **ptr_io, const u8 *last)
1826{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001827
Douglas Gilbert00ac37f2005-10-28 15:58:28 -04001828 ata_msense_push(ptr_io, last, def_rw_recovery_mpage,
1829 sizeof(def_rw_recovery_mpage));
1830 return sizeof(def_rw_recovery_mpage);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001831}
1832
Jens Axboe48bdc8e2006-01-30 16:09:35 +01001833/*
1834 * We can turn this into a real blacklist if it's needed, for now just
1835 * blacklist any Maxtor BANC1G10 revision firmware
1836 */
1837static int ata_dev_supports_fua(u16 *id)
1838{
1839 unsigned char model[41], fw[9];
1840
Jeff Garzikc3c013a2006-02-27 22:31:19 -05001841 if (!libata_fua)
1842 return 0;
Jens Axboe48bdc8e2006-01-30 16:09:35 +01001843 if (!ata_id_has_fua(id))
1844 return 0;
1845
Tejun Heo6a62a042006-02-13 10:02:46 +09001846 ata_id_c_string(id, model, ATA_ID_PROD_OFS, sizeof(model));
1847 ata_id_c_string(id, fw, ATA_ID_FW_REV_OFS, sizeof(fw));
Jens Axboe48bdc8e2006-01-30 16:09:35 +01001848
Tejun Heo2e026712006-02-12 22:47:04 +09001849 if (strcmp(model, "Maxtor"))
Jens Axboe48bdc8e2006-01-30 16:09:35 +01001850 return 1;
Tejun Heo2e026712006-02-12 22:47:04 +09001851 if (strcmp(fw, "BANC1G10"))
Jens Axboe48bdc8e2006-01-30 16:09:35 +01001852 return 1;
1853
1854 return 0; /* blacklisted */
1855}
1856
Linus Torvalds1da177e2005-04-16 15:20:36 -07001857/**
1858 * ata_scsiop_mode_sense - Simulate MODE SENSE 6, 10 commands
1859 * @args: device IDENTIFY data / SCSI command of interest.
1860 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1861 * @buflen: Response buffer length.
1862 *
Douglas Gilbert00ac37f2005-10-28 15:58:28 -04001863 * Simulate MODE SENSE commands. Assume this is invoked for direct
1864 * access devices (e.g. disks) only. There should be no block
1865 * descriptor for other device types.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001866 *
1867 * LOCKING:
1868 * spin_lock_irqsave(host_set lock)
1869 */
1870
1871unsigned int ata_scsiop_mode_sense(struct ata_scsi_args *args, u8 *rbuf,
1872 unsigned int buflen)
1873{
Tejun Heo9a3dccc2006-01-06 09:56:18 +01001874 struct ata_device *dev = args->dev;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001875 u8 *scsicmd = args->cmd->cmnd, *p, *last;
Douglas Gilbert00ac37f2005-10-28 15:58:28 -04001876 const u8 sat_blk_desc[] = {
1877 0, 0, 0, 0, /* number of blocks: sat unspecified */
1878 0,
1879 0, 0x2, 0x0 /* block length: 512 bytes */
1880 };
1881 u8 pg, spg;
1882 unsigned int ebd, page_control, six_byte, output_len, alloc_len, minlen;
Tejun Heo9a3dccc2006-01-06 09:56:18 +01001883 u8 dpofua;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001884
1885 VPRINTK("ENTER\n");
1886
1887 six_byte = (scsicmd[0] == MODE_SENSE);
Douglas Gilbert00ac37f2005-10-28 15:58:28 -04001888 ebd = !(scsicmd[1] & 0x8); /* dbd bit inverted == edb */
1889 /*
1890 * LLBA bit in msense(10) ignored (compliant)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001891 */
Douglas Gilbert00ac37f2005-10-28 15:58:28 -04001892
Linus Torvalds1da177e2005-04-16 15:20:36 -07001893 page_control = scsicmd[2] >> 6;
Douglas Gilbertae006512005-10-09 09:09:35 -04001894 switch (page_control) {
1895 case 0: /* current */
1896 break; /* supported */
1897 case 3: /* saved */
1898 goto saving_not_supp;
1899 case 1: /* changeable */
1900 case 2: /* defaults */
1901 default:
1902 goto invalid_fld;
1903 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001904
Douglas Gilbert00ac37f2005-10-28 15:58:28 -04001905 if (six_byte) {
1906 output_len = 4 + (ebd ? 8 : 0);
1907 alloc_len = scsicmd[4];
1908 } else {
1909 output_len = 8 + (ebd ? 8 : 0);
1910 alloc_len = (scsicmd[7] << 8) + scsicmd[8];
1911 }
1912 minlen = (alloc_len < buflen) ? alloc_len : buflen;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001913
1914 p = rbuf + output_len;
Douglas Gilbert00ac37f2005-10-28 15:58:28 -04001915 last = rbuf + minlen - 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001916
Douglas Gilbert00ac37f2005-10-28 15:58:28 -04001917 pg = scsicmd[2] & 0x3f;
1918 spg = scsicmd[3];
1919 /*
1920 * No mode subpages supported (yet) but asking for _all_
1921 * subpages may be valid
1922 */
1923 if (spg && (spg != ALL_SUB_MPAGES))
1924 goto invalid_fld;
1925
1926 switch(pg) {
1927 case RW_RECOVERY_MPAGE:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001928 output_len += ata_msense_rw_recovery(&p, last);
1929 break;
1930
Douglas Gilbert00ac37f2005-10-28 15:58:28 -04001931 case CACHE_MPAGE:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001932 output_len += ata_msense_caching(args->id, &p, last);
1933 break;
1934
Douglas Gilbert00ac37f2005-10-28 15:58:28 -04001935 case CONTROL_MPAGE: {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001936 output_len += ata_msense_ctl_mode(&p, last);
1937 break;
1938 }
1939
Douglas Gilbert00ac37f2005-10-28 15:58:28 -04001940 case ALL_MPAGES:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001941 output_len += ata_msense_rw_recovery(&p, last);
1942 output_len += ata_msense_caching(args->id, &p, last);
1943 output_len += ata_msense_ctl_mode(&p, last);
1944 break;
1945
1946 default: /* invalid page code */
Douglas Gilbertae006512005-10-09 09:09:35 -04001947 goto invalid_fld;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001948 }
1949
Douglas Gilbert00ac37f2005-10-28 15:58:28 -04001950 if (minlen < 1)
1951 return 0;
Tejun Heo9a3dccc2006-01-06 09:56:18 +01001952
1953 dpofua = 0;
Jens Axboe48bdc8e2006-01-30 16:09:35 +01001954 if (ata_dev_supports_fua(args->id) && dev->flags & ATA_DFLAG_LBA48 &&
Tejun Heo9a3dccc2006-01-06 09:56:18 +01001955 (!(dev->flags & ATA_DFLAG_PIO) || dev->multi_count))
1956 dpofua = 1 << 4;
1957
Linus Torvalds1da177e2005-04-16 15:20:36 -07001958 if (six_byte) {
1959 output_len--;
1960 rbuf[0] = output_len;
Tejun Heo9a3dccc2006-01-06 09:56:18 +01001961 if (minlen > 2)
1962 rbuf[2] |= dpofua;
Douglas Gilbert00ac37f2005-10-28 15:58:28 -04001963 if (ebd) {
1964 if (minlen > 3)
1965 rbuf[3] = sizeof(sat_blk_desc);
1966 if (minlen > 11)
1967 memcpy(rbuf + 4, sat_blk_desc,
1968 sizeof(sat_blk_desc));
1969 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001970 } else {
1971 output_len -= 2;
1972 rbuf[0] = output_len >> 8;
Douglas Gilbert00ac37f2005-10-28 15:58:28 -04001973 if (minlen > 1)
1974 rbuf[1] = output_len;
Tejun Heo9a3dccc2006-01-06 09:56:18 +01001975 if (minlen > 3)
1976 rbuf[3] |= dpofua;
Douglas Gilbert00ac37f2005-10-28 15:58:28 -04001977 if (ebd) {
1978 if (minlen > 7)
1979 rbuf[7] = sizeof(sat_blk_desc);
1980 if (minlen > 15)
1981 memcpy(rbuf + 8, sat_blk_desc,
1982 sizeof(sat_blk_desc));
1983 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001984 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001985 return 0;
Douglas Gilbertae006512005-10-09 09:09:35 -04001986
1987invalid_fld:
1988 ata_scsi_set_sense(args->cmd, ILLEGAL_REQUEST, 0x24, 0x0);
1989 /* "Invalid field in cbd" */
1990 return 1;
1991
1992saving_not_supp:
1993 ata_scsi_set_sense(args->cmd, ILLEGAL_REQUEST, 0x39, 0x0);
1994 /* "Saving parameters not supported" */
1995 return 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001996}
1997
1998/**
1999 * ata_scsiop_read_cap - Simulate READ CAPACITY[ 16] commands
2000 * @args: device IDENTIFY data / SCSI command of interest.
2001 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2002 * @buflen: Response buffer length.
2003 *
2004 * Simulate READ CAPACITY commands.
2005 *
2006 * LOCKING:
2007 * spin_lock_irqsave(host_set lock)
2008 */
2009
2010unsigned int ata_scsiop_read_cap(struct ata_scsi_args *args, u8 *rbuf,
2011 unsigned int buflen)
2012{
2013 u64 n_sectors;
2014 u32 tmp;
2015
2016 VPRINTK("ENTER\n");
2017
Albert Lee8bf62ece2005-05-12 15:29:42 -04002018 if (ata_id_has_lba(args->id)) {
2019 if (ata_id_has_lba48(args->id))
2020 n_sectors = ata_id_u64(args->id, 100);
2021 else
2022 n_sectors = ata_id_u32(args->id, 60);
2023 } else {
2024 /* CHS default translation */
2025 n_sectors = args->id[1] * args->id[3] * args->id[6];
2026
2027 if (ata_id_current_chs_valid(args->id))
2028 /* CHS current translation */
2029 n_sectors = ata_id_u32(args->id, 57);
2030 }
2031
Linus Torvalds1da177e2005-04-16 15:20:36 -07002032 n_sectors--; /* ATA TotalUserSectors - 1 */
2033
Linus Torvalds1da177e2005-04-16 15:20:36 -07002034 if (args->cmd->cmnd[0] == READ_CAPACITY) {
Philip Pokorny0c144d02005-05-28 01:24:47 -07002035 if( n_sectors >= 0xffffffffULL )
2036 tmp = 0xffffffff ; /* Return max count on overflow */
2037 else
2038 tmp = n_sectors ;
2039
Linus Torvalds1da177e2005-04-16 15:20:36 -07002040 /* sector count, 32-bit */
2041 rbuf[0] = tmp >> (8 * 3);
2042 rbuf[1] = tmp >> (8 * 2);
2043 rbuf[2] = tmp >> (8 * 1);
2044 rbuf[3] = tmp;
2045
2046 /* sector size */
2047 tmp = ATA_SECT_SIZE;
2048 rbuf[6] = tmp >> 8;
2049 rbuf[7] = tmp;
2050
2051 } else {
2052 /* sector count, 64-bit */
Philip Pokorny0c144d02005-05-28 01:24:47 -07002053 tmp = n_sectors >> (8 * 4);
2054 rbuf[2] = tmp >> (8 * 3);
2055 rbuf[3] = tmp >> (8 * 2);
2056 rbuf[4] = tmp >> (8 * 1);
2057 rbuf[5] = tmp;
2058 tmp = n_sectors;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002059 rbuf[6] = tmp >> (8 * 3);
2060 rbuf[7] = tmp >> (8 * 2);
2061 rbuf[8] = tmp >> (8 * 1);
2062 rbuf[9] = tmp;
2063
2064 /* sector size */
2065 tmp = ATA_SECT_SIZE;
2066 rbuf[12] = tmp >> 8;
2067 rbuf[13] = tmp;
2068 }
2069
2070 return 0;
2071}
2072
2073/**
2074 * ata_scsiop_report_luns - Simulate REPORT LUNS command
2075 * @args: device IDENTIFY data / SCSI command of interest.
2076 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2077 * @buflen: Response buffer length.
2078 *
2079 * Simulate REPORT LUNS command.
2080 *
2081 * LOCKING:
2082 * spin_lock_irqsave(host_set lock)
2083 */
2084
2085unsigned int ata_scsiop_report_luns(struct ata_scsi_args *args, u8 *rbuf,
2086 unsigned int buflen)
2087{
2088 VPRINTK("ENTER\n");
2089 rbuf[3] = 8; /* just one lun, LUN 0, size 8 bytes */
2090
2091 return 0;
2092}
2093
2094/**
Douglas Gilbert845c5832005-10-09 08:55:41 -04002095 * ata_scsi_set_sense - Set SCSI sense data and status
2096 * @cmd: SCSI request to be handled
2097 * @sk: SCSI-defined sense key
2098 * @asc: SCSI-defined additional sense code
2099 * @ascq: SCSI-defined additional sense code qualifier
2100 *
2101 * Helper function that builds a valid fixed format, current
2102 * response code and the given sense key (sk), additional sense
2103 * code (asc) and additional sense code qualifier (ascq) with
2104 * a SCSI command status of %SAM_STAT_CHECK_CONDITION and
2105 * DRIVER_SENSE set in the upper bits of scsi_cmnd::result .
2106 *
2107 * LOCKING:
2108 * Not required
2109 */
2110
2111void ata_scsi_set_sense(struct scsi_cmnd *cmd, u8 sk, u8 asc, u8 ascq)
2112{
2113 cmd->result = (DRIVER_SENSE << 24) | SAM_STAT_CHECK_CONDITION;
2114
2115 cmd->sense_buffer[0] = 0x70; /* fixed format, current */
2116 cmd->sense_buffer[2] = sk;
2117 cmd->sense_buffer[7] = 18 - 8; /* additional sense length */
2118 cmd->sense_buffer[12] = asc;
2119 cmd->sense_buffer[13] = ascq;
2120}
2121
2122/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07002123 * ata_scsi_badcmd - End a SCSI request with an error
2124 * @cmd: SCSI request to be handled
2125 * @done: SCSI command completion function
2126 * @asc: SCSI-defined additional sense code
2127 * @ascq: SCSI-defined additional sense code qualifier
2128 *
2129 * Helper function that completes a SCSI command with
2130 * %SAM_STAT_CHECK_CONDITION, with a sense key %ILLEGAL_REQUEST
2131 * and the specified additional sense codes.
2132 *
2133 * LOCKING:
2134 * spin_lock_irqsave(host_set lock)
2135 */
2136
2137void ata_scsi_badcmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *), u8 asc, u8 ascq)
2138{
2139 DPRINTK("ENTER\n");
Douglas Gilbertae006512005-10-09 09:09:35 -04002140 ata_scsi_set_sense(cmd, ILLEGAL_REQUEST, asc, ascq);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002141
2142 done(cmd);
2143}
2144
Tejun Heo77853bf2006-01-23 13:09:36 +09002145static void atapi_sense_complete(struct ata_queued_cmd *qc)
Jeff Garzika939c962005-10-05 17:09:16 -04002146{
Albert Leea22e2eb2005-12-05 15:38:02 +08002147 if (qc->err_mask && ((qc->err_mask & AC_ERR_DEV) == 0))
Jeff Garzikc6e6e6662005-11-14 14:50:05 -05002148 /* FIXME: not quite right; we don't want the
2149 * translation of taskfile registers into
2150 * a sense descriptors, since that's only
2151 * correct for ATA, not ATAPI
2152 */
2153 ata_gen_ata_desc_sense(qc);
2154
2155 qc->scsidone(qc->scsicmd);
Tejun Heo77853bf2006-01-23 13:09:36 +09002156 ata_qc_free(qc);
Jeff Garzikc6e6e6662005-11-14 14:50:05 -05002157}
2158
2159/* is it pointless to prefer PIO for "safety reasons"? */
2160static inline int ata_pio_use_silly(struct ata_port *ap)
2161{
2162 return (ap->flags & ATA_FLAG_PIO_DMA);
2163}
2164
2165static void atapi_request_sense(struct ata_queued_cmd *qc)
2166{
2167 struct ata_port *ap = qc->ap;
2168 struct scsi_cmnd *cmd = qc->scsicmd;
Jeff Garzika939c962005-10-05 17:09:16 -04002169
2170 DPRINTK("ATAPI request sense\n");
2171
Jeff Garzika939c962005-10-05 17:09:16 -04002172 /* FIXME: is this needed? */
2173 memset(cmd->sense_buffer, 0, sizeof(cmd->sense_buffer));
2174
Jeff Garzikc6e6e6662005-11-14 14:50:05 -05002175 ap->ops->tf_read(ap, &qc->tf);
2176
2177 /* fill these in, for the case where they are -not- overwritten */
2178 cmd->sense_buffer[0] = 0x70;
2179 cmd->sense_buffer[2] = qc->tf.feature >> 4;
2180
2181 ata_qc_reinit(qc);
2182
Jeff Garzika939c962005-10-05 17:09:16 -04002183 ata_sg_init_one(qc, cmd->sense_buffer, sizeof(cmd->sense_buffer));
2184 qc->dma_dir = DMA_FROM_DEVICE;
2185
Tejun Heo6e7846e2006-02-12 23:32:58 +09002186 memset(&qc->cdb, 0, qc->dev->cdb_len);
Jeff Garzika939c962005-10-05 17:09:16 -04002187 qc->cdb[0] = REQUEST_SENSE;
2188 qc->cdb[4] = SCSI_SENSE_BUFFERSIZE;
2189
2190 qc->tf.flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
2191 qc->tf.command = ATA_CMD_PACKET;
2192
Jeff Garzikc6e6e6662005-11-14 14:50:05 -05002193 if (ata_pio_use_silly(ap)) {
2194 qc->tf.protocol = ATA_PROT_ATAPI_DMA;
2195 qc->tf.feature |= ATAPI_PKT_DMA;
2196 } else {
2197 qc->tf.protocol = ATA_PROT_ATAPI;
2198 qc->tf.lbam = (8 * 1024) & 0xff;
2199 qc->tf.lbah = (8 * 1024) >> 8;
2200 }
Jeff Garzika939c962005-10-05 17:09:16 -04002201 qc->nbytes = SCSI_SENSE_BUFFERSIZE;
2202
Jeff Garzikc6e6e6662005-11-14 14:50:05 -05002203 qc->complete_fn = atapi_sense_complete;
Jeff Garzika939c962005-10-05 17:09:16 -04002204
Tejun Heo9a3d9eb2006-01-23 13:09:36 +09002205 qc->err_mask = ata_qc_issue(qc);
2206 if (qc->err_mask)
Albert Leea22e2eb2005-12-05 15:38:02 +08002207 ata_qc_complete(qc);
Jeff Garzika939c962005-10-05 17:09:16 -04002208
2209 DPRINTK("EXIT\n");
2210}
2211
Tejun Heo77853bf2006-01-23 13:09:36 +09002212static void atapi_qc_complete(struct ata_queued_cmd *qc)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002213{
2214 struct scsi_cmnd *cmd = qc->scsicmd;
Albert Leea22e2eb2005-12-05 15:38:02 +08002215 unsigned int err_mask = qc->err_mask;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002216
Jeff Garzika7dac442005-10-30 04:44:42 -05002217 VPRINTK("ENTER, err_mask 0x%X\n", err_mask);
Jeff Garzike12669e2005-10-05 18:39:23 -04002218
Jeff Garzika7dac442005-10-30 04:44:42 -05002219 if (unlikely(err_mask & AC_ERR_DEV)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002220 cmd->result = SAM_STAT_CHECK_CONDITION;
Jeff Garzikc6e6e6662005-11-14 14:50:05 -05002221 atapi_request_sense(qc);
Tejun Heo77853bf2006-01-23 13:09:36 +09002222 return;
Jeff Garzike12669e2005-10-05 18:39:23 -04002223 }
2224
Jeff Garzika7dac442005-10-30 04:44:42 -05002225 else if (unlikely(err_mask))
2226 /* FIXME: not quite right; we don't want the
2227 * translation of taskfile registers into
2228 * a sense descriptors, since that's only
2229 * correct for ATA, not ATAPI
2230 */
2231 ata_gen_ata_desc_sense(qc);
2232
Jeff Garzike12669e2005-10-05 18:39:23 -04002233 else {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002234 u8 *scsicmd = cmd->cmnd;
2235
Tony Battersbyfd71da42005-12-21 16:35:44 -05002236 if ((scsicmd[0] == INQUIRY) && ((scsicmd[1] & 0x03) == 0)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002237 u8 *buf = NULL;
2238 unsigned int buflen;
2239
2240 buflen = ata_scsi_rbuf_get(cmd, &buf);
Jeff Garzika15dbeb2005-10-05 15:02:14 -04002241
2242 /* ATAPI devices typically report zero for their SCSI version,
2243 * and sometimes deviate from the spec WRT response data
2244 * format. If SCSI version is reported as zero like normal,
2245 * then we make the following fixups: 1) Fake MMC-5 version,
2246 * to indicate to the Linux scsi midlayer this is a modern
2247 * device. 2) Ensure response data format / ATAPI information
2248 * are always correct.
2249 */
Jeff Garzika15dbeb2005-10-05 15:02:14 -04002250 if (buf[2] == 0) {
2251 buf[2] = 0x5;
2252 buf[3] = 0x32;
2253 }
2254
Linus Torvalds1da177e2005-04-16 15:20:36 -07002255 ata_scsi_rbuf_put(cmd, buf);
2256 }
Jeff Garzika15dbeb2005-10-05 15:02:14 -04002257
Linus Torvalds1da177e2005-04-16 15:20:36 -07002258 cmd->result = SAM_STAT_GOOD;
2259 }
2260
2261 qc->scsidone(cmd);
Tejun Heo77853bf2006-01-23 13:09:36 +09002262 ata_qc_free(qc);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002263}
2264/**
2265 * atapi_xlat - Initialize PACKET taskfile
2266 * @qc: command structure to be initialized
2267 * @scsicmd: SCSI CDB associated with this PACKET command
2268 *
2269 * LOCKING:
2270 * spin_lock_irqsave(host_set lock)
2271 *
2272 * RETURNS:
2273 * Zero on success, non-zero on failure.
2274 */
2275
Jeff Garzik057ace52005-10-22 14:27:05 -04002276static unsigned int atapi_xlat(struct ata_queued_cmd *qc, const u8 *scsicmd)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002277{
2278 struct scsi_cmnd *cmd = qc->scsicmd;
2279 struct ata_device *dev = qc->dev;
2280 int using_pio = (dev->flags & ATA_DFLAG_PIO);
be7db052005-04-17 15:26:13 -05002281 int nodata = (cmd->sc_data_direction == DMA_NONE);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002282
2283 if (!using_pio)
2284 /* Check whether ATAPI DMA is safe */
2285 if (ata_check_atapi_dma(qc))
2286 using_pio = 1;
2287
Tejun Heo6e7846e2006-02-12 23:32:58 +09002288 memcpy(&qc->cdb, scsicmd, dev->cdb_len);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002289
2290 qc->complete_fn = atapi_qc_complete;
2291
2292 qc->tf.flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
be7db052005-04-17 15:26:13 -05002293 if (cmd->sc_data_direction == DMA_TO_DEVICE) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002294 qc->tf.flags |= ATA_TFLAG_WRITE;
2295 DPRINTK("direction: write\n");
2296 }
2297
2298 qc->tf.command = ATA_CMD_PACKET;
2299
2300 /* no data, or PIO data xfer */
2301 if (using_pio || nodata) {
2302 if (nodata)
2303 qc->tf.protocol = ATA_PROT_ATAPI_NODATA;
2304 else
2305 qc->tf.protocol = ATA_PROT_ATAPI;
2306 qc->tf.lbam = (8 * 1024) & 0xff;
2307 qc->tf.lbah = (8 * 1024) >> 8;
2308 }
2309
2310 /* DMA data xfer */
2311 else {
2312 qc->tf.protocol = ATA_PROT_ATAPI_DMA;
2313 qc->tf.feature |= ATAPI_PKT_DMA;
2314
2315#ifdef ATAPI_ENABLE_DMADIR
2316 /* some SATA bridges need us to indicate data xfer direction */
be7db052005-04-17 15:26:13 -05002317 if (cmd->sc_data_direction != DMA_TO_DEVICE)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002318 qc->tf.feature |= ATAPI_DMADIR;
2319#endif
2320 }
2321
2322 qc->nbytes = cmd->bufflen;
2323
2324 return 0;
2325}
2326
2327/**
2328 * ata_scsi_find_dev - lookup ata_device from scsi_cmnd
2329 * @ap: ATA port to which the device is attached
2330 * @scsidev: SCSI device from which we derive the ATA device
2331 *
2332 * Given various information provided in struct scsi_cmnd,
2333 * map that onto an ATA bus, and using that mapping
2334 * determine which ata_device is associated with the
2335 * SCSI command to be sent.
2336 *
2337 * LOCKING:
2338 * spin_lock_irqsave(host_set lock)
2339 *
2340 * RETURNS:
2341 * Associated ATA device, or %NULL if not found.
2342 */
2343
2344static struct ata_device *
Jeff Garzik057ace52005-10-22 14:27:05 -04002345ata_scsi_find_dev(struct ata_port *ap, const struct scsi_device *scsidev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002346{
2347 struct ata_device *dev;
2348
2349 /* skip commands not addressed to targets we simulate */
2350 if (likely(scsidev->id < ATA_MAX_DEVICES))
2351 dev = &ap->device[scsidev->id];
2352 else
2353 return NULL;
2354
2355 if (unlikely((scsidev->channel != 0) ||
2356 (scsidev->lun != 0)))
2357 return NULL;
2358
2359 if (unlikely(!ata_dev_present(dev)))
2360 return NULL;
2361
Jeff Garzik50630192005-12-13 02:29:45 -05002362 if (!atapi_enabled || (ap->flags & ATA_FLAG_NO_ATAPI)) {
2363 if (unlikely(dev->class == ATA_DEV_ATAPI)) {
2364 printk(KERN_WARNING "ata%u(%u): WARNING: ATAPI is %s, device ignored.\n",
2365 ap->id, dev->devno, atapi_enabled ? "not supported with this driver" : "disabled");
Jeff Garzik1623c812005-08-30 03:37:42 -04002366 return NULL;
Jeff Garzik50630192005-12-13 02:29:45 -05002367 }
Jeff Garzik1623c812005-08-30 03:37:42 -04002368 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002369
2370 return dev;
2371}
2372
Jeff Garzikb0955182005-05-12 15:45:22 -04002373/*
2374 * ata_scsi_map_proto - Map pass-thru protocol value to taskfile value.
2375 * @byte1: Byte 1 from pass-thru CDB.
2376 *
2377 * RETURNS:
2378 * ATA_PROT_UNKNOWN if mapping failed/unimplemented, protocol otherwise.
2379 */
2380static u8
2381ata_scsi_map_proto(u8 byte1)
2382{
2383 switch((byte1 & 0x1e) >> 1) {
2384 case 3: /* Non-data */
2385 return ATA_PROT_NODATA;
2386
2387 case 6: /* DMA */
2388 return ATA_PROT_DMA;
2389
2390 case 4: /* PIO Data-in */
2391 case 5: /* PIO Data-out */
Jeff Garzikb0955182005-05-12 15:45:22 -04002392 return ATA_PROT_PIO;
2393
2394 case 10: /* Device Reset */
2395 case 0: /* Hard Reset */
2396 case 1: /* SRST */
2397 case 2: /* Bus Idle */
2398 case 7: /* Packet */
2399 case 8: /* DMA Queued */
2400 case 9: /* Device Diagnostic */
2401 case 11: /* UDMA Data-in */
2402 case 12: /* UDMA Data-Out */
2403 case 13: /* FPDMA */
2404 default: /* Reserved */
2405 break;
2406 }
2407
2408 return ATA_PROT_UNKNOWN;
2409}
2410
2411/**
2412 * ata_scsi_pass_thru - convert ATA pass-thru CDB to taskfile
2413 * @qc: command structure to be initialized
Randy Dunlap8e8b77d2005-11-01 21:29:27 -08002414 * @scsicmd: SCSI command to convert
Jeff Garzikb0955182005-05-12 15:45:22 -04002415 *
2416 * Handles either 12 or 16-byte versions of the CDB.
2417 *
2418 * RETURNS:
2419 * Zero on success, non-zero on failure.
2420 */
2421static unsigned int
Douglas Gilbert00ac37f2005-10-28 15:58:28 -04002422ata_scsi_pass_thru(struct ata_queued_cmd *qc, const u8 *scsicmd)
Jeff Garzikb0955182005-05-12 15:45:22 -04002423{
2424 struct ata_taskfile *tf = &(qc->tf);
2425 struct scsi_cmnd *cmd = qc->scsicmd;
2426
2427 if ((tf->protocol = ata_scsi_map_proto(scsicmd[1])) == ATA_PROT_UNKNOWN)
Tejun Heo9a405252005-12-02 11:49:11 +09002428 goto invalid_fld;
Jeff Garzikb0955182005-05-12 15:45:22 -04002429
Albert Leef59b0cf2006-03-16 17:59:22 +08002430 if (scsicmd[1] & 0xe0)
2431 /* PIO multi not supported yet */
2432 goto invalid_fld;
2433
Jeff Garzikb0955182005-05-12 15:45:22 -04002434 /*
2435 * 12 and 16 byte CDBs use different offsets to
2436 * provide the various register values.
2437 */
2438 if (scsicmd[0] == ATA_16) {
2439 /*
2440 * 16-byte CDB - may contain extended commands.
2441 *
2442 * If that is the case, copy the upper byte register values.
2443 */
2444 if (scsicmd[1] & 0x01) {
2445 tf->hob_feature = scsicmd[3];
2446 tf->hob_nsect = scsicmd[5];
2447 tf->hob_lbal = scsicmd[7];
2448 tf->hob_lbam = scsicmd[9];
2449 tf->hob_lbah = scsicmd[11];
2450 tf->flags |= ATA_TFLAG_LBA48;
2451 } else
2452 tf->flags &= ~ATA_TFLAG_LBA48;
2453
2454 /*
2455 * Always copy low byte, device and command registers.
2456 */
2457 tf->feature = scsicmd[4];
2458 tf->nsect = scsicmd[6];
2459 tf->lbal = scsicmd[8];
2460 tf->lbam = scsicmd[10];
2461 tf->lbah = scsicmd[12];
2462 tf->device = scsicmd[13];
2463 tf->command = scsicmd[14];
2464 } else {
2465 /*
2466 * 12-byte CDB - incapable of extended commands.
2467 */
2468 tf->flags &= ~ATA_TFLAG_LBA48;
2469
2470 tf->feature = scsicmd[3];
2471 tf->nsect = scsicmd[4];
2472 tf->lbal = scsicmd[5];
2473 tf->lbam = scsicmd[6];
2474 tf->lbah = scsicmd[7];
2475 tf->device = scsicmd[8];
2476 tf->command = scsicmd[9];
2477 }
Mark Lorddcc2d1e2005-11-13 16:22:06 -05002478 /*
2479 * If slave is possible, enforce correct master/slave bit
2480 */
2481 if (qc->ap->flags & ATA_FLAG_SLAVE_POSS)
2482 tf->device = qc->dev->devno ?
2483 tf->device | ATA_DEV1 : tf->device & ~ATA_DEV1;
Jeff Garzikb0955182005-05-12 15:45:22 -04002484
2485 /*
2486 * Filter SET_FEATURES - XFER MODE command -- otherwise,
2487 * SET_FEATURES - XFER MODE must be preceded/succeeded
2488 * by an update to hardware-specific registers for each
2489 * controller (i.e. the reason for ->set_piomode(),
2490 * ->set_dmamode(), and ->post_set_mode() hooks).
2491 */
2492 if ((tf->command == ATA_CMD_SET_FEATURES)
2493 && (tf->feature == SETFEATURES_XFER))
Tejun Heo9a405252005-12-02 11:49:11 +09002494 goto invalid_fld;
Jeff Garzikb0955182005-05-12 15:45:22 -04002495
2496 /*
2497 * Set flags so that all registers will be written,
2498 * and pass on write indication (used for PIO/DMA
2499 * setup.)
2500 */
2501 tf->flags |= (ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE);
2502
Jeff Garzik0274aa22005-06-22 13:50:56 -04002503 if (cmd->sc_data_direction == DMA_TO_DEVICE)
Jeff Garzikb0955182005-05-12 15:45:22 -04002504 tf->flags |= ATA_TFLAG_WRITE;
2505
2506 /*
2507 * Set transfer length.
2508 *
2509 * TODO: find out if we need to do more here to
2510 * cover scatter/gather case.
2511 */
2512 qc->nsect = cmd->bufflen / ATA_SECT_SIZE;
2513
2514 return 0;
Tejun Heo9a405252005-12-02 11:49:11 +09002515
2516 invalid_fld:
2517 ata_scsi_set_sense(qc->scsicmd, ILLEGAL_REQUEST, 0x24, 0x00);
2518 /* "Invalid field in cdb" */
2519 return 1;
Jeff Garzikb0955182005-05-12 15:45:22 -04002520}
2521
Linus Torvalds1da177e2005-04-16 15:20:36 -07002522/**
2523 * ata_get_xlat_func - check if SCSI to ATA translation is possible
2524 * @dev: ATA device
2525 * @cmd: SCSI command opcode to consider
2526 *
2527 * Look up the SCSI command given, and determine whether the
2528 * SCSI command is to be translated or simulated.
2529 *
2530 * RETURNS:
2531 * Pointer to translation function if possible, %NULL if not.
2532 */
2533
2534static inline ata_xlat_func_t ata_get_xlat_func(struct ata_device *dev, u8 cmd)
2535{
2536 switch (cmd) {
2537 case READ_6:
2538 case READ_10:
2539 case READ_16:
2540
2541 case WRITE_6:
2542 case WRITE_10:
2543 case WRITE_16:
2544 return ata_scsi_rw_xlat;
2545
2546 case SYNCHRONIZE_CACHE:
2547 if (ata_try_flush_cache(dev))
2548 return ata_scsi_flush_xlat;
2549 break;
2550
2551 case VERIFY:
2552 case VERIFY_16:
2553 return ata_scsi_verify_xlat;
Jeff Garzikb0955182005-05-12 15:45:22 -04002554
2555 case ATA_12:
2556 case ATA_16:
2557 return ata_scsi_pass_thru;
Jeff Garzikda613962005-08-29 19:01:43 -04002558
Douglas Gilbert972dcaf2005-08-11 03:35:53 -04002559 case START_STOP:
2560 return ata_scsi_start_stop_xlat;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002561 }
2562
2563 return NULL;
2564}
2565
2566/**
2567 * ata_scsi_dump_cdb - dump SCSI command contents to dmesg
2568 * @ap: ATA port to which the command was being sent
2569 * @cmd: SCSI command to dump
2570 *
2571 * Prints the contents of a SCSI command via printk().
2572 */
2573
2574static inline void ata_scsi_dump_cdb(struct ata_port *ap,
2575 struct scsi_cmnd *cmd)
2576{
2577#ifdef ATA_DEBUG
2578 struct scsi_device *scsidev = cmd->device;
2579 u8 *scsicmd = cmd->cmnd;
2580
2581 DPRINTK("CDB (%u:%d,%d,%d) %02x %02x %02x %02x %02x %02x %02x %02x %02x\n",
2582 ap->id,
2583 scsidev->channel, scsidev->id, scsidev->lun,
2584 scsicmd[0], scsicmd[1], scsicmd[2], scsicmd[3],
2585 scsicmd[4], scsicmd[5], scsicmd[6], scsicmd[7],
2586 scsicmd[8]);
2587#endif
2588}
2589
2590/**
2591 * ata_scsi_queuecmd - Issue SCSI cdb to libata-managed device
2592 * @cmd: SCSI command to be sent
2593 * @done: Completion function, called when command is complete
2594 *
2595 * In some cases, this function translates SCSI commands into
2596 * ATA taskfiles, and queues the taskfiles to be sent to
2597 * hardware. In other cases, this function simulates a
2598 * SCSI device by evaluating and responding to certain
2599 * SCSI commands. This creates the overall effect of
2600 * ATA and ATAPI devices appearing as SCSI devices.
2601 *
2602 * LOCKING:
2603 * Releases scsi-layer-held lock, and obtains host_set lock.
2604 *
2605 * RETURNS:
2606 * Zero.
2607 */
2608
2609int ata_scsi_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *))
2610{
2611 struct ata_port *ap;
2612 struct ata_device *dev;
2613 struct scsi_device *scsidev = cmd->device;
Jeff Garzik005a5a02005-10-30 23:31:48 -05002614 struct Scsi_Host *shost = scsidev->host;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002615
Jeff Garzik005a5a02005-10-30 23:31:48 -05002616 ap = (struct ata_port *) &shost->hostdata[0];
2617
2618 spin_unlock(shost->host_lock);
2619 spin_lock(&ap->host_set->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002620
2621 ata_scsi_dump_cdb(ap, cmd);
2622
2623 dev = ata_scsi_find_dev(ap, scsidev);
2624 if (unlikely(!dev)) {
2625 cmd->result = (DID_BAD_TARGET << 16);
2626 done(cmd);
2627 goto out_unlock;
2628 }
2629
2630 if (dev->class == ATA_DEV_ATA) {
2631 ata_xlat_func_t xlat_func = ata_get_xlat_func(dev,
2632 cmd->cmnd[0]);
2633
2634 if (xlat_func)
2635 ata_scsi_translate(ap, dev, cmd, done, xlat_func);
2636 else
Tejun Heo9a3dccc2006-01-06 09:56:18 +01002637 ata_scsi_simulate(ap, dev, cmd, done);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002638 } else
2639 ata_scsi_translate(ap, dev, cmd, done, atapi_xlat);
2640
2641out_unlock:
Jeff Garzik005a5a02005-10-30 23:31:48 -05002642 spin_unlock(&ap->host_set->lock);
2643 spin_lock(shost->host_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002644 return 0;
2645}
2646
2647/**
2648 * ata_scsi_simulate - simulate SCSI command on ATA device
Randy Dunlapc893a3a2006-01-28 13:15:32 -05002649 * @ap: port the device is connected to
2650 * @dev: the target device
Linus Torvalds1da177e2005-04-16 15:20:36 -07002651 * @cmd: SCSI command being sent to device.
2652 * @done: SCSI command completion function.
2653 *
2654 * Interprets and directly executes a select list of SCSI commands
2655 * that can be handled internally.
2656 *
2657 * LOCKING:
2658 * spin_lock_irqsave(host_set lock)
2659 */
2660
Tejun Heo9a3dccc2006-01-06 09:56:18 +01002661void ata_scsi_simulate(struct ata_port *ap, struct ata_device *dev,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002662 struct scsi_cmnd *cmd,
2663 void (*done)(struct scsi_cmnd *))
2664{
2665 struct ata_scsi_args args;
Jeff Garzik057ace52005-10-22 14:27:05 -04002666 const u8 *scsicmd = cmd->cmnd;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002667
Tejun Heo9a3dccc2006-01-06 09:56:18 +01002668 args.ap = ap;
2669 args.dev = dev;
2670 args.id = dev->id;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002671 args.cmd = cmd;
2672 args.done = done;
2673
2674 switch(scsicmd[0]) {
2675 /* no-op's, complete with success */
2676 case SYNCHRONIZE_CACHE:
2677 case REZERO_UNIT:
2678 case SEEK_6:
2679 case SEEK_10:
2680 case TEST_UNIT_READY:
2681 case FORMAT_UNIT: /* FIXME: correct? */
2682 case SEND_DIAGNOSTIC: /* FIXME: correct? */
2683 ata_scsi_rbuf_fill(&args, ata_scsiop_noop);
2684 break;
2685
2686 case INQUIRY:
2687 if (scsicmd[1] & 2) /* is CmdDt set? */
Douglas Gilbertae006512005-10-09 09:09:35 -04002688 ata_scsi_invalid_field(cmd, done);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002689 else if ((scsicmd[1] & 1) == 0) /* is EVPD clear? */
2690 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_std);
2691 else if (scsicmd[2] == 0x00)
2692 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_00);
2693 else if (scsicmd[2] == 0x80)
2694 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_80);
2695 else if (scsicmd[2] == 0x83)
2696 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_83);
2697 else
Douglas Gilbertae006512005-10-09 09:09:35 -04002698 ata_scsi_invalid_field(cmd, done);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002699 break;
2700
2701 case MODE_SENSE:
2702 case MODE_SENSE_10:
2703 ata_scsi_rbuf_fill(&args, ata_scsiop_mode_sense);
2704 break;
2705
2706 case MODE_SELECT: /* unconditionally return */
2707 case MODE_SELECT_10: /* bad-field-in-cdb */
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 READ_CAPACITY:
2712 ata_scsi_rbuf_fill(&args, ata_scsiop_read_cap);
2713 break;
2714
2715 case SERVICE_ACTION_IN:
2716 if ((scsicmd[1] & 0x1f) == SAI_READ_CAPACITY_16)
2717 ata_scsi_rbuf_fill(&args, ata_scsiop_read_cap);
2718 else
Douglas Gilbertae006512005-10-09 09:09:35 -04002719 ata_scsi_invalid_field(cmd, done);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002720 break;
2721
2722 case REPORT_LUNS:
2723 ata_scsi_rbuf_fill(&args, ata_scsiop_report_luns);
2724 break;
2725
Jeff Garzikb0955182005-05-12 15:45:22 -04002726 /* mandatory commands we haven't implemented yet */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002727 case REQUEST_SENSE:
2728
2729 /* all other commands */
2730 default:
Douglas Gilbertae006512005-10-09 09:09:35 -04002731 ata_scsi_set_sense(cmd, ILLEGAL_REQUEST, 0x20, 0x0);
2732 /* "Invalid command operation code" */
2733 done(cmd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002734 break;
2735 }
2736}
2737
Jeff Garzik644dd0c2005-10-03 15:55:19 -04002738void ata_scsi_scan_host(struct ata_port *ap)
2739{
Jeff Garzik3f19ee82005-10-03 21:36:41 -04002740 struct ata_device *dev;
Jeff Garzik644dd0c2005-10-03 15:55:19 -04002741 unsigned int i;
2742
2743 if (ap->flags & ATA_FLAG_PORT_DISABLED)
2744 return;
2745
Jeff Garzik3f19ee82005-10-03 21:36:41 -04002746 for (i = 0; i < ATA_MAX_DEVICES; i++) {
2747 dev = &ap->device[i];
2748
2749 if (ata_dev_present(dev))
2750 scsi_scan_target(&ap->host->shost_gendev, 0, i, 0, 0);
2751 }
Jeff Garzik644dd0c2005-10-03 15:55:19 -04002752}
2753