blob: 7e37f488f591d5240f1371f265c583aa9c735944 [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>
Jeff Garzik005a5a02005-10-30 23:31:48 -050041#include <scsi/scsi_device.h>
Jeff Garzik193515d2005-11-07 00:59:37 -050042#include <scsi/scsi_request.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070043#include <linux/libata.h>
Jeff Garzikb0955182005-05-12 15:45:22 -040044#include <linux/hdreg.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070045#include <asm/uaccess.h>
46
47#include "libata.h"
48
Jeff Garzikb0955182005-05-12 15:45:22 -040049#define SECTOR_SIZE 512
50
Jeff Garzik057ace52005-10-22 14:27:05 -040051typedef unsigned int (*ata_xlat_func_t)(struct ata_queued_cmd *qc, const u8 *scsicmd);
Linus Torvalds1da177e2005-04-16 15:20:36 -070052static struct ata_device *
Jeff Garzik057ace52005-10-22 14:27:05 -040053ata_scsi_find_dev(struct ata_port *ap, const struct scsi_device *scsidev);
Linus Torvalds1da177e2005-04-16 15:20:36 -070054
Douglas Gilbert00ac37f2005-10-28 15:58:28 -040055#define RW_RECOVERY_MPAGE 0x1
56#define RW_RECOVERY_MPAGE_LEN 12
57#define CACHE_MPAGE 0x8
58#define CACHE_MPAGE_LEN 20
59#define CONTROL_MPAGE 0xa
60#define CONTROL_MPAGE_LEN 12
61#define ALL_MPAGES 0x3f
62#define ALL_SUB_MPAGES 0xff
63
64
65static const u8 def_rw_recovery_mpage[] = {
66 RW_RECOVERY_MPAGE,
67 RW_RECOVERY_MPAGE_LEN - 2,
68 (1 << 7) | /* AWRE, sat-r06 say it shall be 0 */
69 (1 << 6), /* ARRE (auto read reallocation) */
70 0, /* read retry count */
71 0, 0, 0, 0,
72 0, /* write retry count */
73 0, 0, 0
74};
75
76static const u8 def_cache_mpage[CACHE_MPAGE_LEN] = {
77 CACHE_MPAGE,
78 CACHE_MPAGE_LEN - 2,
79 0, /* contains WCE, needs to be 0 for logic */
80 0, 0, 0, 0, 0, 0, 0, 0, 0,
81 0, /* contains DRA, needs to be 0 for logic */
82 0, 0, 0, 0, 0, 0, 0
83};
84
85static const u8 def_control_mpage[CONTROL_MPAGE_LEN] = {
86 CONTROL_MPAGE,
87 CONTROL_MPAGE_LEN - 2,
88 2, /* DSENSE=0, GLTSD=1 */
89 0, /* [QAM+QERR may be 1, see 05-359r1] */
90 0, 0, 0, 0, 0xff, 0xff,
91 0, 30 /* extended self test time, see 05-359r1 */
92};
93
Linus Torvalds1da177e2005-04-16 15:20:36 -070094
Douglas Gilbertae006512005-10-09 09:09:35 -040095static void ata_scsi_invalid_field(struct scsi_cmnd *cmd,
96 void (*done)(struct scsi_cmnd *))
97{
98 ata_scsi_set_sense(cmd, ILLEGAL_REQUEST, 0x24, 0x0);
99 /* "Invalid field in cbd" */
100 done(cmd);
101}
102
Linus Torvalds1da177e2005-04-16 15:20:36 -0700103/**
104 * ata_std_bios_param - generic bios head/sector/cylinder calculator used by sd.
105 * @sdev: SCSI device for which BIOS geometry is to be determined
106 * @bdev: block device associated with @sdev
107 * @capacity: capacity of SCSI device
108 * @geom: location to which geometry will be output
109 *
110 * Generic bios head/sector/cylinder calculator
111 * used by sd. Most BIOSes nowadays expect a XXX/255/16 (CHS)
112 * mapping. Some situations may arise where the disk is not
113 * bootable if this is not used.
114 *
115 * LOCKING:
116 * Defined by the SCSI layer. We don't really care.
117 *
118 * RETURNS:
119 * Zero.
120 */
121int ata_std_bios_param(struct scsi_device *sdev, struct block_device *bdev,
122 sector_t capacity, int geom[])
123{
124 geom[0] = 255;
125 geom[1] = 63;
126 sector_div(capacity, 255*63);
127 geom[2] = capacity;
128
129 return 0;
130}
131
Jeff Garzikb0955182005-05-12 15:45:22 -0400132/**
133 * ata_cmd_ioctl - Handler for HDIO_DRIVE_CMD ioctl
Randy Dunlap8e8b77d2005-11-01 21:29:27 -0800134 * @scsidev: Device to which we are issuing command
Jeff Garzikb0955182005-05-12 15:45:22 -0400135 * @arg: User provided data for issuing command
136 *
137 * LOCKING:
138 * Defined by the SCSI layer. We don't really care.
139 *
140 * RETURNS:
141 * Zero on success, negative errno on error.
142 */
143
144int ata_cmd_ioctl(struct scsi_device *scsidev, void __user *arg)
145{
146 int rc = 0;
147 u8 scsi_cmd[MAX_COMMAND_SIZE];
148 u8 args[4], *argbuf = NULL;
149 int argsize = 0;
150 struct scsi_request *sreq;
151
152 if (NULL == (void *)arg)
153 return -EINVAL;
154
155 if (copy_from_user(args, arg, sizeof(args)))
156 return -EFAULT;
157
158 sreq = scsi_allocate_request(scsidev, GFP_KERNEL);
159 if (!sreq)
160 return -EINTR;
161
162 memset(scsi_cmd, 0, sizeof(scsi_cmd));
163
164 if (args[3]) {
165 argsize = SECTOR_SIZE * args[3];
166 argbuf = kmalloc(argsize, GFP_KERNEL);
Jeff Raubitschek54dac832005-10-04 10:21:19 -0400167 if (argbuf == NULL) {
168 rc = -ENOMEM;
169 goto error;
170 }
Jeff Garzikb0955182005-05-12 15:45:22 -0400171
172 scsi_cmd[1] = (4 << 1); /* PIO Data-in */
173 scsi_cmd[2] = 0x0e; /* no off.line or cc, read from dev,
174 block count in sector count field */
175 sreq->sr_data_direction = DMA_FROM_DEVICE;
176 } else {
177 scsi_cmd[1] = (3 << 1); /* Non-data */
178 /* scsi_cmd[2] is already 0 -- no off.line, cc, or data xfer */
179 sreq->sr_data_direction = DMA_NONE;
180 }
181
182 scsi_cmd[0] = ATA_16;
183
184 scsi_cmd[4] = args[2];
185 if (args[0] == WIN_SMART) { /* hack -- ide driver does this too... */
186 scsi_cmd[6] = args[3];
187 scsi_cmd[8] = args[1];
188 scsi_cmd[10] = 0x4f;
189 scsi_cmd[12] = 0xc2;
190 } else {
191 scsi_cmd[6] = args[1];
192 }
193 scsi_cmd[14] = args[0];
194
195 /* Good values for timeout and retries? Values below
196 from scsi_ioctl_send_command() for default case... */
197 scsi_wait_req(sreq, scsi_cmd, argbuf, argsize, (10*HZ), 5);
198
199 if (sreq->sr_result) {
200 rc = -EIO;
201 goto error;
202 }
203
204 /* Need code to retrieve data from check condition? */
205
206 if ((argbuf)
207 && copy_to_user((void *)(arg + sizeof(args)), argbuf, argsize))
208 rc = -EFAULT;
209error:
210 scsi_release_request(sreq);
211
212 if (argbuf)
213 kfree(argbuf);
214
215 return rc;
216}
217
218/**
219 * ata_task_ioctl - Handler for HDIO_DRIVE_TASK ioctl
Randy Dunlap8e8b77d2005-11-01 21:29:27 -0800220 * @scsidev: Device to which we are issuing command
Jeff Garzikb0955182005-05-12 15:45:22 -0400221 * @arg: User provided data for issuing command
222 *
223 * LOCKING:
224 * Defined by the SCSI layer. We don't really care.
225 *
226 * RETURNS:
227 * Zero on success, negative errno on error.
228 */
229int ata_task_ioctl(struct scsi_device *scsidev, void __user *arg)
230{
231 int rc = 0;
232 u8 scsi_cmd[MAX_COMMAND_SIZE];
233 u8 args[7];
234 struct scsi_request *sreq;
235
236 if (NULL == (void *)arg)
237 return -EINVAL;
238
239 if (copy_from_user(args, arg, sizeof(args)))
240 return -EFAULT;
241
242 memset(scsi_cmd, 0, sizeof(scsi_cmd));
243 scsi_cmd[0] = ATA_16;
244 scsi_cmd[1] = (3 << 1); /* Non-data */
245 /* scsi_cmd[2] is already 0 -- no off.line, cc, or data xfer */
246 scsi_cmd[4] = args[1];
247 scsi_cmd[6] = args[2];
248 scsi_cmd[8] = args[3];
249 scsi_cmd[10] = args[4];
250 scsi_cmd[12] = args[5];
251 scsi_cmd[14] = args[0];
252
253 sreq = scsi_allocate_request(scsidev, GFP_KERNEL);
254 if (!sreq) {
255 rc = -EINTR;
256 goto error;
257 }
258
259 sreq->sr_data_direction = DMA_NONE;
260 /* Good values for timeout and retries? Values below
261 from scsi_ioctl_send_command() for default case... */
262 scsi_wait_req(sreq, scsi_cmd, NULL, 0, (10*HZ), 5);
263
264 if (sreq->sr_result) {
265 rc = -EIO;
266 goto error;
267 }
268
269 /* Need code to retrieve data from check condition? */
270
271error:
272 scsi_release_request(sreq);
273 return rc;
274}
275
Linus Torvalds1da177e2005-04-16 15:20:36 -0700276int ata_scsi_ioctl(struct scsi_device *scsidev, int cmd, void __user *arg)
277{
278 struct ata_port *ap;
279 struct ata_device *dev;
280 int val = -EINVAL, rc = -EINVAL;
281
282 ap = (struct ata_port *) &scsidev->host->hostdata[0];
283 if (!ap)
284 goto out;
285
286 dev = ata_scsi_find_dev(ap, scsidev);
287 if (!dev) {
288 rc = -ENODEV;
289 goto out;
290 }
291
292 switch (cmd) {
293 case ATA_IOC_GET_IO32:
294 val = 0;
295 if (copy_to_user(arg, &val, 1))
296 return -EFAULT;
297 return 0;
298
299 case ATA_IOC_SET_IO32:
300 val = (unsigned long) arg;
301 if (val != 0)
302 return -EINVAL;
303 return 0;
304
Jeff Garzikb0955182005-05-12 15:45:22 -0400305 case HDIO_DRIVE_CMD:
306 if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
307 return -EACCES;
308 return ata_cmd_ioctl(scsidev, arg);
309
310 case HDIO_DRIVE_TASK:
311 if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
312 return -EACCES;
313 return ata_task_ioctl(scsidev, arg);
314
Linus Torvalds1da177e2005-04-16 15:20:36 -0700315 default:
316 rc = -ENOTTY;
317 break;
318 }
319
320out:
321 return rc;
322}
323
324/**
325 * ata_scsi_qc_new - acquire new ata_queued_cmd reference
326 * @ap: ATA port to which the new command is attached
327 * @dev: ATA device to which the new command is attached
328 * @cmd: SCSI command that originated this ATA command
329 * @done: SCSI command completion function
330 *
331 * Obtain a reference to an unused ata_queued_cmd structure,
332 * which is the basic libata structure representing a single
333 * ATA command sent to the hardware.
334 *
335 * If a command was available, fill in the SCSI-specific
336 * portions of the structure with information on the
337 * current command.
338 *
339 * LOCKING:
340 * spin_lock_irqsave(host_set lock)
341 *
342 * RETURNS:
343 * Command allocated, or %NULL if none available.
344 */
345struct ata_queued_cmd *ata_scsi_qc_new(struct ata_port *ap,
346 struct ata_device *dev,
347 struct scsi_cmnd *cmd,
348 void (*done)(struct scsi_cmnd *))
349{
350 struct ata_queued_cmd *qc;
351
352 qc = ata_qc_new_init(ap, dev);
353 if (qc) {
354 qc->scsicmd = cmd;
355 qc->scsidone = done;
356
357 if (cmd->use_sg) {
Jeff Garzikcedc9a42005-10-05 07:13:30 -0400358 qc->__sg = (struct scatterlist *) cmd->request_buffer;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700359 qc->n_elem = cmd->use_sg;
360 } else {
Jeff Garzikcedc9a42005-10-05 07:13:30 -0400361 qc->__sg = &qc->sgent;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700362 qc->n_elem = 1;
363 }
364 } else {
365 cmd->result = (DID_OK << 16) | (QUEUE_FULL << 1);
366 done(cmd);
367 }
368
369 return qc;
370}
371
372/**
Jeff Garzikb0955182005-05-12 15:45:22 -0400373 * ata_dump_status - user friendly display of error info
374 * @id: id of the port in question
375 * @tf: ptr to filled out taskfile
Linus Torvalds1da177e2005-04-16 15:20:36 -0700376 *
Jeff Garzikb0955182005-05-12 15:45:22 -0400377 * Decode and dump the ATA error/status registers for the user so
378 * that they have some idea what really happened at the non
379 * make-believe layer.
380 *
381 * LOCKING:
382 * inherited from caller
383 */
384void ata_dump_status(unsigned id, struct ata_taskfile *tf)
385{
386 u8 stat = tf->command, err = tf->feature;
387
388 printk(KERN_WARNING "ata%u: status=0x%02x { ", id, stat);
389 if (stat & ATA_BUSY) {
390 printk("Busy }\n"); /* Data is not valid in this case */
391 } else {
392 if (stat & 0x40) printk("DriveReady ");
393 if (stat & 0x20) printk("DeviceFault ");
394 if (stat & 0x10) printk("SeekComplete ");
395 if (stat & 0x08) printk("DataRequest ");
396 if (stat & 0x04) printk("CorrectedError ");
397 if (stat & 0x02) printk("Index ");
398 if (stat & 0x01) printk("Error ");
399 printk("}\n");
400
401 if (err) {
402 printk(KERN_WARNING "ata%u: error=0x%02x { ", id, err);
403 if (err & 0x04) printk("DriveStatusError ");
404 if (err & 0x80) {
405 if (err & 0x04) printk("BadCRC ");
406 else printk("Sector ");
407 }
408 if (err & 0x40) printk("UncorrectableError ");
409 if (err & 0x10) printk("SectorIdNotFound ");
410 if (err & 0x02) printk("TrackZeroNotFound ");
411 if (err & 0x01) printk("AddrMarkNotFound ");
412 printk("}\n");
413 }
414 }
415}
416
417/**
418 * ata_to_sense_error - convert ATA error to SCSI error
Randy Dunlap8e8b77d2005-11-01 21:29:27 -0800419 * @id: ATA device number
Jeff Garzikb0955182005-05-12 15:45:22 -0400420 * @drv_stat: value contained in ATA status register
421 * @drv_err: value contained in ATA error register
422 * @sk: the sense key we'll fill out
423 * @asc: the additional sense code we'll fill out
424 * @ascq: the additional sense code qualifier we'll fill out
425 *
426 * Converts an ATA error into a SCSI error. Fill out pointers to
427 * SK, ASC, and ASCQ bytes for later use in fixed or descriptor
428 * format sense blocks.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700429 *
430 * LOCKING:
431 * spin_lock_irqsave(host_set lock)
432 */
Jeff Garzikb0955182005-05-12 15:45:22 -0400433void ata_to_sense_error(unsigned id, u8 drv_stat, u8 drv_err, u8 *sk, u8 *asc,
434 u8 *ascq)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700435{
Jeff Garzikb0955182005-05-12 15:45:22 -0400436 int i;
Jeff Garzikffe75ef2005-10-09 10:40:44 -0400437
Linus Torvalds1da177e2005-04-16 15:20:36 -0700438 /* Based on the 3ware driver translation table */
439 static unsigned char sense_table[][4] = {
440 /* BBD|ECC|ID|MAR */
441 {0xd1, ABORTED_COMMAND, 0x00, 0x00}, // Device busy Aborted command
442 /* BBD|ECC|ID */
443 {0xd0, ABORTED_COMMAND, 0x00, 0x00}, // Device busy Aborted command
444 /* ECC|MC|MARK */
445 {0x61, HARDWARE_ERROR, 0x00, 0x00}, // Device fault Hardware error
446 /* ICRC|ABRT */ /* NB: ICRC & !ABRT is BBD */
447 {0x84, ABORTED_COMMAND, 0x47, 0x00}, // Data CRC error SCSI parity error
448 /* MC|ID|ABRT|TRK0|MARK */
449 {0x37, NOT_READY, 0x04, 0x00}, // Unit offline Not ready
450 /* MCR|MARK */
451 {0x09, NOT_READY, 0x04, 0x00}, // Unrecovered disk error Not ready
452 /* Bad address mark */
453 {0x01, MEDIUM_ERROR, 0x13, 0x00}, // Address mark not found Address mark not found for data field
454 /* TRK0 */
455 {0x02, HARDWARE_ERROR, 0x00, 0x00}, // Track 0 not found Hardware error
456 /* Abort & !ICRC */
457 {0x04, ABORTED_COMMAND, 0x00, 0x00}, // Aborted command Aborted command
458 /* Media change request */
459 {0x08, NOT_READY, 0x04, 0x00}, // Media change request FIXME: faking offline
460 /* SRV */
461 {0x10, ABORTED_COMMAND, 0x14, 0x00}, // ID not found Recorded entity not found
462 /* Media change */
463 {0x08, NOT_READY, 0x04, 0x00}, // Media change FIXME: faking offline
464 /* ECC */
465 {0x40, MEDIUM_ERROR, 0x11, 0x04}, // Uncorrectable ECC error Unrecovered read error
466 /* BBD - block marked bad */
467 {0x80, MEDIUM_ERROR, 0x11, 0x04}, // Block marked bad Medium error, unrecovered read error
468 {0xFF, 0xFF, 0xFF, 0xFF}, // END mark
469 };
470 static unsigned char stat_table[][4] = {
471 /* Must be first because BUSY means no other bits valid */
472 {0x80, ABORTED_COMMAND, 0x47, 0x00}, // Busy, fake parity for now
473 {0x20, HARDWARE_ERROR, 0x00, 0x00}, // Device fault
474 {0x08, ABORTED_COMMAND, 0x47, 0x00}, // Timed out in xfer, fake parity for now
475 {0x04, RECOVERED_ERROR, 0x11, 0x00}, // Recovered ECC error Medium error, recovered
476 {0xFF, 0xFF, 0xFF, 0xFF}, // END mark
477 };
Linus Torvalds1da177e2005-04-16 15:20:36 -0700478
Linus Torvalds1da177e2005-04-16 15:20:36 -0700479 /*
480 * Is this an error we can process/parse
481 */
Jeff Garzikb0955182005-05-12 15:45:22 -0400482 if (drv_stat & ATA_BUSY) {
483 drv_err = 0; /* Ignore the err bits, they're invalid */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700484 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700485
Jeff Garzikb0955182005-05-12 15:45:22 -0400486 if (drv_err) {
487 /* Look for drv_err */
488 for (i = 0; sense_table[i][0] != 0xFF; i++) {
489 /* Look for best matches first */
490 if ((sense_table[i][0] & drv_err) ==
491 sense_table[i][0]) {
492 *sk = sense_table[i][1];
493 *asc = sense_table[i][2];
494 *ascq = sense_table[i][3];
495 goto translate_done;
496 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700497 }
Jeff Garzikb0955182005-05-12 15:45:22 -0400498 /* No immediate match */
499 printk(KERN_WARNING "ata%u: no sense translation for "
500 "error 0x%02x\n", id, drv_err);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700501 }
502
Linus Torvalds1da177e2005-04-16 15:20:36 -0700503 /* Fall back to interpreting status bits */
Jeff Garzikb0955182005-05-12 15:45:22 -0400504 for (i = 0; stat_table[i][0] != 0xFF; i++) {
505 if (stat_table[i][0] & drv_stat) {
506 *sk = stat_table[i][1];
507 *asc = stat_table[i][2];
508 *ascq = stat_table[i][3];
509 goto translate_done;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700510 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700511 }
Jeff Garzikb0955182005-05-12 15:45:22 -0400512 /* No error? Undecoded? */
513 printk(KERN_WARNING "ata%u: no sense translation for status: 0x%02x\n",
514 id, drv_stat);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700515
Jeff Garzikb0955182005-05-12 15:45:22 -0400516 /* For our last chance pick, use medium read error because
517 * it's much more common than an ATA drive telling you a write
518 * has failed.
519 */
520 *sk = MEDIUM_ERROR;
521 *asc = 0x11; /* "unrecovered read error" */
522 *ascq = 0x04; /* "auto-reallocation failed" */
523
524 translate_done:
525 printk(KERN_ERR "ata%u: translated ATA stat/err 0x%02x/%02x to "
526 "SCSI SK/ASC/ASCQ 0x%x/%02x/%02x\n", id, drv_stat, drv_err,
527 *sk, *asc, *ascq);
528 return;
529}
530
531/*
532 * ata_gen_ata_desc_sense - Generate check condition sense block.
533 * @qc: Command that completed.
534 *
535 * This function is specific to the ATA descriptor format sense
536 * block specified for the ATA pass through commands. Regardless
537 * of whether the command errored or not, return a sense
538 * block. Copy all controller registers into the sense
539 * block. Clear sense key, ASC & ASCQ if there is no error.
540 *
541 * LOCKING:
542 * spin_lock_irqsave(host_set lock)
543 */
544void ata_gen_ata_desc_sense(struct ata_queued_cmd *qc)
545{
546 struct scsi_cmnd *cmd = qc->scsicmd;
547 struct ata_taskfile *tf = &qc->tf;
548 unsigned char *sb = cmd->sense_buffer;
549 unsigned char *desc = sb + 8;
550
551 memset(sb, 0, SCSI_SENSE_BUFFERSIZE);
552
Jeff Garzik0e5dec42005-10-06 09:40:20 -0400553 cmd->result = (DRIVER_SENSE << 24) | SAM_STAT_CHECK_CONDITION;
Jeff Garzikb0955182005-05-12 15:45:22 -0400554
555 /*
556 * Read the controller registers.
557 */
558 assert(NULL != qc->ap->ops->tf_read);
559 qc->ap->ops->tf_read(qc->ap, tf);
560
561 /*
562 * Use ata_to_sense_error() to map status register bits
563 * onto sense key, asc & ascq.
564 */
Jeff Garzika7dac442005-10-30 04:44:42 -0500565 if (tf->command & (ATA_BUSY | ATA_DF | ATA_ERR | ATA_DRQ)) {
Jeff Garzikb0955182005-05-12 15:45:22 -0400566 ata_to_sense_error(qc->ap->id, tf->command, tf->feature,
567 &sb[1], &sb[2], &sb[3]);
568 sb[1] &= 0x0f;
569 }
570
571 /*
572 * Sense data is current and format is descriptor.
573 */
574 sb[0] = 0x72;
575
576 desc[0] = 0x09;
577
578 /*
579 * Set length of additional sense data.
580 * Since we only populate descriptor 0, the total
581 * length is the same (fixed) length as descriptor 0.
582 */
583 desc[1] = sb[7] = 14;
584
585 /*
586 * Copy registers into sense buffer.
587 */
588 desc[2] = 0x00;
589 desc[3] = tf->feature; /* == error reg */
590 desc[5] = tf->nsect;
591 desc[7] = tf->lbal;
592 desc[9] = tf->lbam;
593 desc[11] = tf->lbah;
594 desc[12] = tf->device;
595 desc[13] = tf->command; /* == status reg */
596
597 /*
598 * Fill in Extend bit, and the high order bytes
599 * if applicable.
600 */
601 if (tf->flags & ATA_TFLAG_LBA48) {
602 desc[2] |= 0x01;
603 desc[4] = tf->hob_nsect;
604 desc[6] = tf->hob_lbal;
605 desc[8] = tf->hob_lbam;
606 desc[10] = tf->hob_lbah;
607 }
608}
609
610/**
611 * ata_gen_fixed_sense - generate a SCSI fixed sense block
612 * @qc: Command that we are erroring out
613 *
614 * Leverage ata_to_sense_error() to give us the codes. Fit our
615 * LBA in here if there's room.
616 *
617 * LOCKING:
618 * inherited from caller
619 */
620void ata_gen_fixed_sense(struct ata_queued_cmd *qc)
621{
622 struct scsi_cmnd *cmd = qc->scsicmd;
623 struct ata_taskfile *tf = &qc->tf;
624 unsigned char *sb = cmd->sense_buffer;
625
626 memset(sb, 0, SCSI_SENSE_BUFFERSIZE);
627
Jeff Garzik0e5dec42005-10-06 09:40:20 -0400628 cmd->result = (DRIVER_SENSE << 24) | SAM_STAT_CHECK_CONDITION;
Jeff Garzikb0955182005-05-12 15:45:22 -0400629
630 /*
631 * Read the controller registers.
632 */
633 assert(NULL != qc->ap->ops->tf_read);
634 qc->ap->ops->tf_read(qc->ap, tf);
635
636 /*
637 * Use ata_to_sense_error() to map status register bits
638 * onto sense key, asc & ascq.
639 */
Jeff Garzika7dac442005-10-30 04:44:42 -0500640 if (tf->command & (ATA_BUSY | ATA_DF | ATA_ERR | ATA_DRQ)) {
Jeff Garzikb0955182005-05-12 15:45:22 -0400641 ata_to_sense_error(qc->ap->id, tf->command, tf->feature,
642 &sb[2], &sb[12], &sb[13]);
643 sb[2] &= 0x0f;
644 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700645
646 sb[0] = 0x70;
Jeff Garzikb0955182005-05-12 15:45:22 -0400647 sb[7] = 0x0a;
Jeff Garzik0274aa22005-06-22 13:50:56 -0400648
Jeff Garzika7dac442005-10-30 04:44:42 -0500649 if (tf->flags & ATA_TFLAG_LBA48) {
650 /* TODO: find solution for LBA48 descriptors */
651 }
652
653 else if (tf->flags & ATA_TFLAG_LBA) {
Jeff Garzikb0955182005-05-12 15:45:22 -0400654 /* A small (28b) LBA will fit in the 32b info field */
655 sb[0] |= 0x80; /* set valid bit */
656 sb[3] = tf->device & 0x0f;
657 sb[4] = tf->lbah;
658 sb[5] = tf->lbam;
659 sb[6] = tf->lbal;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700660 }
Jeff Garzika7dac442005-10-30 04:44:42 -0500661
662 else {
663 /* TODO: C/H/S */
664 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700665}
666
667/**
668 * ata_scsi_slave_config - Set SCSI device attributes
669 * @sdev: SCSI device to examine
670 *
671 * This is called before we actually start reading
672 * and writing to the device, to configure certain
673 * SCSI mid-layer behaviors.
674 *
675 * LOCKING:
676 * Defined by SCSI layer. We don't really care.
677 */
678
679int ata_scsi_slave_config(struct scsi_device *sdev)
680{
681 sdev->use_10_for_rw = 1;
682 sdev->use_10_for_ms = 1;
683
684 blk_queue_max_phys_segments(sdev->request_queue, LIBATA_MAX_PRD);
685
686 if (sdev->id < ATA_MAX_DEVICES) {
687 struct ata_port *ap;
688 struct ata_device *dev;
689
690 ap = (struct ata_port *) &sdev->host->hostdata[0];
691 dev = &ap->device[sdev->id];
692
693 /* TODO: 1024 is an arbitrary number, not the
694 * hardware maximum. This should be increased to
695 * 65534 when Jens Axboe's patch for dynamically
696 * determining max_sectors is merged.
697 */
698 if ((dev->flags & ATA_DFLAG_LBA48) &&
699 ((dev->flags & ATA_DFLAG_LOCK_SECTORS) == 0)) {
John W. Linvillef85bdb92005-05-12 15:49:54 -0400700 /*
701 * do not overwrite sdev->host->max_sectors, since
702 * other drives on this host may not support LBA48
703 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700704 blk_queue_max_sectors(sdev->request_queue, 2048);
705 }
Jeff Garzikcedc9a42005-10-05 07:13:30 -0400706
707 /*
708 * SATA DMA transfers must be multiples of 4 byte, so
709 * we need to pad ATAPI transfers using an extra sg.
710 * Decrement max hw segments accordingly.
711 */
712 if (dev->class == ATA_DEV_ATAPI) {
713 request_queue_t *q = sdev->request_queue;
714 blk_queue_max_hw_segments(q, q->max_hw_segments - 1);
715 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700716 }
717
718 return 0; /* scsi layer doesn't check return value, sigh */
719}
720
721/**
722 * ata_scsi_error - SCSI layer error handler callback
723 * @host: SCSI host on which error occurred
724 *
725 * Handles SCSI-layer-thrown error events.
726 *
727 * LOCKING:
728 * Inherited from SCSI layer (none, can sleep)
729 *
730 * RETURNS:
731 * Zero.
732 */
733
734int ata_scsi_error(struct Scsi_Host *host)
735{
736 struct ata_port *ap;
737
738 DPRINTK("ENTER\n");
739
740 ap = (struct ata_port *) &host->hostdata[0];
741 ap->ops->eng_timeout(ap);
742
743 /* TODO: this is per-command; when queueing is supported
744 * this code will either change or move to a more
745 * appropriate place
746 */
747 host->host_failed--;
Tejun Heo42517432005-08-10 13:38:27 -0400748 INIT_LIST_HEAD(&host->eh_cmd_q);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700749
750 DPRINTK("EXIT\n");
751 return 0;
752}
753
754/**
Douglas Gilbert972dcaf2005-08-11 03:35:53 -0400755 * ata_scsi_start_stop_xlat - Translate SCSI START STOP UNIT command
756 * @qc: Storage for translated ATA taskfile
757 * @scsicmd: SCSI command to translate
758 *
759 * Sets up an ATA taskfile to issue STANDBY (to stop) or READ VERIFY
760 * (to start). Perhaps these commands should be preceded by
761 * CHECK POWER MODE to see what power mode the device is already in.
762 * [See SAT revision 5 at www.t10.org]
763 *
764 * LOCKING:
765 * spin_lock_irqsave(host_set lock)
766 *
767 * RETURNS:
768 * Zero on success, non-zero on error.
769 */
770
771static unsigned int ata_scsi_start_stop_xlat(struct ata_queued_cmd *qc,
Jeff Garzik057ace52005-10-22 14:27:05 -0400772 const u8 *scsicmd)
Douglas Gilbert972dcaf2005-08-11 03:35:53 -0400773{
774 struct ata_taskfile *tf = &qc->tf;
775
776 tf->flags |= ATA_TFLAG_DEVICE | ATA_TFLAG_ISADDR;
777 tf->protocol = ATA_PROT_NODATA;
778 if (scsicmd[1] & 0x1) {
779 ; /* ignore IMMED bit, violates sat-r05 */
780 }
781 if (scsicmd[4] & 0x2)
Douglas Gilbertae006512005-10-09 09:09:35 -0400782 goto invalid_fld; /* LOEJ bit set not supported */
Douglas Gilbert972dcaf2005-08-11 03:35:53 -0400783 if (((scsicmd[4] >> 4) & 0xf) != 0)
Douglas Gilbertae006512005-10-09 09:09:35 -0400784 goto invalid_fld; /* power conditions not supported */
Douglas Gilbert972dcaf2005-08-11 03:35:53 -0400785 if (scsicmd[4] & 0x1) {
786 tf->nsect = 1; /* 1 sector, lba=0 */
Albert Lee9d5b1302005-10-04 08:48:17 -0400787
788 if (qc->dev->flags & ATA_DFLAG_LBA) {
789 qc->tf.flags |= ATA_TFLAG_LBA;
790
791 tf->lbah = 0x0;
792 tf->lbam = 0x0;
793 tf->lbal = 0x0;
794 tf->device |= ATA_LBA;
795 } else {
796 /* CHS */
797 tf->lbal = 0x1; /* sect */
798 tf->lbam = 0x0; /* cyl low */
799 tf->lbah = 0x0; /* cyl high */
800 }
801
Douglas Gilbert972dcaf2005-08-11 03:35:53 -0400802 tf->command = ATA_CMD_VERIFY; /* READ VERIFY */
803 } else {
804 tf->nsect = 0; /* time period value (0 implies now) */
805 tf->command = ATA_CMD_STANDBY;
806 /* Consider: ATA STANDBY IMMEDIATE command */
807 }
808 /*
809 * Standby and Idle condition timers could be implemented but that
810 * would require libata to implement the Power condition mode page
811 * and allow the user to change it. Changing mode pages requires
812 * MODE SELECT to be implemented.
813 */
814
815 return 0;
Douglas Gilbertae006512005-10-09 09:09:35 -0400816
817invalid_fld:
818 ata_scsi_set_sense(qc->scsicmd, ILLEGAL_REQUEST, 0x24, 0x0);
819 /* "Invalid field in cbd" */
820 return 1;
Douglas Gilbert972dcaf2005-08-11 03:35:53 -0400821}
822
823
824/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700825 * ata_scsi_flush_xlat - Translate SCSI SYNCHRONIZE CACHE command
826 * @qc: Storage for translated ATA taskfile
827 * @scsicmd: SCSI command to translate (ignored)
828 *
829 * Sets up an ATA taskfile to issue FLUSH CACHE or
830 * FLUSH CACHE EXT.
831 *
832 * LOCKING:
833 * spin_lock_irqsave(host_set lock)
834 *
835 * RETURNS:
836 * Zero on success, non-zero on error.
837 */
838
Jeff Garzik057ace52005-10-22 14:27:05 -0400839static unsigned int ata_scsi_flush_xlat(struct ata_queued_cmd *qc, const u8 *scsicmd)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700840{
841 struct ata_taskfile *tf = &qc->tf;
842
843 tf->flags |= ATA_TFLAG_DEVICE;
844 tf->protocol = ATA_PROT_NODATA;
845
Albert Lee07506692005-10-12 15:04:18 +0800846 if ((qc->dev->flags & ATA_DFLAG_LBA48) &&
Linus Torvalds1da177e2005-04-16 15:20:36 -0700847 (ata_id_has_flush_ext(qc->dev->id)))
848 tf->command = ATA_CMD_FLUSH_EXT;
849 else
850 tf->command = ATA_CMD_FLUSH;
851
852 return 0;
853}
854
855/**
Albert Lee3aef5232005-10-04 08:47:43 -0400856 * scsi_6_lba_len - Get LBA and transfer length
857 * @scsicmd: SCSI command to translate
858 *
859 * Calculate LBA and transfer length for 6-byte commands.
860 *
861 * RETURNS:
862 * @plba: the LBA
863 * @plen: the transfer length
864 */
865
Jeff Garzik057ace52005-10-22 14:27:05 -0400866static void scsi_6_lba_len(const u8 *scsicmd, u64 *plba, u32 *plen)
Albert Lee3aef5232005-10-04 08:47:43 -0400867{
868 u64 lba = 0;
869 u32 len = 0;
870
871 VPRINTK("six-byte command\n");
872
873 lba |= ((u64)scsicmd[2]) << 8;
874 lba |= ((u64)scsicmd[3]);
875
876 len |= ((u32)scsicmd[4]);
877
878 *plba = lba;
879 *plen = len;
880}
881
882/**
883 * scsi_10_lba_len - Get LBA and transfer length
884 * @scsicmd: SCSI command to translate
885 *
886 * Calculate LBA and transfer length for 10-byte commands.
887 *
888 * RETURNS:
889 * @plba: the LBA
890 * @plen: the transfer length
891 */
892
Jeff Garzik057ace52005-10-22 14:27:05 -0400893static void scsi_10_lba_len(const u8 *scsicmd, u64 *plba, u32 *plen)
Albert Lee3aef5232005-10-04 08:47:43 -0400894{
895 u64 lba = 0;
896 u32 len = 0;
897
898 VPRINTK("ten-byte command\n");
899
900 lba |= ((u64)scsicmd[2]) << 24;
901 lba |= ((u64)scsicmd[3]) << 16;
902 lba |= ((u64)scsicmd[4]) << 8;
903 lba |= ((u64)scsicmd[5]);
904
905 len |= ((u32)scsicmd[7]) << 8;
906 len |= ((u32)scsicmd[8]);
907
908 *plba = lba;
909 *plen = len;
910}
911
912/**
913 * scsi_16_lba_len - Get LBA and transfer length
914 * @scsicmd: SCSI command to translate
915 *
916 * Calculate LBA and transfer length for 16-byte commands.
917 *
918 * RETURNS:
919 * @plba: the LBA
920 * @plen: the transfer length
921 */
922
Jeff Garzik057ace52005-10-22 14:27:05 -0400923static void scsi_16_lba_len(const u8 *scsicmd, u64 *plba, u32 *plen)
Albert Lee3aef5232005-10-04 08:47:43 -0400924{
925 u64 lba = 0;
926 u32 len = 0;
927
928 VPRINTK("sixteen-byte command\n");
929
930 lba |= ((u64)scsicmd[2]) << 56;
931 lba |= ((u64)scsicmd[3]) << 48;
932 lba |= ((u64)scsicmd[4]) << 40;
933 lba |= ((u64)scsicmd[5]) << 32;
934 lba |= ((u64)scsicmd[6]) << 24;
935 lba |= ((u64)scsicmd[7]) << 16;
936 lba |= ((u64)scsicmd[8]) << 8;
937 lba |= ((u64)scsicmd[9]);
938
939 len |= ((u32)scsicmd[10]) << 24;
940 len |= ((u32)scsicmd[11]) << 16;
941 len |= ((u32)scsicmd[12]) << 8;
942 len |= ((u32)scsicmd[13]);
943
944 *plba = lba;
945 *plen = len;
946}
947
948/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700949 * ata_scsi_verify_xlat - Translate SCSI VERIFY command into an ATA one
950 * @qc: Storage for translated ATA taskfile
951 * @scsicmd: SCSI command to translate
952 *
953 * Converts SCSI VERIFY command to an ATA READ VERIFY command.
954 *
955 * LOCKING:
956 * spin_lock_irqsave(host_set lock)
957 *
958 * RETURNS:
959 * Zero on success, non-zero on error.
960 */
961
Jeff Garzik057ace52005-10-22 14:27:05 -0400962static unsigned int ata_scsi_verify_xlat(struct ata_queued_cmd *qc, const u8 *scsicmd)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700963{
964 struct ata_taskfile *tf = &qc->tf;
Albert Lee8bf62ece2005-05-12 15:29:42 -0400965 struct ata_device *dev = qc->dev;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700966 u64 dev_sectors = qc->dev->n_sectors;
Albert Lee3aef5232005-10-04 08:47:43 -0400967 u64 block;
968 u32 n_block;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700969
970 tf->flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
971 tf->protocol = ATA_PROT_NODATA;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700972
Albert Lee3aef5232005-10-04 08:47:43 -0400973 if (scsicmd[0] == VERIFY)
974 scsi_10_lba_len(scsicmd, &block, &n_block);
975 else if (scsicmd[0] == VERIFY_16)
976 scsi_16_lba_len(scsicmd, &block, &n_block);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700977 else
Douglas Gilbertae006512005-10-09 09:09:35 -0400978 goto invalid_fld;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700979
Albert Lee8bf62ece2005-05-12 15:29:42 -0400980 if (!n_block)
Douglas Gilbertae006512005-10-09 09:09:35 -0400981 goto nothing_to_do;
Albert Lee8bf62ece2005-05-12 15:29:42 -0400982 if (block >= dev_sectors)
Douglas Gilbertae006512005-10-09 09:09:35 -0400983 goto out_of_range;
Albert Lee8bf62ece2005-05-12 15:29:42 -0400984 if ((block + n_block) > dev_sectors)
Douglas Gilbertae006512005-10-09 09:09:35 -0400985 goto out_of_range;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700986
Albert Lee07506692005-10-12 15:04:18 +0800987 if (dev->flags & ATA_DFLAG_LBA) {
988 tf->flags |= ATA_TFLAG_LBA;
989
990 if (dev->flags & ATA_DFLAG_LBA48) {
991 if (n_block > (64 * 1024))
992 goto invalid_fld;
993
994 /* use LBA48 */
995 tf->flags |= ATA_TFLAG_LBA48;
Albert Lee8bf62ece2005-05-12 15:29:42 -0400996 tf->command = ATA_CMD_VERIFY_EXT;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700997
Albert Lee8bf62ece2005-05-12 15:29:42 -0400998 tf->hob_nsect = (n_block >> 8) & 0xff;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700999
Albert Lee8bf62ece2005-05-12 15:29:42 -04001000 tf->hob_lbah = (block >> 40) & 0xff;
1001 tf->hob_lbam = (block >> 32) & 0xff;
1002 tf->hob_lbal = (block >> 24) & 0xff;
1003 } else {
Albert Lee07506692005-10-12 15:04:18 +08001004 if (n_block > 256)
1005 goto invalid_fld;
1006
1007 /* use LBA28 */
Albert Lee8bf62ece2005-05-12 15:29:42 -04001008 tf->command = ATA_CMD_VERIFY;
1009
1010 tf->device |= (block >> 24) & 0xf;
1011 }
1012
1013 tf->nsect = n_block & 0xff;
1014
1015 tf->lbah = (block >> 16) & 0xff;
1016 tf->lbam = (block >> 8) & 0xff;
1017 tf->lbal = block & 0xff;
1018
1019 tf->device |= ATA_LBA;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001020 } else {
Albert Lee8bf62ece2005-05-12 15:29:42 -04001021 /* CHS */
1022 u32 sect, head, cyl, track;
1023
Albert Lee07506692005-10-12 15:04:18 +08001024 if (n_block > 256)
1025 goto invalid_fld;
1026
Albert Lee8bf62ece2005-05-12 15:29:42 -04001027 /* Convert LBA to CHS */
1028 track = (u32)block / dev->sectors;
1029 cyl = track / dev->heads;
1030 head = track % dev->heads;
1031 sect = (u32)block % dev->sectors + 1;
1032
Albert Leec187c4b2005-10-04 08:46:51 -04001033 DPRINTK("block %u track %u cyl %u head %u sect %u\n",
1034 (u32)block, track, cyl, head, sect);
Albert Lee8bf62ece2005-05-12 15:29:42 -04001035
1036 /* Check whether the converted CHS can fit.
1037 Cylinder: 0-65535
1038 Head: 0-15
1039 Sector: 1-255*/
1040 if ((cyl >> 16) || (head >> 4) || (sect >> 8) || (!sect))
Douglas Gilbertae006512005-10-09 09:09:35 -04001041 goto out_of_range;
Albert Lee8bf62ece2005-05-12 15:29:42 -04001042
Linus Torvalds1da177e2005-04-16 15:20:36 -07001043 tf->command = ATA_CMD_VERIFY;
Albert Lee8bf62ece2005-05-12 15:29:42 -04001044 tf->nsect = n_block & 0xff; /* Sector count 0 means 256 sectors */
1045 tf->lbal = sect;
1046 tf->lbam = cyl;
1047 tf->lbah = cyl >> 8;
1048 tf->device |= head;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001049 }
1050
Linus Torvalds1da177e2005-04-16 15:20:36 -07001051 return 0;
Douglas Gilbertae006512005-10-09 09:09:35 -04001052
1053invalid_fld:
1054 ata_scsi_set_sense(qc->scsicmd, ILLEGAL_REQUEST, 0x24, 0x0);
1055 /* "Invalid field in cbd" */
1056 return 1;
1057
1058out_of_range:
1059 ata_scsi_set_sense(qc->scsicmd, ILLEGAL_REQUEST, 0x21, 0x0);
1060 /* "Logical Block Address out of range" */
1061 return 1;
1062
1063nothing_to_do:
1064 qc->scsicmd->result = SAM_STAT_GOOD;
1065 return 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001066}
1067
1068/**
1069 * ata_scsi_rw_xlat - Translate SCSI r/w command into an ATA one
1070 * @qc: Storage for translated ATA taskfile
1071 * @scsicmd: SCSI command to translate
1072 *
1073 * Converts any of six SCSI read/write commands into the
1074 * ATA counterpart, including starting sector (LBA),
1075 * sector count, and taking into account the device's LBA48
1076 * support.
1077 *
1078 * Commands %READ_6, %READ_10, %READ_16, %WRITE_6, %WRITE_10, and
1079 * %WRITE_16 are currently supported.
1080 *
1081 * LOCKING:
1082 * spin_lock_irqsave(host_set lock)
1083 *
1084 * RETURNS:
1085 * Zero on success, non-zero on error.
1086 */
1087
Jeff Garzik057ace52005-10-22 14:27:05 -04001088static unsigned int ata_scsi_rw_xlat(struct ata_queued_cmd *qc, const u8 *scsicmd)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001089{
1090 struct ata_taskfile *tf = &qc->tf;
Albert Lee8bf62ece2005-05-12 15:29:42 -04001091 struct ata_device *dev = qc->dev;
Albert Lee3aef5232005-10-04 08:47:43 -04001092 u64 block;
1093 u32 n_block;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001094
1095 tf->flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001096
Albert Lee8cbd6df2005-10-12 15:06:27 +08001097 if (scsicmd[0] == WRITE_10 || scsicmd[0] == WRITE_6 ||
1098 scsicmd[0] == WRITE_16)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001099 tf->flags |= ATA_TFLAG_WRITE;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001100
Albert Lee8bf62ece2005-05-12 15:29:42 -04001101 /* Calculate the SCSI LBA and transfer length. */
Albert Lee3aef5232005-10-04 08:47:43 -04001102 switch (scsicmd[0]) {
1103 case READ_10:
1104 case WRITE_10:
1105 scsi_10_lba_len(scsicmd, &block, &n_block);
1106 break;
1107 case READ_6:
1108 case WRITE_6:
1109 scsi_6_lba_len(scsicmd, &block, &n_block);
Albert Leec187c4b2005-10-04 08:46:51 -04001110
1111 /* for 6-byte r/w commands, transfer length 0
1112 * means 256 blocks of data, not 0 block.
1113 */
Jeff Garzik76b2bf92005-08-29 19:24:43 -04001114 if (!n_block)
1115 n_block = 256;
Albert Lee3aef5232005-10-04 08:47:43 -04001116 break;
1117 case READ_16:
1118 case WRITE_16:
1119 scsi_16_lba_len(scsicmd, &block, &n_block);
1120 break;
1121 default:
Albert Lee8bf62ece2005-05-12 15:29:42 -04001122 DPRINTK("no-byte command\n");
Douglas Gilbertae006512005-10-09 09:09:35 -04001123 goto invalid_fld;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001124 }
1125
Albert Lee8bf62ece2005-05-12 15:29:42 -04001126 /* Check and compose ATA command */
1127 if (!n_block)
Albert Leec187c4b2005-10-04 08:46:51 -04001128 /* For 10-byte and 16-byte SCSI R/W commands, transfer
1129 * length 0 means transfer 0 block of data.
1130 * However, for ATA R/W commands, sector count 0 means
1131 * 256 or 65536 sectors, not 0 sectors as in SCSI.
Alan Coxf51750d2005-11-07 17:06:33 +00001132 *
1133 * WARNING: one or two older ATA drives treat 0 as 0...
Albert Leec187c4b2005-10-04 08:46:51 -04001134 */
Douglas Gilbertae006512005-10-09 09:09:35 -04001135 goto nothing_to_do;
Albert Lee8bf62ece2005-05-12 15:29:42 -04001136
Albert Lee07506692005-10-12 15:04:18 +08001137 if (dev->flags & ATA_DFLAG_LBA) {
1138 tf->flags |= ATA_TFLAG_LBA;
1139
1140 if (dev->flags & ATA_DFLAG_LBA48) {
Albert Lee8bf62ece2005-05-12 15:29:42 -04001141 /* The request -may- be too large for LBA48. */
1142 if ((block >> 48) || (n_block > 65536))
Douglas Gilbertae006512005-10-09 09:09:35 -04001143 goto out_of_range;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001144
Albert Lee07506692005-10-12 15:04:18 +08001145 /* use LBA48 */
1146 tf->flags |= ATA_TFLAG_LBA48;
1147
Albert Lee8bf62ece2005-05-12 15:29:42 -04001148 tf->hob_nsect = (n_block >> 8) & 0xff;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001149
Albert Lee8bf62ece2005-05-12 15:29:42 -04001150 tf->hob_lbah = (block >> 40) & 0xff;
1151 tf->hob_lbam = (block >> 32) & 0xff;
1152 tf->hob_lbal = (block >> 24) & 0xff;
1153 } else {
Albert Lee07506692005-10-12 15:04:18 +08001154 /* use LBA28 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001155
Albert Lee8bf62ece2005-05-12 15:29:42 -04001156 /* The request -may- be too large for LBA28. */
1157 if ((block >> 28) || (n_block > 256))
Douglas Gilbertae006512005-10-09 09:09:35 -04001158 goto out_of_range;
Albert Lee8bf62ece2005-05-12 15:29:42 -04001159
1160 tf->device |= (block >> 24) & 0xf;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001161 }
1162
Albert Lee8cbd6df2005-10-12 15:06:27 +08001163 ata_rwcmd_protocol(qc);
1164
Albert Lee8bf62ece2005-05-12 15:29:42 -04001165 qc->nsect = n_block;
1166 tf->nsect = n_block & 0xff;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001167
Albert Lee8bf62ece2005-05-12 15:29:42 -04001168 tf->lbah = (block >> 16) & 0xff;
1169 tf->lbam = (block >> 8) & 0xff;
1170 tf->lbal = block & 0xff;
1171
1172 tf->device |= ATA_LBA;
1173 } else {
1174 /* CHS */
1175 u32 sect, head, cyl, track;
1176
1177 /* The request -may- be too large for CHS addressing. */
1178 if ((block >> 28) || (n_block > 256))
Douglas Gilbertae006512005-10-09 09:09:35 -04001179 goto out_of_range;
Albert Leec187c4b2005-10-04 08:46:51 -04001180
Albert Lee8cbd6df2005-10-12 15:06:27 +08001181 ata_rwcmd_protocol(qc);
1182
Albert Lee8bf62ece2005-05-12 15:29:42 -04001183 /* Convert LBA to CHS */
1184 track = (u32)block / dev->sectors;
1185 cyl = track / dev->heads;
1186 head = track % dev->heads;
1187 sect = (u32)block % dev->sectors + 1;
1188
Albert Leec187c4b2005-10-04 08:46:51 -04001189 DPRINTK("block %u track %u cyl %u head %u sect %u\n",
Albert Lee8bf62ece2005-05-12 15:29:42 -04001190 (u32)block, track, cyl, head, sect);
Albert Leec187c4b2005-10-04 08:46:51 -04001191
Albert Lee8bf62ece2005-05-12 15:29:42 -04001192 /* Check whether the converted CHS can fit.
1193 Cylinder: 0-65535
1194 Head: 0-15
1195 Sector: 1-255*/
Albert Leec187c4b2005-10-04 08:46:51 -04001196 if ((cyl >> 16) || (head >> 4) || (sect >> 8) || (!sect))
Douglas Gilbertae006512005-10-09 09:09:35 -04001197 goto out_of_range;
Albert Leec187c4b2005-10-04 08:46:51 -04001198
Albert Lee8bf62ece2005-05-12 15:29:42 -04001199 qc->nsect = n_block;
1200 tf->nsect = n_block & 0xff; /* Sector count 0 means 256 sectors */
1201 tf->lbal = sect;
1202 tf->lbam = cyl;
1203 tf->lbah = cyl >> 8;
1204 tf->device |= head;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001205 }
1206
Albert Lee8bf62ece2005-05-12 15:29:42 -04001207 return 0;
Jeff Garzik13593262005-08-27 04:20:12 -04001208
Douglas Gilbertae006512005-10-09 09:09:35 -04001209invalid_fld:
1210 ata_scsi_set_sense(qc->scsicmd, ILLEGAL_REQUEST, 0x24, 0x0);
1211 /* "Invalid field in cbd" */
1212 return 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001213
Douglas Gilbertae006512005-10-09 09:09:35 -04001214out_of_range:
1215 ata_scsi_set_sense(qc->scsicmd, ILLEGAL_REQUEST, 0x21, 0x0);
1216 /* "Logical Block Address out of range" */
1217 return 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001218
Douglas Gilbertae006512005-10-09 09:09:35 -04001219nothing_to_do:
1220 qc->scsicmd->result = SAM_STAT_GOOD;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001221 return 1;
1222}
1223
Jeff Garzika7dac442005-10-30 04:44:42 -05001224static int ata_scsi_qc_complete(struct ata_queued_cmd *qc,
1225 unsigned int err_mask)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001226{
1227 struct scsi_cmnd *cmd = qc->scsicmd;
Jeff Garzika7dac442005-10-30 04:44:42 -05001228 u8 *cdb = cmd->cmnd;
1229 int need_sense = (err_mask != 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001230
Jeff Garzikb0955182005-05-12 15:45:22 -04001231 /* For ATA pass thru (SAT) commands, generate a sense block if
1232 * user mandated it or if there's an error. Note that if we
1233 * generate because the user forced us to, a check condition
1234 * is generated and the ATA register values are returned
1235 * whether the command completed successfully or not. If there
1236 * was no error, SK, ASC and ASCQ will all be zero.
1237 */
Jeff Garzika7dac442005-10-30 04:44:42 -05001238 if (((cdb[0] == ATA_16) || (cdb[0] == ATA_12)) &&
1239 ((cdb[2] & 0x20) || need_sense)) {
Jeff Garzikb0955182005-05-12 15:45:22 -04001240 ata_gen_ata_desc_sense(qc);
1241 } else {
1242 if (!need_sense) {
1243 cmd->result = SAM_STAT_GOOD;
1244 } else {
1245 /* TODO: decide which descriptor format to use
1246 * for 48b LBA devices and call that here
1247 * instead of the fixed desc, which is only
1248 * good for smaller LBA (and maybe CHS?)
1249 * devices.
1250 */
1251 ata_gen_fixed_sense(qc);
1252 }
1253 }
1254
1255 if (need_sense) {
1256 /* The ata_gen_..._sense routines fill in tf */
1257 ata_dump_status(qc->ap->id, &qc->tf);
1258 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001259
1260 qc->scsidone(cmd);
1261
1262 return 0;
1263}
1264
1265/**
1266 * ata_scsi_translate - Translate then issue SCSI command to ATA device
1267 * @ap: ATA port to which the command is addressed
1268 * @dev: ATA device to which the command is addressed
1269 * @cmd: SCSI command to execute
1270 * @done: SCSI command completion function
1271 * @xlat_func: Actor which translates @cmd to an ATA taskfile
1272 *
1273 * Our ->queuecommand() function has decided that the SCSI
1274 * command issued can be directly translated into an ATA
1275 * command, rather than handled internally.
1276 *
1277 * This function sets up an ata_queued_cmd structure for the
1278 * SCSI command, and sends that ata_queued_cmd to the hardware.
1279 *
Douglas Gilbertae006512005-10-09 09:09:35 -04001280 * The xlat_func argument (actor) returns 0 if ready to execute
1281 * ATA command, else 1 to finish translation. If 1 is returned
1282 * then cmd->result (and possibly cmd->sense_buffer) are assumed
1283 * to be set reflecting an error condition or clean (early)
1284 * termination.
1285 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07001286 * LOCKING:
1287 * spin_lock_irqsave(host_set lock)
1288 */
1289
1290static void ata_scsi_translate(struct ata_port *ap, struct ata_device *dev,
1291 struct scsi_cmnd *cmd,
1292 void (*done)(struct scsi_cmnd *),
1293 ata_xlat_func_t xlat_func)
1294{
1295 struct ata_queued_cmd *qc;
1296 u8 *scsicmd = cmd->cmnd;
1297
1298 VPRINTK("ENTER\n");
1299
1300 qc = ata_scsi_qc_new(ap, dev, cmd, done);
1301 if (!qc)
Douglas Gilbertae006512005-10-09 09:09:35 -04001302 goto err_mem;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001303
1304 /* data is present; dma-map it */
be7db052005-04-17 15:26:13 -05001305 if (cmd->sc_data_direction == DMA_FROM_DEVICE ||
1306 cmd->sc_data_direction == DMA_TO_DEVICE) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001307 if (unlikely(cmd->request_bufflen < 1)) {
1308 printk(KERN_WARNING "ata%u(%u): WARNING: zero len r/w req\n",
1309 ap->id, dev->devno);
Douglas Gilbertae006512005-10-09 09:09:35 -04001310 goto err_did;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001311 }
1312
1313 if (cmd->use_sg)
1314 ata_sg_init(qc, cmd->request_buffer, cmd->use_sg);
1315 else
1316 ata_sg_init_one(qc, cmd->request_buffer,
1317 cmd->request_bufflen);
1318
1319 qc->dma_dir = cmd->sc_data_direction;
1320 }
1321
1322 qc->complete_fn = ata_scsi_qc_complete;
1323
1324 if (xlat_func(qc, scsicmd))
Douglas Gilbertae006512005-10-09 09:09:35 -04001325 goto early_finish;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001326
1327 /* select device, send command to hardware */
1328 if (ata_qc_issue(qc))
Douglas Gilbertae006512005-10-09 09:09:35 -04001329 goto err_did;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001330
1331 VPRINTK("EXIT\n");
1332 return;
1333
Douglas Gilbertae006512005-10-09 09:09:35 -04001334early_finish:
1335 ata_qc_free(qc);
1336 done(cmd);
1337 DPRINTK("EXIT - early finish (good or error)\n");
1338 return;
1339
1340err_did:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001341 ata_qc_free(qc);
Douglas Gilbertae006512005-10-09 09:09:35 -04001342err_mem:
1343 cmd->result = (DID_ERROR << 16);
1344 done(cmd);
1345 DPRINTK("EXIT - internal\n");
1346 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001347}
1348
1349/**
1350 * ata_scsi_rbuf_get - Map response buffer.
1351 * @cmd: SCSI command containing buffer to be mapped.
1352 * @buf_out: Pointer to mapped area.
1353 *
1354 * Maps buffer contained within SCSI command @cmd.
1355 *
1356 * LOCKING:
1357 * spin_lock_irqsave(host_set lock)
1358 *
1359 * RETURNS:
1360 * Length of response buffer.
1361 */
1362
1363static unsigned int ata_scsi_rbuf_get(struct scsi_cmnd *cmd, u8 **buf_out)
1364{
1365 u8 *buf;
1366 unsigned int buflen;
1367
1368 if (cmd->use_sg) {
1369 struct scatterlist *sg;
1370
1371 sg = (struct scatterlist *) cmd->request_buffer;
1372 buf = kmap_atomic(sg->page, KM_USER0) + sg->offset;
1373 buflen = sg->length;
1374 } else {
1375 buf = cmd->request_buffer;
1376 buflen = cmd->request_bufflen;
1377 }
1378
1379 *buf_out = buf;
1380 return buflen;
1381}
1382
1383/**
1384 * ata_scsi_rbuf_put - Unmap response buffer.
1385 * @cmd: SCSI command containing buffer to be unmapped.
1386 * @buf: buffer to unmap
1387 *
1388 * Unmaps response buffer contained within @cmd.
1389 *
1390 * LOCKING:
1391 * spin_lock_irqsave(host_set lock)
1392 */
1393
1394static inline void ata_scsi_rbuf_put(struct scsi_cmnd *cmd, u8 *buf)
1395{
1396 if (cmd->use_sg) {
1397 struct scatterlist *sg;
1398
1399 sg = (struct scatterlist *) cmd->request_buffer;
1400 kunmap_atomic(buf - sg->offset, KM_USER0);
1401 }
1402}
1403
1404/**
1405 * ata_scsi_rbuf_fill - wrapper for SCSI command simulators
1406 * @args: device IDENTIFY data / SCSI command of interest.
1407 * @actor: Callback hook for desired SCSI command simulator
1408 *
1409 * Takes care of the hard work of simulating a SCSI command...
1410 * Mapping the response buffer, calling the command's handler,
1411 * and handling the handler's return value. This return value
1412 * indicates whether the handler wishes the SCSI command to be
Douglas Gilbertae006512005-10-09 09:09:35 -04001413 * completed successfully (0), or not (in which case cmd->result
1414 * and sense buffer are assumed to be set).
Linus Torvalds1da177e2005-04-16 15:20:36 -07001415 *
1416 * LOCKING:
1417 * spin_lock_irqsave(host_set lock)
1418 */
1419
1420void ata_scsi_rbuf_fill(struct ata_scsi_args *args,
1421 unsigned int (*actor) (struct ata_scsi_args *args,
1422 u8 *rbuf, unsigned int buflen))
1423{
1424 u8 *rbuf;
1425 unsigned int buflen, rc;
1426 struct scsi_cmnd *cmd = args->cmd;
1427
1428 buflen = ata_scsi_rbuf_get(cmd, &rbuf);
1429 memset(rbuf, 0, buflen);
1430 rc = actor(args, rbuf, buflen);
1431 ata_scsi_rbuf_put(cmd, rbuf);
1432
Douglas Gilbertae006512005-10-09 09:09:35 -04001433 if (rc == 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001434 cmd->result = SAM_STAT_GOOD;
Douglas Gilbertae006512005-10-09 09:09:35 -04001435 args->done(cmd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001436}
1437
1438/**
1439 * ata_scsiop_inq_std - Simulate INQUIRY command
1440 * @args: device IDENTIFY data / SCSI command of interest.
1441 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1442 * @buflen: Response buffer length.
1443 *
1444 * Returns standard device identification data associated
1445 * with non-EVPD INQUIRY command output.
1446 *
1447 * LOCKING:
1448 * spin_lock_irqsave(host_set lock)
1449 */
1450
1451unsigned int ata_scsiop_inq_std(struct ata_scsi_args *args, u8 *rbuf,
1452 unsigned int buflen)
1453{
1454 u8 hdr[] = {
1455 TYPE_DISK,
1456 0,
1457 0x5, /* claim SPC-3 version compatibility */
1458 2,
1459 95 - 4
1460 };
1461
1462 /* set scsi removeable (RMB) bit per ata bit */
1463 if (ata_id_removeable(args->id))
1464 hdr[1] |= (1 << 7);
1465
1466 VPRINTK("ENTER\n");
1467
1468 memcpy(rbuf, hdr, sizeof(hdr));
1469
1470 if (buflen > 35) {
1471 memcpy(&rbuf[8], "ATA ", 8);
1472 ata_dev_id_string(args->id, &rbuf[16], ATA_ID_PROD_OFS, 16);
1473 ata_dev_id_string(args->id, &rbuf[32], ATA_ID_FW_REV_OFS, 4);
1474 if (rbuf[32] == 0 || rbuf[32] == ' ')
1475 memcpy(&rbuf[32], "n/a ", 4);
1476 }
1477
1478 if (buflen > 63) {
1479 const u8 versions[] = {
1480 0x60, /* SAM-3 (no version claimed) */
1481
1482 0x03,
1483 0x20, /* SBC-2 (no version claimed) */
1484
1485 0x02,
1486 0x60 /* SPC-3 (no version claimed) */
1487 };
1488
1489 memcpy(rbuf + 59, versions, sizeof(versions));
1490 }
1491
1492 return 0;
1493}
1494
1495/**
1496 * ata_scsiop_inq_00 - Simulate INQUIRY EVPD page 0, list of pages
1497 * @args: device IDENTIFY data / SCSI command of interest.
1498 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1499 * @buflen: Response buffer length.
1500 *
1501 * Returns list of inquiry EVPD pages available.
1502 *
1503 * LOCKING:
1504 * spin_lock_irqsave(host_set lock)
1505 */
1506
1507unsigned int ata_scsiop_inq_00(struct ata_scsi_args *args, u8 *rbuf,
1508 unsigned int buflen)
1509{
1510 const u8 pages[] = {
1511 0x00, /* page 0x00, this page */
1512 0x80, /* page 0x80, unit serial no page */
1513 0x83 /* page 0x83, device ident page */
1514 };
1515 rbuf[3] = sizeof(pages); /* number of supported EVPD pages */
1516
1517 if (buflen > 6)
1518 memcpy(rbuf + 4, pages, sizeof(pages));
1519
1520 return 0;
1521}
1522
1523/**
1524 * ata_scsiop_inq_80 - Simulate INQUIRY EVPD page 80, device serial number
1525 * @args: device IDENTIFY data / SCSI command of interest.
1526 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1527 * @buflen: Response buffer length.
1528 *
1529 * Returns ATA device serial number.
1530 *
1531 * LOCKING:
1532 * spin_lock_irqsave(host_set lock)
1533 */
1534
1535unsigned int ata_scsiop_inq_80(struct ata_scsi_args *args, u8 *rbuf,
1536 unsigned int buflen)
1537{
1538 const u8 hdr[] = {
1539 0,
1540 0x80, /* this page code */
1541 0,
1542 ATA_SERNO_LEN, /* page len */
1543 };
1544 memcpy(rbuf, hdr, sizeof(hdr));
1545
1546 if (buflen > (ATA_SERNO_LEN + 4 - 1))
1547 ata_dev_id_string(args->id, (unsigned char *) &rbuf[4],
1548 ATA_ID_SERNO_OFS, ATA_SERNO_LEN);
1549
1550 return 0;
1551}
1552
1553static const char *inq_83_str = "Linux ATA-SCSI simulator";
1554
1555/**
1556 * ata_scsiop_inq_83 - Simulate INQUIRY EVPD page 83, device identity
1557 * @args: device IDENTIFY data / SCSI command of interest.
1558 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1559 * @buflen: Response buffer length.
1560 *
1561 * Returns device identification. Currently hardcoded to
1562 * return "Linux ATA-SCSI simulator".
1563 *
1564 * LOCKING:
1565 * spin_lock_irqsave(host_set lock)
1566 */
1567
1568unsigned int ata_scsiop_inq_83(struct ata_scsi_args *args, u8 *rbuf,
1569 unsigned int buflen)
1570{
1571 rbuf[1] = 0x83; /* this page code */
1572 rbuf[3] = 4 + strlen(inq_83_str); /* page len */
1573
1574 /* our one and only identification descriptor (vendor-specific) */
1575 if (buflen > (strlen(inq_83_str) + 4 + 4 - 1)) {
1576 rbuf[4 + 0] = 2; /* code set: ASCII */
1577 rbuf[4 + 3] = strlen(inq_83_str);
1578 memcpy(rbuf + 4 + 4, inq_83_str, strlen(inq_83_str));
1579 }
1580
1581 return 0;
1582}
1583
1584/**
Jeff Garzik0cba6322005-05-30 19:49:12 -04001585 * ata_scsiop_noop - Command handler that simply returns success.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001586 * @args: device IDENTIFY data / SCSI command of interest.
1587 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1588 * @buflen: Response buffer length.
1589 *
1590 * No operation. Simply returns success to caller, to indicate
1591 * that the caller should successfully complete this SCSI command.
1592 *
1593 * LOCKING:
1594 * spin_lock_irqsave(host_set lock)
1595 */
1596
1597unsigned int ata_scsiop_noop(struct ata_scsi_args *args, u8 *rbuf,
1598 unsigned int buflen)
1599{
1600 VPRINTK("ENTER\n");
1601 return 0;
1602}
1603
1604/**
1605 * ata_msense_push - Push data onto MODE SENSE data output buffer
1606 * @ptr_io: (input/output) Location to store more output data
1607 * @last: End of output data buffer
1608 * @buf: Pointer to BLOB being added to output buffer
1609 * @buflen: Length of BLOB
1610 *
1611 * Store MODE SENSE data on an output buffer.
1612 *
1613 * LOCKING:
1614 * None.
1615 */
1616
1617static void ata_msense_push(u8 **ptr_io, const u8 *last,
1618 const u8 *buf, unsigned int buflen)
1619{
1620 u8 *ptr = *ptr_io;
1621
1622 if ((ptr + buflen - 1) > last)
1623 return;
1624
1625 memcpy(ptr, buf, buflen);
1626
1627 ptr += buflen;
1628
1629 *ptr_io = ptr;
1630}
1631
1632/**
1633 * ata_msense_caching - Simulate MODE SENSE caching info page
1634 * @id: device IDENTIFY data
1635 * @ptr_io: (input/output) Location to store more output data
1636 * @last: End of output data buffer
1637 *
1638 * Generate a caching info page, which conditionally indicates
1639 * write caching to the SCSI layer, depending on device
1640 * capabilities.
1641 *
1642 * LOCKING:
1643 * None.
1644 */
1645
1646static unsigned int ata_msense_caching(u16 *id, u8 **ptr_io,
1647 const u8 *last)
1648{
Douglas Gilbert00ac37f2005-10-28 15:58:28 -04001649 u8 page[CACHE_MPAGE_LEN];
Linus Torvalds1da177e2005-04-16 15:20:36 -07001650
Douglas Gilbert00ac37f2005-10-28 15:58:28 -04001651 memcpy(page, def_cache_mpage, sizeof(page));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001652 if (ata_id_wcache_enabled(id))
1653 page[2] |= (1 << 2); /* write cache enable */
1654 if (!ata_id_rahead_enabled(id))
1655 page[12] |= (1 << 5); /* disable read ahead */
1656
1657 ata_msense_push(ptr_io, last, page, sizeof(page));
1658 return sizeof(page);
1659}
1660
1661/**
1662 * ata_msense_ctl_mode - Simulate MODE SENSE control mode page
1663 * @dev: Device associated with this MODE SENSE command
1664 * @ptr_io: (input/output) Location to store more output data
1665 * @last: End of output data buffer
1666 *
1667 * Generate a generic MODE SENSE control mode page.
1668 *
1669 * LOCKING:
1670 * None.
1671 */
1672
1673static unsigned int ata_msense_ctl_mode(u8 **ptr_io, const u8 *last)
1674{
Douglas Gilbert00ac37f2005-10-28 15:58:28 -04001675 ata_msense_push(ptr_io, last, def_control_mpage,
1676 sizeof(def_control_mpage));
1677 return sizeof(def_control_mpage);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001678}
1679
1680/**
1681 * ata_msense_rw_recovery - Simulate MODE SENSE r/w error recovery page
1682 * @dev: Device associated with this MODE SENSE command
1683 * @ptr_io: (input/output) Location to store more output data
1684 * @last: End of output data buffer
1685 *
1686 * Generate a generic MODE SENSE r/w error recovery page.
1687 *
1688 * LOCKING:
1689 * None.
1690 */
1691
1692static unsigned int ata_msense_rw_recovery(u8 **ptr_io, const u8 *last)
1693{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001694
Douglas Gilbert00ac37f2005-10-28 15:58:28 -04001695 ata_msense_push(ptr_io, last, def_rw_recovery_mpage,
1696 sizeof(def_rw_recovery_mpage));
1697 return sizeof(def_rw_recovery_mpage);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001698}
1699
1700/**
1701 * ata_scsiop_mode_sense - Simulate MODE SENSE 6, 10 commands
1702 * @args: device IDENTIFY data / SCSI command of interest.
1703 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1704 * @buflen: Response buffer length.
1705 *
Douglas Gilbert00ac37f2005-10-28 15:58:28 -04001706 * Simulate MODE SENSE commands. Assume this is invoked for direct
1707 * access devices (e.g. disks) only. There should be no block
1708 * descriptor for other device types.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001709 *
1710 * LOCKING:
1711 * spin_lock_irqsave(host_set lock)
1712 */
1713
1714unsigned int ata_scsiop_mode_sense(struct ata_scsi_args *args, u8 *rbuf,
1715 unsigned int buflen)
1716{
1717 u8 *scsicmd = args->cmd->cmnd, *p, *last;
Douglas Gilbert00ac37f2005-10-28 15:58:28 -04001718 const u8 sat_blk_desc[] = {
1719 0, 0, 0, 0, /* number of blocks: sat unspecified */
1720 0,
1721 0, 0x2, 0x0 /* block length: 512 bytes */
1722 };
1723 u8 pg, spg;
1724 unsigned int ebd, page_control, six_byte, output_len, alloc_len, minlen;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001725
1726 VPRINTK("ENTER\n");
1727
1728 six_byte = (scsicmd[0] == MODE_SENSE);
Douglas Gilbert00ac37f2005-10-28 15:58:28 -04001729 ebd = !(scsicmd[1] & 0x8); /* dbd bit inverted == edb */
1730 /*
1731 * LLBA bit in msense(10) ignored (compliant)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001732 */
Douglas Gilbert00ac37f2005-10-28 15:58:28 -04001733
Linus Torvalds1da177e2005-04-16 15:20:36 -07001734 page_control = scsicmd[2] >> 6;
Douglas Gilbertae006512005-10-09 09:09:35 -04001735 switch (page_control) {
1736 case 0: /* current */
1737 break; /* supported */
1738 case 3: /* saved */
1739 goto saving_not_supp;
1740 case 1: /* changeable */
1741 case 2: /* defaults */
1742 default:
1743 goto invalid_fld;
1744 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001745
Douglas Gilbert00ac37f2005-10-28 15:58:28 -04001746 if (six_byte) {
1747 output_len = 4 + (ebd ? 8 : 0);
1748 alloc_len = scsicmd[4];
1749 } else {
1750 output_len = 8 + (ebd ? 8 : 0);
1751 alloc_len = (scsicmd[7] << 8) + scsicmd[8];
1752 }
1753 minlen = (alloc_len < buflen) ? alloc_len : buflen;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001754
1755 p = rbuf + output_len;
Douglas Gilbert00ac37f2005-10-28 15:58:28 -04001756 last = rbuf + minlen - 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001757
Douglas Gilbert00ac37f2005-10-28 15:58:28 -04001758 pg = scsicmd[2] & 0x3f;
1759 spg = scsicmd[3];
1760 /*
1761 * No mode subpages supported (yet) but asking for _all_
1762 * subpages may be valid
1763 */
1764 if (spg && (spg != ALL_SUB_MPAGES))
1765 goto invalid_fld;
1766
1767 switch(pg) {
1768 case RW_RECOVERY_MPAGE:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001769 output_len += ata_msense_rw_recovery(&p, last);
1770 break;
1771
Douglas Gilbert00ac37f2005-10-28 15:58:28 -04001772 case CACHE_MPAGE:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001773 output_len += ata_msense_caching(args->id, &p, last);
1774 break;
1775
Douglas Gilbert00ac37f2005-10-28 15:58:28 -04001776 case CONTROL_MPAGE: {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001777 output_len += ata_msense_ctl_mode(&p, last);
1778 break;
1779 }
1780
Douglas Gilbert00ac37f2005-10-28 15:58:28 -04001781 case ALL_MPAGES:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001782 output_len += ata_msense_rw_recovery(&p, last);
1783 output_len += ata_msense_caching(args->id, &p, last);
1784 output_len += ata_msense_ctl_mode(&p, last);
1785 break;
1786
1787 default: /* invalid page code */
Douglas Gilbertae006512005-10-09 09:09:35 -04001788 goto invalid_fld;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001789 }
1790
Douglas Gilbert00ac37f2005-10-28 15:58:28 -04001791 if (minlen < 1)
1792 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001793 if (six_byte) {
1794 output_len--;
1795 rbuf[0] = output_len;
Douglas Gilbert00ac37f2005-10-28 15:58:28 -04001796 if (ebd) {
1797 if (minlen > 3)
1798 rbuf[3] = sizeof(sat_blk_desc);
1799 if (minlen > 11)
1800 memcpy(rbuf + 4, sat_blk_desc,
1801 sizeof(sat_blk_desc));
1802 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001803 } else {
1804 output_len -= 2;
1805 rbuf[0] = output_len >> 8;
Douglas Gilbert00ac37f2005-10-28 15:58:28 -04001806 if (minlen > 1)
1807 rbuf[1] = output_len;
1808 if (ebd) {
1809 if (minlen > 7)
1810 rbuf[7] = sizeof(sat_blk_desc);
1811 if (minlen > 15)
1812 memcpy(rbuf + 8, sat_blk_desc,
1813 sizeof(sat_blk_desc));
1814 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001815 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001816 return 0;
Douglas Gilbertae006512005-10-09 09:09:35 -04001817
1818invalid_fld:
1819 ata_scsi_set_sense(args->cmd, ILLEGAL_REQUEST, 0x24, 0x0);
1820 /* "Invalid field in cbd" */
1821 return 1;
1822
1823saving_not_supp:
1824 ata_scsi_set_sense(args->cmd, ILLEGAL_REQUEST, 0x39, 0x0);
1825 /* "Saving parameters not supported" */
1826 return 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001827}
1828
1829/**
1830 * ata_scsiop_read_cap - Simulate READ CAPACITY[ 16] commands
1831 * @args: device IDENTIFY data / SCSI command of interest.
1832 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1833 * @buflen: Response buffer length.
1834 *
1835 * Simulate READ CAPACITY commands.
1836 *
1837 * LOCKING:
1838 * spin_lock_irqsave(host_set lock)
1839 */
1840
1841unsigned int ata_scsiop_read_cap(struct ata_scsi_args *args, u8 *rbuf,
1842 unsigned int buflen)
1843{
1844 u64 n_sectors;
1845 u32 tmp;
1846
1847 VPRINTK("ENTER\n");
1848
Albert Lee8bf62ece2005-05-12 15:29:42 -04001849 if (ata_id_has_lba(args->id)) {
1850 if (ata_id_has_lba48(args->id))
1851 n_sectors = ata_id_u64(args->id, 100);
1852 else
1853 n_sectors = ata_id_u32(args->id, 60);
1854 } else {
1855 /* CHS default translation */
1856 n_sectors = args->id[1] * args->id[3] * args->id[6];
1857
1858 if (ata_id_current_chs_valid(args->id))
1859 /* CHS current translation */
1860 n_sectors = ata_id_u32(args->id, 57);
1861 }
1862
Linus Torvalds1da177e2005-04-16 15:20:36 -07001863 n_sectors--; /* ATA TotalUserSectors - 1 */
1864
Linus Torvalds1da177e2005-04-16 15:20:36 -07001865 if (args->cmd->cmnd[0] == READ_CAPACITY) {
Philip Pokorny0c144d02005-05-28 01:24:47 -07001866 if( n_sectors >= 0xffffffffULL )
1867 tmp = 0xffffffff ; /* Return max count on overflow */
1868 else
1869 tmp = n_sectors ;
1870
Linus Torvalds1da177e2005-04-16 15:20:36 -07001871 /* sector count, 32-bit */
1872 rbuf[0] = tmp >> (8 * 3);
1873 rbuf[1] = tmp >> (8 * 2);
1874 rbuf[2] = tmp >> (8 * 1);
1875 rbuf[3] = tmp;
1876
1877 /* sector size */
1878 tmp = ATA_SECT_SIZE;
1879 rbuf[6] = tmp >> 8;
1880 rbuf[7] = tmp;
1881
1882 } else {
1883 /* sector count, 64-bit */
Philip Pokorny0c144d02005-05-28 01:24:47 -07001884 tmp = n_sectors >> (8 * 4);
1885 rbuf[2] = tmp >> (8 * 3);
1886 rbuf[3] = tmp >> (8 * 2);
1887 rbuf[4] = tmp >> (8 * 1);
1888 rbuf[5] = tmp;
1889 tmp = n_sectors;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001890 rbuf[6] = tmp >> (8 * 3);
1891 rbuf[7] = tmp >> (8 * 2);
1892 rbuf[8] = tmp >> (8 * 1);
1893 rbuf[9] = tmp;
1894
1895 /* sector size */
1896 tmp = ATA_SECT_SIZE;
1897 rbuf[12] = tmp >> 8;
1898 rbuf[13] = tmp;
1899 }
1900
1901 return 0;
1902}
1903
1904/**
1905 * ata_scsiop_report_luns - Simulate REPORT LUNS command
1906 * @args: device IDENTIFY data / SCSI command of interest.
1907 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1908 * @buflen: Response buffer length.
1909 *
1910 * Simulate REPORT LUNS command.
1911 *
1912 * LOCKING:
1913 * spin_lock_irqsave(host_set lock)
1914 */
1915
1916unsigned int ata_scsiop_report_luns(struct ata_scsi_args *args, u8 *rbuf,
1917 unsigned int buflen)
1918{
1919 VPRINTK("ENTER\n");
1920 rbuf[3] = 8; /* just one lun, LUN 0, size 8 bytes */
1921
1922 return 0;
1923}
1924
1925/**
Douglas Gilbert845c5832005-10-09 08:55:41 -04001926 * ata_scsi_set_sense - Set SCSI sense data and status
1927 * @cmd: SCSI request to be handled
1928 * @sk: SCSI-defined sense key
1929 * @asc: SCSI-defined additional sense code
1930 * @ascq: SCSI-defined additional sense code qualifier
1931 *
1932 * Helper function that builds a valid fixed format, current
1933 * response code and the given sense key (sk), additional sense
1934 * code (asc) and additional sense code qualifier (ascq) with
1935 * a SCSI command status of %SAM_STAT_CHECK_CONDITION and
1936 * DRIVER_SENSE set in the upper bits of scsi_cmnd::result .
1937 *
1938 * LOCKING:
1939 * Not required
1940 */
1941
1942void ata_scsi_set_sense(struct scsi_cmnd *cmd, u8 sk, u8 asc, u8 ascq)
1943{
1944 cmd->result = (DRIVER_SENSE << 24) | SAM_STAT_CHECK_CONDITION;
1945
1946 cmd->sense_buffer[0] = 0x70; /* fixed format, current */
1947 cmd->sense_buffer[2] = sk;
1948 cmd->sense_buffer[7] = 18 - 8; /* additional sense length */
1949 cmd->sense_buffer[12] = asc;
1950 cmd->sense_buffer[13] = ascq;
1951}
1952
1953/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07001954 * ata_scsi_badcmd - End a SCSI request with an error
1955 * @cmd: SCSI request to be handled
1956 * @done: SCSI command completion function
1957 * @asc: SCSI-defined additional sense code
1958 * @ascq: SCSI-defined additional sense code qualifier
1959 *
1960 * Helper function that completes a SCSI command with
1961 * %SAM_STAT_CHECK_CONDITION, with a sense key %ILLEGAL_REQUEST
1962 * and the specified additional sense codes.
1963 *
1964 * LOCKING:
1965 * spin_lock_irqsave(host_set lock)
1966 */
1967
1968void ata_scsi_badcmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *), u8 asc, u8 ascq)
1969{
1970 DPRINTK("ENTER\n");
Douglas Gilbertae006512005-10-09 09:09:35 -04001971 ata_scsi_set_sense(cmd, ILLEGAL_REQUEST, asc, ascq);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001972
1973 done(cmd);
1974}
1975
Jeff Garzika939c962005-10-05 17:09:16 -04001976void atapi_request_sense(struct ata_port *ap, struct ata_device *dev,
1977 struct scsi_cmnd *cmd)
1978{
1979 DECLARE_COMPLETION(wait);
1980 struct ata_queued_cmd *qc;
1981 unsigned long flags;
1982 int rc;
1983
1984 DPRINTK("ATAPI request sense\n");
1985
1986 qc = ata_qc_new_init(ap, dev);
1987 BUG_ON(qc == NULL);
1988
1989 /* FIXME: is this needed? */
1990 memset(cmd->sense_buffer, 0, sizeof(cmd->sense_buffer));
1991
1992 ata_sg_init_one(qc, cmd->sense_buffer, sizeof(cmd->sense_buffer));
1993 qc->dma_dir = DMA_FROM_DEVICE;
1994
1995 memset(&qc->cdb, 0, ap->cdb_len);
1996 qc->cdb[0] = REQUEST_SENSE;
1997 qc->cdb[4] = SCSI_SENSE_BUFFERSIZE;
1998
1999 qc->tf.flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
2000 qc->tf.command = ATA_CMD_PACKET;
2001
2002 qc->tf.protocol = ATA_PROT_ATAPI;
2003 qc->tf.lbam = (8 * 1024) & 0xff;
2004 qc->tf.lbah = (8 * 1024) >> 8;
2005 qc->nbytes = SCSI_SENSE_BUFFERSIZE;
2006
2007 qc->waiting = &wait;
2008 qc->complete_fn = ata_qc_complete_noop;
2009
2010 spin_lock_irqsave(&ap->host_set->lock, flags);
2011 rc = ata_qc_issue(qc);
2012 spin_unlock_irqrestore(&ap->host_set->lock, flags);
2013
2014 if (rc)
2015 ata_port_disable(ap);
2016 else
2017 wait_for_completion(&wait);
2018
2019 DPRINTK("EXIT\n");
2020}
2021
Jeff Garzika7dac442005-10-30 04:44:42 -05002022static int atapi_qc_complete(struct ata_queued_cmd *qc, unsigned int err_mask)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002023{
2024 struct scsi_cmnd *cmd = qc->scsicmd;
2025
Jeff Garzika7dac442005-10-30 04:44:42 -05002026 VPRINTK("ENTER, err_mask 0x%X\n", err_mask);
Jeff Garzike12669e2005-10-05 18:39:23 -04002027
Jeff Garzika7dac442005-10-30 04:44:42 -05002028 if (unlikely(err_mask & AC_ERR_DEV)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002029 DPRINTK("request check condition\n");
2030
Jeff Garzika15dbeb2005-10-05 15:02:14 -04002031 /* FIXME: command completion with check condition
2032 * but no sense causes the error handler to run,
2033 * which then issues REQUEST SENSE, fills in the sense
2034 * buffer, and completes the command (for the second
2035 * time). We need to issue REQUEST SENSE some other
2036 * way, to avoid completing the command twice.
2037 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002038 cmd->result = SAM_STAT_CHECK_CONDITION;
2039
2040 qc->scsidone(cmd);
2041
2042 return 1;
Jeff Garzike12669e2005-10-05 18:39:23 -04002043 }
2044
Jeff Garzika7dac442005-10-30 04:44:42 -05002045 else if (unlikely(err_mask))
2046 /* FIXME: not quite right; we don't want the
2047 * translation of taskfile registers into
2048 * a sense descriptors, since that's only
2049 * correct for ATA, not ATAPI
2050 */
2051 ata_gen_ata_desc_sense(qc);
2052
Jeff Garzike12669e2005-10-05 18:39:23 -04002053 else {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002054 u8 *scsicmd = cmd->cmnd;
2055
2056 if (scsicmd[0] == INQUIRY) {
2057 u8 *buf = NULL;
2058 unsigned int buflen;
2059
2060 buflen = ata_scsi_rbuf_get(cmd, &buf);
Jeff Garzika15dbeb2005-10-05 15:02:14 -04002061
2062 /* ATAPI devices typically report zero for their SCSI version,
2063 * and sometimes deviate from the spec WRT response data
2064 * format. If SCSI version is reported as zero like normal,
2065 * then we make the following fixups: 1) Fake MMC-5 version,
2066 * to indicate to the Linux scsi midlayer this is a modern
2067 * device. 2) Ensure response data format / ATAPI information
2068 * are always correct.
2069 */
2070 /* FIXME: do we ever override EVPD pages and the like, with
2071 * this code?
2072 */
2073 if (buf[2] == 0) {
2074 buf[2] = 0x5;
2075 buf[3] = 0x32;
2076 }
2077
Linus Torvalds1da177e2005-04-16 15:20:36 -07002078 ata_scsi_rbuf_put(cmd, buf);
2079 }
Jeff Garzika15dbeb2005-10-05 15:02:14 -04002080
Linus Torvalds1da177e2005-04-16 15:20:36 -07002081 cmd->result = SAM_STAT_GOOD;
2082 }
2083
2084 qc->scsidone(cmd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002085 return 0;
2086}
2087/**
2088 * atapi_xlat - Initialize PACKET taskfile
2089 * @qc: command structure to be initialized
2090 * @scsicmd: SCSI CDB associated with this PACKET command
2091 *
2092 * LOCKING:
2093 * spin_lock_irqsave(host_set lock)
2094 *
2095 * RETURNS:
2096 * Zero on success, non-zero on failure.
2097 */
2098
Jeff Garzik057ace52005-10-22 14:27:05 -04002099static unsigned int atapi_xlat(struct ata_queued_cmd *qc, const u8 *scsicmd)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002100{
2101 struct scsi_cmnd *cmd = qc->scsicmd;
2102 struct ata_device *dev = qc->dev;
2103 int using_pio = (dev->flags & ATA_DFLAG_PIO);
be7db052005-04-17 15:26:13 -05002104 int nodata = (cmd->sc_data_direction == DMA_NONE);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002105
2106 if (!using_pio)
2107 /* Check whether ATAPI DMA is safe */
2108 if (ata_check_atapi_dma(qc))
2109 using_pio = 1;
2110
2111 memcpy(&qc->cdb, scsicmd, qc->ap->cdb_len);
2112
2113 qc->complete_fn = atapi_qc_complete;
2114
2115 qc->tf.flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
be7db052005-04-17 15:26:13 -05002116 if (cmd->sc_data_direction == DMA_TO_DEVICE) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002117 qc->tf.flags |= ATA_TFLAG_WRITE;
2118 DPRINTK("direction: write\n");
2119 }
2120
2121 qc->tf.command = ATA_CMD_PACKET;
2122
2123 /* no data, or PIO data xfer */
2124 if (using_pio || nodata) {
2125 if (nodata)
2126 qc->tf.protocol = ATA_PROT_ATAPI_NODATA;
2127 else
2128 qc->tf.protocol = ATA_PROT_ATAPI;
2129 qc->tf.lbam = (8 * 1024) & 0xff;
2130 qc->tf.lbah = (8 * 1024) >> 8;
2131 }
2132
2133 /* DMA data xfer */
2134 else {
2135 qc->tf.protocol = ATA_PROT_ATAPI_DMA;
2136 qc->tf.feature |= ATAPI_PKT_DMA;
2137
2138#ifdef ATAPI_ENABLE_DMADIR
2139 /* some SATA bridges need us to indicate data xfer direction */
be7db052005-04-17 15:26:13 -05002140 if (cmd->sc_data_direction != DMA_TO_DEVICE)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002141 qc->tf.feature |= ATAPI_DMADIR;
2142#endif
2143 }
2144
2145 qc->nbytes = cmd->bufflen;
2146
2147 return 0;
2148}
2149
2150/**
2151 * ata_scsi_find_dev - lookup ata_device from scsi_cmnd
2152 * @ap: ATA port to which the device is attached
2153 * @scsidev: SCSI device from which we derive the ATA device
2154 *
2155 * Given various information provided in struct scsi_cmnd,
2156 * map that onto an ATA bus, and using that mapping
2157 * determine which ata_device is associated with the
2158 * SCSI command to be sent.
2159 *
2160 * LOCKING:
2161 * spin_lock_irqsave(host_set lock)
2162 *
2163 * RETURNS:
2164 * Associated ATA device, or %NULL if not found.
2165 */
2166
2167static struct ata_device *
Jeff Garzik057ace52005-10-22 14:27:05 -04002168ata_scsi_find_dev(struct ata_port *ap, const struct scsi_device *scsidev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002169{
2170 struct ata_device *dev;
2171
2172 /* skip commands not addressed to targets we simulate */
2173 if (likely(scsidev->id < ATA_MAX_DEVICES))
2174 dev = &ap->device[scsidev->id];
2175 else
2176 return NULL;
2177
2178 if (unlikely((scsidev->channel != 0) ||
2179 (scsidev->lun != 0)))
2180 return NULL;
2181
2182 if (unlikely(!ata_dev_present(dev)))
2183 return NULL;
2184
Jeff Garzik6f106232005-08-30 21:52:18 -04002185 if (!atapi_enabled) {
Jeff Garzik1623c812005-08-30 03:37:42 -04002186 if (unlikely(dev->class == ATA_DEV_ATAPI))
2187 return NULL;
2188 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002189
2190 return dev;
2191}
2192
Jeff Garzikb0955182005-05-12 15:45:22 -04002193/*
2194 * ata_scsi_map_proto - Map pass-thru protocol value to taskfile value.
2195 * @byte1: Byte 1 from pass-thru CDB.
2196 *
2197 * RETURNS:
2198 * ATA_PROT_UNKNOWN if mapping failed/unimplemented, protocol otherwise.
2199 */
2200static u8
2201ata_scsi_map_proto(u8 byte1)
2202{
2203 switch((byte1 & 0x1e) >> 1) {
2204 case 3: /* Non-data */
2205 return ATA_PROT_NODATA;
2206
2207 case 6: /* DMA */
2208 return ATA_PROT_DMA;
2209
2210 case 4: /* PIO Data-in */
2211 case 5: /* PIO Data-out */
2212 if (byte1 & 0xe0) {
2213 return ATA_PROT_PIO_MULT;
2214 }
2215 return ATA_PROT_PIO;
2216
2217 case 10: /* Device Reset */
2218 case 0: /* Hard Reset */
2219 case 1: /* SRST */
2220 case 2: /* Bus Idle */
2221 case 7: /* Packet */
2222 case 8: /* DMA Queued */
2223 case 9: /* Device Diagnostic */
2224 case 11: /* UDMA Data-in */
2225 case 12: /* UDMA Data-Out */
2226 case 13: /* FPDMA */
2227 default: /* Reserved */
2228 break;
2229 }
2230
2231 return ATA_PROT_UNKNOWN;
2232}
2233
2234/**
2235 * ata_scsi_pass_thru - convert ATA pass-thru CDB to taskfile
2236 * @qc: command structure to be initialized
Randy Dunlap8e8b77d2005-11-01 21:29:27 -08002237 * @scsicmd: SCSI command to convert
Jeff Garzikb0955182005-05-12 15:45:22 -04002238 *
2239 * Handles either 12 or 16-byte versions of the CDB.
2240 *
2241 * RETURNS:
2242 * Zero on success, non-zero on failure.
2243 */
2244static unsigned int
Douglas Gilbert00ac37f2005-10-28 15:58:28 -04002245ata_scsi_pass_thru(struct ata_queued_cmd *qc, const u8 *scsicmd)
Jeff Garzikb0955182005-05-12 15:45:22 -04002246{
2247 struct ata_taskfile *tf = &(qc->tf);
2248 struct scsi_cmnd *cmd = qc->scsicmd;
2249
2250 if ((tf->protocol = ata_scsi_map_proto(scsicmd[1])) == ATA_PROT_UNKNOWN)
2251 return 1;
2252
2253 /*
2254 * 12 and 16 byte CDBs use different offsets to
2255 * provide the various register values.
2256 */
2257 if (scsicmd[0] == ATA_16) {
2258 /*
2259 * 16-byte CDB - may contain extended commands.
2260 *
2261 * If that is the case, copy the upper byte register values.
2262 */
2263 if (scsicmd[1] & 0x01) {
2264 tf->hob_feature = scsicmd[3];
2265 tf->hob_nsect = scsicmd[5];
2266 tf->hob_lbal = scsicmd[7];
2267 tf->hob_lbam = scsicmd[9];
2268 tf->hob_lbah = scsicmd[11];
2269 tf->flags |= ATA_TFLAG_LBA48;
2270 } else
2271 tf->flags &= ~ATA_TFLAG_LBA48;
2272
2273 /*
2274 * Always copy low byte, device and command registers.
2275 */
2276 tf->feature = scsicmd[4];
2277 tf->nsect = scsicmd[6];
2278 tf->lbal = scsicmd[8];
2279 tf->lbam = scsicmd[10];
2280 tf->lbah = scsicmd[12];
2281 tf->device = scsicmd[13];
2282 tf->command = scsicmd[14];
2283 } else {
2284 /*
2285 * 12-byte CDB - incapable of extended commands.
2286 */
2287 tf->flags &= ~ATA_TFLAG_LBA48;
2288
2289 tf->feature = scsicmd[3];
2290 tf->nsect = scsicmd[4];
2291 tf->lbal = scsicmd[5];
2292 tf->lbam = scsicmd[6];
2293 tf->lbah = scsicmd[7];
2294 tf->device = scsicmd[8];
2295 tf->command = scsicmd[9];
2296 }
2297
2298 /*
2299 * Filter SET_FEATURES - XFER MODE command -- otherwise,
2300 * SET_FEATURES - XFER MODE must be preceded/succeeded
2301 * by an update to hardware-specific registers for each
2302 * controller (i.e. the reason for ->set_piomode(),
2303 * ->set_dmamode(), and ->post_set_mode() hooks).
2304 */
2305 if ((tf->command == ATA_CMD_SET_FEATURES)
2306 && (tf->feature == SETFEATURES_XFER))
2307 return 1;
2308
2309 /*
2310 * Set flags so that all registers will be written,
2311 * and pass on write indication (used for PIO/DMA
2312 * setup.)
2313 */
2314 tf->flags |= (ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE);
2315
Jeff Garzik0274aa22005-06-22 13:50:56 -04002316 if (cmd->sc_data_direction == DMA_TO_DEVICE)
Jeff Garzikb0955182005-05-12 15:45:22 -04002317 tf->flags |= ATA_TFLAG_WRITE;
2318
2319 /*
2320 * Set transfer length.
2321 *
2322 * TODO: find out if we need to do more here to
2323 * cover scatter/gather case.
2324 */
2325 qc->nsect = cmd->bufflen / ATA_SECT_SIZE;
2326
2327 return 0;
2328}
2329
Linus Torvalds1da177e2005-04-16 15:20:36 -07002330/**
2331 * ata_get_xlat_func - check if SCSI to ATA translation is possible
2332 * @dev: ATA device
2333 * @cmd: SCSI command opcode to consider
2334 *
2335 * Look up the SCSI command given, and determine whether the
2336 * SCSI command is to be translated or simulated.
2337 *
2338 * RETURNS:
2339 * Pointer to translation function if possible, %NULL if not.
2340 */
2341
2342static inline ata_xlat_func_t ata_get_xlat_func(struct ata_device *dev, u8 cmd)
2343{
2344 switch (cmd) {
2345 case READ_6:
2346 case READ_10:
2347 case READ_16:
2348
2349 case WRITE_6:
2350 case WRITE_10:
2351 case WRITE_16:
2352 return ata_scsi_rw_xlat;
2353
2354 case SYNCHRONIZE_CACHE:
2355 if (ata_try_flush_cache(dev))
2356 return ata_scsi_flush_xlat;
2357 break;
2358
2359 case VERIFY:
2360 case VERIFY_16:
2361 return ata_scsi_verify_xlat;
Jeff Garzikb0955182005-05-12 15:45:22 -04002362
2363 case ATA_12:
2364 case ATA_16:
2365 return ata_scsi_pass_thru;
Jeff Garzikda613962005-08-29 19:01:43 -04002366
Douglas Gilbert972dcaf2005-08-11 03:35:53 -04002367 case START_STOP:
2368 return ata_scsi_start_stop_xlat;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002369 }
2370
2371 return NULL;
2372}
2373
2374/**
2375 * ata_scsi_dump_cdb - dump SCSI command contents to dmesg
2376 * @ap: ATA port to which the command was being sent
2377 * @cmd: SCSI command to dump
2378 *
2379 * Prints the contents of a SCSI command via printk().
2380 */
2381
2382static inline void ata_scsi_dump_cdb(struct ata_port *ap,
2383 struct scsi_cmnd *cmd)
2384{
2385#ifdef ATA_DEBUG
2386 struct scsi_device *scsidev = cmd->device;
2387 u8 *scsicmd = cmd->cmnd;
2388
2389 DPRINTK("CDB (%u:%d,%d,%d) %02x %02x %02x %02x %02x %02x %02x %02x %02x\n",
2390 ap->id,
2391 scsidev->channel, scsidev->id, scsidev->lun,
2392 scsicmd[0], scsicmd[1], scsicmd[2], scsicmd[3],
2393 scsicmd[4], scsicmd[5], scsicmd[6], scsicmd[7],
2394 scsicmd[8]);
2395#endif
2396}
2397
2398/**
2399 * ata_scsi_queuecmd - Issue SCSI cdb to libata-managed device
2400 * @cmd: SCSI command to be sent
2401 * @done: Completion function, called when command is complete
2402 *
2403 * In some cases, this function translates SCSI commands into
2404 * ATA taskfiles, and queues the taskfiles to be sent to
2405 * hardware. In other cases, this function simulates a
2406 * SCSI device by evaluating and responding to certain
2407 * SCSI commands. This creates the overall effect of
2408 * ATA and ATAPI devices appearing as SCSI devices.
2409 *
2410 * LOCKING:
2411 * Releases scsi-layer-held lock, and obtains host_set lock.
2412 *
2413 * RETURNS:
2414 * Zero.
2415 */
2416
2417int ata_scsi_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *))
2418{
2419 struct ata_port *ap;
2420 struct ata_device *dev;
2421 struct scsi_device *scsidev = cmd->device;
Jeff Garzik005a5a02005-10-30 23:31:48 -05002422 struct Scsi_Host *shost = scsidev->host;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002423
Jeff Garzik005a5a02005-10-30 23:31:48 -05002424 ap = (struct ata_port *) &shost->hostdata[0];
2425
2426 spin_unlock(shost->host_lock);
2427 spin_lock(&ap->host_set->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002428
2429 ata_scsi_dump_cdb(ap, cmd);
2430
2431 dev = ata_scsi_find_dev(ap, scsidev);
2432 if (unlikely(!dev)) {
2433 cmd->result = (DID_BAD_TARGET << 16);
2434 done(cmd);
2435 goto out_unlock;
2436 }
2437
2438 if (dev->class == ATA_DEV_ATA) {
2439 ata_xlat_func_t xlat_func = ata_get_xlat_func(dev,
2440 cmd->cmnd[0]);
2441
2442 if (xlat_func)
2443 ata_scsi_translate(ap, dev, cmd, done, xlat_func);
2444 else
2445 ata_scsi_simulate(dev->id, cmd, done);
2446 } else
2447 ata_scsi_translate(ap, dev, cmd, done, atapi_xlat);
2448
2449out_unlock:
Jeff Garzik005a5a02005-10-30 23:31:48 -05002450 spin_unlock(&ap->host_set->lock);
2451 spin_lock(shost->host_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002452 return 0;
2453}
2454
2455/**
2456 * ata_scsi_simulate - simulate SCSI command on ATA device
2457 * @id: current IDENTIFY data for target device.
2458 * @cmd: SCSI command being sent to device.
2459 * @done: SCSI command completion function.
2460 *
2461 * Interprets and directly executes a select list of SCSI commands
2462 * that can be handled internally.
2463 *
2464 * LOCKING:
2465 * spin_lock_irqsave(host_set lock)
2466 */
2467
2468void ata_scsi_simulate(u16 *id,
2469 struct scsi_cmnd *cmd,
2470 void (*done)(struct scsi_cmnd *))
2471{
2472 struct ata_scsi_args args;
Jeff Garzik057ace52005-10-22 14:27:05 -04002473 const u8 *scsicmd = cmd->cmnd;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002474
2475 args.id = id;
2476 args.cmd = cmd;
2477 args.done = done;
2478
2479 switch(scsicmd[0]) {
2480 /* no-op's, complete with success */
2481 case SYNCHRONIZE_CACHE:
2482 case REZERO_UNIT:
2483 case SEEK_6:
2484 case SEEK_10:
2485 case TEST_UNIT_READY:
2486 case FORMAT_UNIT: /* FIXME: correct? */
2487 case SEND_DIAGNOSTIC: /* FIXME: correct? */
2488 ata_scsi_rbuf_fill(&args, ata_scsiop_noop);
2489 break;
2490
2491 case INQUIRY:
2492 if (scsicmd[1] & 2) /* is CmdDt set? */
Douglas Gilbertae006512005-10-09 09:09:35 -04002493 ata_scsi_invalid_field(cmd, done);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002494 else if ((scsicmd[1] & 1) == 0) /* is EVPD clear? */
2495 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_std);
2496 else if (scsicmd[2] == 0x00)
2497 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_00);
2498 else if (scsicmd[2] == 0x80)
2499 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_80);
2500 else if (scsicmd[2] == 0x83)
2501 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_83);
2502 else
Douglas Gilbertae006512005-10-09 09:09:35 -04002503 ata_scsi_invalid_field(cmd, done);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002504 break;
2505
2506 case MODE_SENSE:
2507 case MODE_SENSE_10:
2508 ata_scsi_rbuf_fill(&args, ata_scsiop_mode_sense);
2509 break;
2510
2511 case MODE_SELECT: /* unconditionally return */
2512 case MODE_SELECT_10: /* bad-field-in-cdb */
Douglas Gilbertae006512005-10-09 09:09:35 -04002513 ata_scsi_invalid_field(cmd, done);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002514 break;
2515
2516 case READ_CAPACITY:
2517 ata_scsi_rbuf_fill(&args, ata_scsiop_read_cap);
2518 break;
2519
2520 case SERVICE_ACTION_IN:
2521 if ((scsicmd[1] & 0x1f) == SAI_READ_CAPACITY_16)
2522 ata_scsi_rbuf_fill(&args, ata_scsiop_read_cap);
2523 else
Douglas Gilbertae006512005-10-09 09:09:35 -04002524 ata_scsi_invalid_field(cmd, done);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002525 break;
2526
2527 case REPORT_LUNS:
2528 ata_scsi_rbuf_fill(&args, ata_scsiop_report_luns);
2529 break;
2530
Jeff Garzikb0955182005-05-12 15:45:22 -04002531 /* mandatory commands we haven't implemented yet */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002532 case REQUEST_SENSE:
2533
2534 /* all other commands */
2535 default:
Douglas Gilbertae006512005-10-09 09:09:35 -04002536 ata_scsi_set_sense(cmd, ILLEGAL_REQUEST, 0x20, 0x0);
2537 /* "Invalid command operation code" */
2538 done(cmd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002539 break;
2540 }
2541}
2542
Jeff Garzik644dd0c2005-10-03 15:55:19 -04002543void ata_scsi_scan_host(struct ata_port *ap)
2544{
Jeff Garzik3f19ee82005-10-03 21:36:41 -04002545 struct ata_device *dev;
Jeff Garzik644dd0c2005-10-03 15:55:19 -04002546 unsigned int i;
2547
2548 if (ap->flags & ATA_FLAG_PORT_DISABLED)
2549 return;
2550
Jeff Garzik3f19ee82005-10-03 21:36:41 -04002551 for (i = 0; i < ATA_MAX_DEVICES; i++) {
2552 dev = &ap->device[i];
2553
2554 if (ata_dev_present(dev))
2555 scsi_scan_target(&ap->host->shost_gendev, 0, i, 0, 0);
2556 }
Jeff Garzik644dd0c2005-10-03 15:55:19 -04002557}
2558