blob: 1e3792f86fcf4359171d46b6ac326b099844e905 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
Jeff Garzikaf36d7f2005-08-28 20:18:39 -04002 * libata-scsi.c - helper library for ATA
3 *
4 * Maintained by: Jeff Garzik <jgarzik@pobox.com>
5 * Please ALWAYS copy linux-ide@vger.kernel.org
6 * on emails.
7 *
8 * Copyright 2003-2004 Red Hat, Inc. All rights reserved.
9 * Copyright 2003-2004 Jeff Garzik
10 *
11 *
12 * This program is free software; you can redistribute it and/or modify
13 * it under the terms of the GNU General Public License as published by
14 * the Free Software Foundation; either version 2, or (at your option)
15 * any later version.
16 *
17 * This program is distributed in the hope that it will be useful,
18 * but WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 * GNU General Public License for more details.
21 *
22 * You should have received a copy of the GNU General Public License
23 * along with this program; see the file COPYING. If not, write to
24 * the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
25 *
26 *
27 * libata documentation is available via 'make {ps|pdf}docs',
28 * as Documentation/DocBook/libata.*
29 *
30 * Hardware documentation available from
31 * - http://www.t10.org/
32 * - http://www.t13.org/
33 *
Linus Torvalds1da177e2005-04-16 15:20:36 -070034 */
35
36#include <linux/kernel.h>
37#include <linux/blkdev.h>
38#include <linux/spinlock.h>
39#include <scsi/scsi.h>
40#include "scsi.h"
41#include <scsi/scsi_host.h>
42#include <linux/libata.h>
Jeff Garzikb0955182005-05-12 15:45:22 -040043#include <linux/hdreg.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070044#include <asm/uaccess.h>
45
46#include "libata.h"
47
Jeff Garzikb0955182005-05-12 15:45:22 -040048#define SECTOR_SIZE 512
49
Jeff Garzik057ace52005-10-22 14:27:05 -040050typedef unsigned int (*ata_xlat_func_t)(struct ata_queued_cmd *qc, const u8 *scsicmd);
Linus Torvalds1da177e2005-04-16 15:20:36 -070051static struct ata_device *
Jeff Garzik057ace52005-10-22 14:27:05 -040052ata_scsi_find_dev(struct ata_port *ap, const struct scsi_device *scsidev);
Linus Torvalds1da177e2005-04-16 15:20:36 -070053
Douglas Gilbert00ac37f2005-10-28 15:58:28 -040054#define RW_RECOVERY_MPAGE 0x1
55#define RW_RECOVERY_MPAGE_LEN 12
56#define CACHE_MPAGE 0x8
57#define CACHE_MPAGE_LEN 20
58#define CONTROL_MPAGE 0xa
59#define CONTROL_MPAGE_LEN 12
60#define ALL_MPAGES 0x3f
61#define ALL_SUB_MPAGES 0xff
62
63
64static const u8 def_rw_recovery_mpage[] = {
65 RW_RECOVERY_MPAGE,
66 RW_RECOVERY_MPAGE_LEN - 2,
67 (1 << 7) | /* AWRE, sat-r06 say it shall be 0 */
68 (1 << 6), /* ARRE (auto read reallocation) */
69 0, /* read retry count */
70 0, 0, 0, 0,
71 0, /* write retry count */
72 0, 0, 0
73};
74
75static const u8 def_cache_mpage[CACHE_MPAGE_LEN] = {
76 CACHE_MPAGE,
77 CACHE_MPAGE_LEN - 2,
78 0, /* contains WCE, needs to be 0 for logic */
79 0, 0, 0, 0, 0, 0, 0, 0, 0,
80 0, /* contains DRA, needs to be 0 for logic */
81 0, 0, 0, 0, 0, 0, 0
82};
83
84static const u8 def_control_mpage[CONTROL_MPAGE_LEN] = {
85 CONTROL_MPAGE,
86 CONTROL_MPAGE_LEN - 2,
87 2, /* DSENSE=0, GLTSD=1 */
88 0, /* [QAM+QERR may be 1, see 05-359r1] */
89 0, 0, 0, 0, 0xff, 0xff,
90 0, 30 /* extended self test time, see 05-359r1 */
91};
92
Linus Torvalds1da177e2005-04-16 15:20:36 -070093
Douglas Gilbertae006512005-10-09 09:09:35 -040094static void ata_scsi_invalid_field(struct scsi_cmnd *cmd,
95 void (*done)(struct scsi_cmnd *))
96{
97 ata_scsi_set_sense(cmd, ILLEGAL_REQUEST, 0x24, 0x0);
98 /* "Invalid field in cbd" */
99 done(cmd);
100}
101
Linus Torvalds1da177e2005-04-16 15:20:36 -0700102/**
103 * ata_std_bios_param - generic bios head/sector/cylinder calculator used by sd.
104 * @sdev: SCSI device for which BIOS geometry is to be determined
105 * @bdev: block device associated with @sdev
106 * @capacity: capacity of SCSI device
107 * @geom: location to which geometry will be output
108 *
109 * Generic bios head/sector/cylinder calculator
110 * used by sd. Most BIOSes nowadays expect a XXX/255/16 (CHS)
111 * mapping. Some situations may arise where the disk is not
112 * bootable if this is not used.
113 *
114 * LOCKING:
115 * Defined by the SCSI layer. We don't really care.
116 *
117 * RETURNS:
118 * Zero.
119 */
120int ata_std_bios_param(struct scsi_device *sdev, struct block_device *bdev,
121 sector_t capacity, int geom[])
122{
123 geom[0] = 255;
124 geom[1] = 63;
125 sector_div(capacity, 255*63);
126 geom[2] = capacity;
127
128 return 0;
129}
130
Jeff Garzikb0955182005-05-12 15:45:22 -0400131/**
132 * ata_cmd_ioctl - Handler for HDIO_DRIVE_CMD ioctl
133 * @dev: Device to whom we are issuing command
134 * @arg: User provided data for issuing command
135 *
136 * LOCKING:
137 * Defined by the SCSI layer. We don't really care.
138 *
139 * RETURNS:
140 * Zero on success, negative errno on error.
141 */
142
143int ata_cmd_ioctl(struct scsi_device *scsidev, void __user *arg)
144{
145 int rc = 0;
146 u8 scsi_cmd[MAX_COMMAND_SIZE];
147 u8 args[4], *argbuf = NULL;
148 int argsize = 0;
149 struct scsi_request *sreq;
150
151 if (NULL == (void *)arg)
152 return -EINVAL;
153
154 if (copy_from_user(args, arg, sizeof(args)))
155 return -EFAULT;
156
157 sreq = scsi_allocate_request(scsidev, GFP_KERNEL);
158 if (!sreq)
159 return -EINTR;
160
161 memset(scsi_cmd, 0, sizeof(scsi_cmd));
162
163 if (args[3]) {
164 argsize = SECTOR_SIZE * args[3];
165 argbuf = kmalloc(argsize, GFP_KERNEL);
Jeff Raubitschek54dac832005-10-04 10:21:19 -0400166 if (argbuf == NULL) {
167 rc = -ENOMEM;
168 goto error;
169 }
Jeff Garzikb0955182005-05-12 15:45:22 -0400170
171 scsi_cmd[1] = (4 << 1); /* PIO Data-in */
172 scsi_cmd[2] = 0x0e; /* no off.line or cc, read from dev,
173 block count in sector count field */
174 sreq->sr_data_direction = DMA_FROM_DEVICE;
175 } else {
176 scsi_cmd[1] = (3 << 1); /* Non-data */
177 /* scsi_cmd[2] is already 0 -- no off.line, cc, or data xfer */
178 sreq->sr_data_direction = DMA_NONE;
179 }
180
181 scsi_cmd[0] = ATA_16;
182
183 scsi_cmd[4] = args[2];
184 if (args[0] == WIN_SMART) { /* hack -- ide driver does this too... */
185 scsi_cmd[6] = args[3];
186 scsi_cmd[8] = args[1];
187 scsi_cmd[10] = 0x4f;
188 scsi_cmd[12] = 0xc2;
189 } else {
190 scsi_cmd[6] = args[1];
191 }
192 scsi_cmd[14] = args[0];
193
194 /* Good values for timeout and retries? Values below
195 from scsi_ioctl_send_command() for default case... */
196 scsi_wait_req(sreq, scsi_cmd, argbuf, argsize, (10*HZ), 5);
197
198 if (sreq->sr_result) {
199 rc = -EIO;
200 goto error;
201 }
202
203 /* Need code to retrieve data from check condition? */
204
205 if ((argbuf)
206 && copy_to_user((void *)(arg + sizeof(args)), argbuf, argsize))
207 rc = -EFAULT;
208error:
209 scsi_release_request(sreq);
210
211 if (argbuf)
212 kfree(argbuf);
213
214 return rc;
215}
216
217/**
218 * ata_task_ioctl - Handler for HDIO_DRIVE_TASK ioctl
219 * @dev: Device to whom we are issuing command
220 * @arg: User provided data for issuing command
221 *
222 * LOCKING:
223 * Defined by the SCSI layer. We don't really care.
224 *
225 * RETURNS:
226 * Zero on success, negative errno on error.
227 */
228int ata_task_ioctl(struct scsi_device *scsidev, void __user *arg)
229{
230 int rc = 0;
231 u8 scsi_cmd[MAX_COMMAND_SIZE];
232 u8 args[7];
233 struct scsi_request *sreq;
234
235 if (NULL == (void *)arg)
236 return -EINVAL;
237
238 if (copy_from_user(args, arg, sizeof(args)))
239 return -EFAULT;
240
241 memset(scsi_cmd, 0, sizeof(scsi_cmd));
242 scsi_cmd[0] = ATA_16;
243 scsi_cmd[1] = (3 << 1); /* Non-data */
244 /* scsi_cmd[2] is already 0 -- no off.line, cc, or data xfer */
245 scsi_cmd[4] = args[1];
246 scsi_cmd[6] = args[2];
247 scsi_cmd[8] = args[3];
248 scsi_cmd[10] = args[4];
249 scsi_cmd[12] = args[5];
250 scsi_cmd[14] = args[0];
251
252 sreq = scsi_allocate_request(scsidev, GFP_KERNEL);
253 if (!sreq) {
254 rc = -EINTR;
255 goto error;
256 }
257
258 sreq->sr_data_direction = DMA_NONE;
259 /* Good values for timeout and retries? Values below
260 from scsi_ioctl_send_command() for default case... */
261 scsi_wait_req(sreq, scsi_cmd, NULL, 0, (10*HZ), 5);
262
263 if (sreq->sr_result) {
264 rc = -EIO;
265 goto error;
266 }
267
268 /* Need code to retrieve data from check condition? */
269
270error:
271 scsi_release_request(sreq);
272 return rc;
273}
274
Linus Torvalds1da177e2005-04-16 15:20:36 -0700275int ata_scsi_ioctl(struct scsi_device *scsidev, int cmd, void __user *arg)
276{
277 struct ata_port *ap;
278 struct ata_device *dev;
279 int val = -EINVAL, rc = -EINVAL;
280
281 ap = (struct ata_port *) &scsidev->host->hostdata[0];
282 if (!ap)
283 goto out;
284
285 dev = ata_scsi_find_dev(ap, scsidev);
286 if (!dev) {
287 rc = -ENODEV;
288 goto out;
289 }
290
291 switch (cmd) {
292 case ATA_IOC_GET_IO32:
293 val = 0;
294 if (copy_to_user(arg, &val, 1))
295 return -EFAULT;
296 return 0;
297
298 case ATA_IOC_SET_IO32:
299 val = (unsigned long) arg;
300 if (val != 0)
301 return -EINVAL;
302 return 0;
303
Jeff Garzikb0955182005-05-12 15:45:22 -0400304 case HDIO_DRIVE_CMD:
305 if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
306 return -EACCES;
307 return ata_cmd_ioctl(scsidev, arg);
308
309 case HDIO_DRIVE_TASK:
310 if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
311 return -EACCES;
312 return ata_task_ioctl(scsidev, arg);
313
Linus Torvalds1da177e2005-04-16 15:20:36 -0700314 default:
315 rc = -ENOTTY;
316 break;
317 }
318
319out:
320 return rc;
321}
322
323/**
324 * ata_scsi_qc_new - acquire new ata_queued_cmd reference
325 * @ap: ATA port to which the new command is attached
326 * @dev: ATA device to which the new command is attached
327 * @cmd: SCSI command that originated this ATA command
328 * @done: SCSI command completion function
329 *
330 * Obtain a reference to an unused ata_queued_cmd structure,
331 * which is the basic libata structure representing a single
332 * ATA command sent to the hardware.
333 *
334 * If a command was available, fill in the SCSI-specific
335 * portions of the structure with information on the
336 * current command.
337 *
338 * LOCKING:
339 * spin_lock_irqsave(host_set lock)
340 *
341 * RETURNS:
342 * Command allocated, or %NULL if none available.
343 */
344struct ata_queued_cmd *ata_scsi_qc_new(struct ata_port *ap,
345 struct ata_device *dev,
346 struct scsi_cmnd *cmd,
347 void (*done)(struct scsi_cmnd *))
348{
349 struct ata_queued_cmd *qc;
350
351 qc = ata_qc_new_init(ap, dev);
352 if (qc) {
353 qc->scsicmd = cmd;
354 qc->scsidone = done;
355
356 if (cmd->use_sg) {
357 qc->sg = (struct scatterlist *) cmd->request_buffer;
358 qc->n_elem = cmd->use_sg;
359 } else {
360 qc->sg = &qc->sgent;
361 qc->n_elem = 1;
362 }
363 } else {
364 cmd->result = (DID_OK << 16) | (QUEUE_FULL << 1);
365 done(cmd);
366 }
367
368 return qc;
369}
370
371/**
Jeff Garzikb0955182005-05-12 15:45:22 -0400372 * ata_dump_status - user friendly display of error info
373 * @id: id of the port in question
374 * @tf: ptr to filled out taskfile
Linus Torvalds1da177e2005-04-16 15:20:36 -0700375 *
Jeff Garzikb0955182005-05-12 15:45:22 -0400376 * Decode and dump the ATA error/status registers for the user so
377 * that they have some idea what really happened at the non
378 * make-believe layer.
379 *
380 * LOCKING:
381 * inherited from caller
382 */
383void ata_dump_status(unsigned id, struct ata_taskfile *tf)
384{
385 u8 stat = tf->command, err = tf->feature;
386
387 printk(KERN_WARNING "ata%u: status=0x%02x { ", id, stat);
388 if (stat & ATA_BUSY) {
389 printk("Busy }\n"); /* Data is not valid in this case */
390 } else {
391 if (stat & 0x40) printk("DriveReady ");
392 if (stat & 0x20) printk("DeviceFault ");
393 if (stat & 0x10) printk("SeekComplete ");
394 if (stat & 0x08) printk("DataRequest ");
395 if (stat & 0x04) printk("CorrectedError ");
396 if (stat & 0x02) printk("Index ");
397 if (stat & 0x01) printk("Error ");
398 printk("}\n");
399
400 if (err) {
401 printk(KERN_WARNING "ata%u: error=0x%02x { ", id, err);
402 if (err & 0x04) printk("DriveStatusError ");
403 if (err & 0x80) {
404 if (err & 0x04) printk("BadCRC ");
405 else printk("Sector ");
406 }
407 if (err & 0x40) printk("UncorrectableError ");
408 if (err & 0x10) printk("SectorIdNotFound ");
409 if (err & 0x02) printk("TrackZeroNotFound ");
410 if (err & 0x01) printk("AddrMarkNotFound ");
411 printk("}\n");
412 }
413 }
414}
415
416/**
417 * ata_to_sense_error - convert ATA error to SCSI error
418 * @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 */
437 static unsigned char sense_table[][4] = {
438 /* 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 };
468 static unsigned char stat_table[][4] = {
469 /* 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
477 /*
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);
513
514 /* For our last chance pick, use medium read error because
515 * it's much more common than an ATA drive telling you a write
516 * has failed.
517 */
518 *sk = MEDIUM_ERROR;
519 *asc = 0x11; /* "unrecovered read error" */
520 *ascq = 0x04; /* "auto-reallocation failed" */
521
522 translate_done:
523 printk(KERN_ERR "ata%u: translated ATA stat/err 0x%02x/%02x to "
524 "SCSI SK/ASC/ASCQ 0x%x/%02x/%02x\n", id, drv_stat, drv_err,
525 *sk, *asc, *ascq);
526 return;
527}
528
529/*
530 * ata_gen_ata_desc_sense - Generate check condition sense block.
531 * @qc: Command that completed.
532 *
533 * This function is specific to the ATA descriptor format sense
534 * block specified for the ATA pass through commands. Regardless
535 * of whether the command errored or not, return a sense
536 * block. Copy all controller registers into the sense
537 * block. Clear sense key, ASC & ASCQ if there is no error.
538 *
539 * LOCKING:
540 * spin_lock_irqsave(host_set lock)
541 */
542void ata_gen_ata_desc_sense(struct ata_queued_cmd *qc)
543{
544 struct scsi_cmnd *cmd = qc->scsicmd;
545 struct ata_taskfile *tf = &qc->tf;
546 unsigned char *sb = cmd->sense_buffer;
547 unsigned char *desc = sb + 8;
548
549 memset(sb, 0, SCSI_SENSE_BUFFERSIZE);
550
Jeff Garzik0e5dec42005-10-06 09:40:20 -0400551 cmd->result = (DRIVER_SENSE << 24) | SAM_STAT_CHECK_CONDITION;
Jeff Garzikb0955182005-05-12 15:45:22 -0400552
553 /*
554 * Read the controller registers.
555 */
556 assert(NULL != qc->ap->ops->tf_read);
557 qc->ap->ops->tf_read(qc->ap, tf);
558
559 /*
560 * Use ata_to_sense_error() to map status register bits
561 * onto sense key, asc & ascq.
562 */
Jeff Garzika7dac442005-10-30 04:44:42 -0500563 if (tf->command & (ATA_BUSY | ATA_DF | ATA_ERR | ATA_DRQ)) {
Jeff Garzikb0955182005-05-12 15:45:22 -0400564 ata_to_sense_error(qc->ap->id, tf->command, tf->feature,
565 &sb[1], &sb[2], &sb[3]);
566 sb[1] &= 0x0f;
567 }
568
569 /*
570 * Sense data is current and format is descriptor.
571 */
572 sb[0] = 0x72;
573
574 desc[0] = 0x09;
575
576 /*
577 * Set length of additional sense data.
578 * Since we only populate descriptor 0, the total
579 * length is the same (fixed) length as descriptor 0.
580 */
581 desc[1] = sb[7] = 14;
582
583 /*
584 * Copy registers into sense buffer.
585 */
586 desc[2] = 0x00;
587 desc[3] = tf->feature; /* == error reg */
588 desc[5] = tf->nsect;
589 desc[7] = tf->lbal;
590 desc[9] = tf->lbam;
591 desc[11] = tf->lbah;
592 desc[12] = tf->device;
593 desc[13] = tf->command; /* == status reg */
594
595 /*
596 * Fill in Extend bit, and the high order bytes
597 * if applicable.
598 */
599 if (tf->flags & ATA_TFLAG_LBA48) {
600 desc[2] |= 0x01;
601 desc[4] = tf->hob_nsect;
602 desc[6] = tf->hob_lbal;
603 desc[8] = tf->hob_lbam;
604 desc[10] = tf->hob_lbah;
605 }
606}
607
608/**
609 * ata_gen_fixed_sense - generate a SCSI fixed sense block
610 * @qc: Command that we are erroring out
611 *
612 * Leverage ata_to_sense_error() to give us the codes. Fit our
613 * LBA in here if there's room.
614 *
615 * LOCKING:
616 * inherited from caller
617 */
618void ata_gen_fixed_sense(struct ata_queued_cmd *qc)
619{
620 struct scsi_cmnd *cmd = qc->scsicmd;
621 struct ata_taskfile *tf = &qc->tf;
622 unsigned char *sb = cmd->sense_buffer;
623
624 memset(sb, 0, SCSI_SENSE_BUFFERSIZE);
625
Jeff Garzik0e5dec42005-10-06 09:40:20 -0400626 cmd->result = (DRIVER_SENSE << 24) | SAM_STAT_CHECK_CONDITION;
Jeff Garzikb0955182005-05-12 15:45:22 -0400627
628 /*
629 * Read the controller registers.
630 */
631 assert(NULL != qc->ap->ops->tf_read);
632 qc->ap->ops->tf_read(qc->ap, tf);
633
634 /*
635 * Use ata_to_sense_error() to map status register bits
636 * onto sense key, asc & ascq.
637 */
Jeff Garzika7dac442005-10-30 04:44:42 -0500638 if (tf->command & (ATA_BUSY | ATA_DF | ATA_ERR | ATA_DRQ)) {
Jeff Garzikb0955182005-05-12 15:45:22 -0400639 ata_to_sense_error(qc->ap->id, tf->command, tf->feature,
640 &sb[2], &sb[12], &sb[13]);
641 sb[2] &= 0x0f;
642 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700643
644 sb[0] = 0x70;
Jeff Garzikb0955182005-05-12 15:45:22 -0400645 sb[7] = 0x0a;
Jeff Garzik0274aa22005-06-22 13:50:56 -0400646
Jeff Garzika7dac442005-10-30 04:44:42 -0500647 if (tf->flags & ATA_TFLAG_LBA48) {
648 /* TODO: find solution for LBA48 descriptors */
649 }
650
651 else if (tf->flags & ATA_TFLAG_LBA) {
Jeff Garzikb0955182005-05-12 15:45:22 -0400652 /* A small (28b) LBA will fit in the 32b info field */
653 sb[0] |= 0x80; /* set valid bit */
654 sb[3] = tf->device & 0x0f;
655 sb[4] = tf->lbah;
656 sb[5] = tf->lbam;
657 sb[6] = tf->lbal;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700658 }
Jeff Garzika7dac442005-10-30 04:44:42 -0500659
660 else {
661 /* TODO: C/H/S */
662 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700663}
664
665/**
666 * ata_scsi_slave_config - Set SCSI device attributes
667 * @sdev: SCSI device to examine
668 *
669 * This is called before we actually start reading
670 * and writing to the device, to configure certain
671 * SCSI mid-layer behaviors.
672 *
673 * LOCKING:
674 * Defined by SCSI layer. We don't really care.
675 */
676
677int ata_scsi_slave_config(struct scsi_device *sdev)
678{
679 sdev->use_10_for_rw = 1;
680 sdev->use_10_for_ms = 1;
681
682 blk_queue_max_phys_segments(sdev->request_queue, LIBATA_MAX_PRD);
683
684 if (sdev->id < ATA_MAX_DEVICES) {
685 struct ata_port *ap;
686 struct ata_device *dev;
687
688 ap = (struct ata_port *) &sdev->host->hostdata[0];
689 dev = &ap->device[sdev->id];
690
691 /* TODO: 1024 is an arbitrary number, not the
692 * hardware maximum. This should be increased to
693 * 65534 when Jens Axboe's patch for dynamically
694 * determining max_sectors is merged.
695 */
696 if ((dev->flags & ATA_DFLAG_LBA48) &&
697 ((dev->flags & ATA_DFLAG_LOCK_SECTORS) == 0)) {
John W. Linvillef85bdb92005-05-12 15:49:54 -0400698 /*
699 * do not overwrite sdev->host->max_sectors, since
700 * other drives on this host may not support LBA48
701 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700702 blk_queue_max_sectors(sdev->request_queue, 2048);
703 }
704 }
705
706 return 0; /* scsi layer doesn't check return value, sigh */
707}
708
709/**
710 * ata_scsi_error - SCSI layer error handler callback
711 * @host: SCSI host on which error occurred
712 *
713 * Handles SCSI-layer-thrown error events.
714 *
715 * LOCKING:
716 * Inherited from SCSI layer (none, can sleep)
717 *
718 * RETURNS:
719 * Zero.
720 */
721
722int ata_scsi_error(struct Scsi_Host *host)
723{
724 struct ata_port *ap;
725
726 DPRINTK("ENTER\n");
727
728 ap = (struct ata_port *) &host->hostdata[0];
729 ap->ops->eng_timeout(ap);
730
731 /* TODO: this is per-command; when queueing is supported
732 * this code will either change or move to a more
733 * appropriate place
734 */
735 host->host_failed--;
Tejun Heo425174382005-08-10 13:38:27 -0400736 INIT_LIST_HEAD(&host->eh_cmd_q);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700737
738 DPRINTK("EXIT\n");
739 return 0;
740}
741
742/**
Douglas Gilbert972dcaf2005-08-11 03:35:53 -0400743 * ata_scsi_start_stop_xlat - Translate SCSI START STOP UNIT command
744 * @qc: Storage for translated ATA taskfile
745 * @scsicmd: SCSI command to translate
746 *
747 * Sets up an ATA taskfile to issue STANDBY (to stop) or READ VERIFY
748 * (to start). Perhaps these commands should be preceded by
749 * CHECK POWER MODE to see what power mode the device is already in.
750 * [See SAT revision 5 at www.t10.org]
751 *
752 * LOCKING:
753 * spin_lock_irqsave(host_set lock)
754 *
755 * RETURNS:
756 * Zero on success, non-zero on error.
757 */
758
759static unsigned int ata_scsi_start_stop_xlat(struct ata_queued_cmd *qc,
Jeff Garzik057ace52005-10-22 14:27:05 -0400760 const u8 *scsicmd)
Douglas Gilbert972dcaf2005-08-11 03:35:53 -0400761{
762 struct ata_taskfile *tf = &qc->tf;
763
764 tf->flags |= ATA_TFLAG_DEVICE | ATA_TFLAG_ISADDR;
765 tf->protocol = ATA_PROT_NODATA;
766 if (scsicmd[1] & 0x1) {
767 ; /* ignore IMMED bit, violates sat-r05 */
768 }
769 if (scsicmd[4] & 0x2)
Douglas Gilbertae006512005-10-09 09:09:35 -0400770 goto invalid_fld; /* LOEJ bit set not supported */
Douglas Gilbert972dcaf2005-08-11 03:35:53 -0400771 if (((scsicmd[4] >> 4) & 0xf) != 0)
Douglas Gilbertae006512005-10-09 09:09:35 -0400772 goto invalid_fld; /* power conditions not supported */
Douglas Gilbert972dcaf2005-08-11 03:35:53 -0400773 if (scsicmd[4] & 0x1) {
774 tf->nsect = 1; /* 1 sector, lba=0 */
Albert Lee9d5b1302005-10-04 08:48:17 -0400775
776 if (qc->dev->flags & ATA_DFLAG_LBA) {
777 qc->tf.flags |= ATA_TFLAG_LBA;
778
779 tf->lbah = 0x0;
780 tf->lbam = 0x0;
781 tf->lbal = 0x0;
782 tf->device |= ATA_LBA;
783 } else {
784 /* CHS */
785 tf->lbal = 0x1; /* sect */
786 tf->lbam = 0x0; /* cyl low */
787 tf->lbah = 0x0; /* cyl high */
788 }
789
Douglas Gilbert972dcaf2005-08-11 03:35:53 -0400790 tf->command = ATA_CMD_VERIFY; /* READ VERIFY */
791 } else {
792 tf->nsect = 0; /* time period value (0 implies now) */
793 tf->command = ATA_CMD_STANDBY;
794 /* Consider: ATA STANDBY IMMEDIATE command */
795 }
796 /*
797 * Standby and Idle condition timers could be implemented but that
798 * would require libata to implement the Power condition mode page
799 * and allow the user to change it. Changing mode pages requires
800 * MODE SELECT to be implemented.
801 */
802
803 return 0;
Douglas Gilbertae006512005-10-09 09:09:35 -0400804
805invalid_fld:
806 ata_scsi_set_sense(qc->scsicmd, ILLEGAL_REQUEST, 0x24, 0x0);
807 /* "Invalid field in cbd" */
808 return 1;
Douglas Gilbert972dcaf2005-08-11 03:35:53 -0400809}
810
811
812/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700813 * ata_scsi_flush_xlat - Translate SCSI SYNCHRONIZE CACHE command
814 * @qc: Storage for translated ATA taskfile
815 * @scsicmd: SCSI command to translate (ignored)
816 *
817 * Sets up an ATA taskfile to issue FLUSH CACHE or
818 * FLUSH CACHE EXT.
819 *
820 * LOCKING:
821 * spin_lock_irqsave(host_set lock)
822 *
823 * RETURNS:
824 * Zero on success, non-zero on error.
825 */
826
Jeff Garzik057ace52005-10-22 14:27:05 -0400827static unsigned int ata_scsi_flush_xlat(struct ata_queued_cmd *qc, const u8 *scsicmd)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700828{
829 struct ata_taskfile *tf = &qc->tf;
830
831 tf->flags |= ATA_TFLAG_DEVICE;
832 tf->protocol = ATA_PROT_NODATA;
833
Albert Lee07506692005-10-12 15:04:18 +0800834 if ((qc->dev->flags & ATA_DFLAG_LBA48) &&
Linus Torvalds1da177e2005-04-16 15:20:36 -0700835 (ata_id_has_flush_ext(qc->dev->id)))
836 tf->command = ATA_CMD_FLUSH_EXT;
837 else
838 tf->command = ATA_CMD_FLUSH;
839
840 return 0;
841}
842
843/**
Albert Lee3aef5232005-10-04 08:47:43 -0400844 * scsi_6_lba_len - Get LBA and transfer length
845 * @scsicmd: SCSI command to translate
846 *
847 * Calculate LBA and transfer length for 6-byte commands.
848 *
849 * RETURNS:
850 * @plba: the LBA
851 * @plen: the transfer length
852 */
853
Jeff Garzik057ace52005-10-22 14:27:05 -0400854static void scsi_6_lba_len(const u8 *scsicmd, u64 *plba, u32 *plen)
Albert Lee3aef5232005-10-04 08:47:43 -0400855{
856 u64 lba = 0;
857 u32 len = 0;
858
859 VPRINTK("six-byte command\n");
860
861 lba |= ((u64)scsicmd[2]) << 8;
862 lba |= ((u64)scsicmd[3]);
863
864 len |= ((u32)scsicmd[4]);
865
866 *plba = lba;
867 *plen = len;
868}
869
870/**
871 * scsi_10_lba_len - Get LBA and transfer length
872 * @scsicmd: SCSI command to translate
873 *
874 * Calculate LBA and transfer length for 10-byte commands.
875 *
876 * RETURNS:
877 * @plba: the LBA
878 * @plen: the transfer length
879 */
880
Jeff Garzik057ace52005-10-22 14:27:05 -0400881static void scsi_10_lba_len(const u8 *scsicmd, u64 *plba, u32 *plen)
Albert Lee3aef5232005-10-04 08:47:43 -0400882{
883 u64 lba = 0;
884 u32 len = 0;
885
886 VPRINTK("ten-byte command\n");
887
888 lba |= ((u64)scsicmd[2]) << 24;
889 lba |= ((u64)scsicmd[3]) << 16;
890 lba |= ((u64)scsicmd[4]) << 8;
891 lba |= ((u64)scsicmd[5]);
892
893 len |= ((u32)scsicmd[7]) << 8;
894 len |= ((u32)scsicmd[8]);
895
896 *plba = lba;
897 *plen = len;
898}
899
900/**
901 * scsi_16_lba_len - Get LBA and transfer length
902 * @scsicmd: SCSI command to translate
903 *
904 * Calculate LBA and transfer length for 16-byte commands.
905 *
906 * RETURNS:
907 * @plba: the LBA
908 * @plen: the transfer length
909 */
910
Jeff Garzik057ace52005-10-22 14:27:05 -0400911static void scsi_16_lba_len(const u8 *scsicmd, u64 *plba, u32 *plen)
Albert Lee3aef5232005-10-04 08:47:43 -0400912{
913 u64 lba = 0;
914 u32 len = 0;
915
916 VPRINTK("sixteen-byte command\n");
917
918 lba |= ((u64)scsicmd[2]) << 56;
919 lba |= ((u64)scsicmd[3]) << 48;
920 lba |= ((u64)scsicmd[4]) << 40;
921 lba |= ((u64)scsicmd[5]) << 32;
922 lba |= ((u64)scsicmd[6]) << 24;
923 lba |= ((u64)scsicmd[7]) << 16;
924 lba |= ((u64)scsicmd[8]) << 8;
925 lba |= ((u64)scsicmd[9]);
926
927 len |= ((u32)scsicmd[10]) << 24;
928 len |= ((u32)scsicmd[11]) << 16;
929 len |= ((u32)scsicmd[12]) << 8;
930 len |= ((u32)scsicmd[13]);
931
932 *plba = lba;
933 *plen = len;
934}
935
936/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700937 * ata_scsi_verify_xlat - Translate SCSI VERIFY command into an ATA one
938 * @qc: Storage for translated ATA taskfile
939 * @scsicmd: SCSI command to translate
940 *
941 * Converts SCSI VERIFY command to an ATA READ VERIFY command.
942 *
943 * LOCKING:
944 * spin_lock_irqsave(host_set lock)
945 *
946 * RETURNS:
947 * Zero on success, non-zero on error.
948 */
949
Jeff Garzik057ace52005-10-22 14:27:05 -0400950static unsigned int ata_scsi_verify_xlat(struct ata_queued_cmd *qc, const u8 *scsicmd)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700951{
952 struct ata_taskfile *tf = &qc->tf;
Albert Lee8bf62ec2005-05-12 15:29:42 -0400953 struct ata_device *dev = qc->dev;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700954 u64 dev_sectors = qc->dev->n_sectors;
Albert Lee3aef5232005-10-04 08:47:43 -0400955 u64 block;
956 u32 n_block;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700957
958 tf->flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
959 tf->protocol = ATA_PROT_NODATA;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700960
Albert Lee3aef5232005-10-04 08:47:43 -0400961 if (scsicmd[0] == VERIFY)
962 scsi_10_lba_len(scsicmd, &block, &n_block);
963 else if (scsicmd[0] == VERIFY_16)
964 scsi_16_lba_len(scsicmd, &block, &n_block);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700965 else
Douglas Gilbertae006512005-10-09 09:09:35 -0400966 goto invalid_fld;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700967
Albert Lee8bf62ec2005-05-12 15:29:42 -0400968 if (!n_block)
Douglas Gilbertae006512005-10-09 09:09:35 -0400969 goto nothing_to_do;
Albert Lee8bf62ec2005-05-12 15:29:42 -0400970 if (block >= dev_sectors)
Douglas Gilbertae006512005-10-09 09:09:35 -0400971 goto out_of_range;
Albert Lee8bf62ec2005-05-12 15:29:42 -0400972 if ((block + n_block) > dev_sectors)
Douglas Gilbertae006512005-10-09 09:09:35 -0400973 goto out_of_range;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700974
Albert Lee07506692005-10-12 15:04:18 +0800975 if (dev->flags & ATA_DFLAG_LBA) {
976 tf->flags |= ATA_TFLAG_LBA;
977
978 if (dev->flags & ATA_DFLAG_LBA48) {
979 if (n_block > (64 * 1024))
980 goto invalid_fld;
981
982 /* use LBA48 */
983 tf->flags |= ATA_TFLAG_LBA48;
Albert Lee8bf62ec2005-05-12 15:29:42 -0400984 tf->command = ATA_CMD_VERIFY_EXT;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700985
Albert Lee8bf62ec2005-05-12 15:29:42 -0400986 tf->hob_nsect = (n_block >> 8) & 0xff;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700987
Albert Lee8bf62ec2005-05-12 15:29:42 -0400988 tf->hob_lbah = (block >> 40) & 0xff;
989 tf->hob_lbam = (block >> 32) & 0xff;
990 tf->hob_lbal = (block >> 24) & 0xff;
991 } else {
Albert Lee07506692005-10-12 15:04:18 +0800992 if (n_block > 256)
993 goto invalid_fld;
994
995 /* use LBA28 */
Albert Lee8bf62ec2005-05-12 15:29:42 -0400996 tf->command = ATA_CMD_VERIFY;
997
998 tf->device |= (block >> 24) & 0xf;
999 }
1000
1001 tf->nsect = n_block & 0xff;
1002
1003 tf->lbah = (block >> 16) & 0xff;
1004 tf->lbam = (block >> 8) & 0xff;
1005 tf->lbal = block & 0xff;
1006
1007 tf->device |= ATA_LBA;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001008 } else {
Albert Lee8bf62ec2005-05-12 15:29:42 -04001009 /* CHS */
1010 u32 sect, head, cyl, track;
1011
Albert Lee07506692005-10-12 15:04:18 +08001012 if (n_block > 256)
1013 goto invalid_fld;
1014
Albert Lee8bf62ec2005-05-12 15:29:42 -04001015 /* Convert LBA to CHS */
1016 track = (u32)block / dev->sectors;
1017 cyl = track / dev->heads;
1018 head = track % dev->heads;
1019 sect = (u32)block % dev->sectors + 1;
1020
Albert Leec187c4b2005-10-04 08:46:51 -04001021 DPRINTK("block %u track %u cyl %u head %u sect %u\n",
1022 (u32)block, track, cyl, head, sect);
Albert Lee8bf62ec2005-05-12 15:29:42 -04001023
1024 /* Check whether the converted CHS can fit.
1025 Cylinder: 0-65535
1026 Head: 0-15
1027 Sector: 1-255*/
1028 if ((cyl >> 16) || (head >> 4) || (sect >> 8) || (!sect))
Douglas Gilbertae006512005-10-09 09:09:35 -04001029 goto out_of_range;
Albert Lee8bf62ec2005-05-12 15:29:42 -04001030
Linus Torvalds1da177e2005-04-16 15:20:36 -07001031 tf->command = ATA_CMD_VERIFY;
Albert Lee8bf62ec2005-05-12 15:29:42 -04001032 tf->nsect = n_block & 0xff; /* Sector count 0 means 256 sectors */
1033 tf->lbal = sect;
1034 tf->lbam = cyl;
1035 tf->lbah = cyl >> 8;
1036 tf->device |= head;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001037 }
1038
Linus Torvalds1da177e2005-04-16 15:20:36 -07001039 return 0;
Douglas Gilbertae006512005-10-09 09:09:35 -04001040
1041invalid_fld:
1042 ata_scsi_set_sense(qc->scsicmd, ILLEGAL_REQUEST, 0x24, 0x0);
1043 /* "Invalid field in cbd" */
1044 return 1;
1045
1046out_of_range:
1047 ata_scsi_set_sense(qc->scsicmd, ILLEGAL_REQUEST, 0x21, 0x0);
1048 /* "Logical Block Address out of range" */
1049 return 1;
1050
1051nothing_to_do:
1052 qc->scsicmd->result = SAM_STAT_GOOD;
1053 return 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001054}
1055
1056/**
1057 * ata_scsi_rw_xlat - Translate SCSI r/w command into an ATA one
1058 * @qc: Storage for translated ATA taskfile
1059 * @scsicmd: SCSI command to translate
1060 *
1061 * Converts any of six SCSI read/write commands into the
1062 * ATA counterpart, including starting sector (LBA),
1063 * sector count, and taking into account the device's LBA48
1064 * support.
1065 *
1066 * Commands %READ_6, %READ_10, %READ_16, %WRITE_6, %WRITE_10, and
1067 * %WRITE_16 are currently supported.
1068 *
1069 * LOCKING:
1070 * spin_lock_irqsave(host_set lock)
1071 *
1072 * RETURNS:
1073 * Zero on success, non-zero on error.
1074 */
1075
Jeff Garzik057ace52005-10-22 14:27:05 -04001076static unsigned int ata_scsi_rw_xlat(struct ata_queued_cmd *qc, const u8 *scsicmd)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001077{
1078 struct ata_taskfile *tf = &qc->tf;
Albert Lee8bf62ec2005-05-12 15:29:42 -04001079 struct ata_device *dev = qc->dev;
Albert Lee3aef5232005-10-04 08:47:43 -04001080 u64 block;
1081 u32 n_block;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001082
1083 tf->flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001084
Albert Lee8cbd6df2005-10-12 15:06:27 +08001085 if (scsicmd[0] == WRITE_10 || scsicmd[0] == WRITE_6 ||
1086 scsicmd[0] == WRITE_16)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001087 tf->flags |= ATA_TFLAG_WRITE;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001088
Albert Lee8bf62ec2005-05-12 15:29:42 -04001089 /* Calculate the SCSI LBA and transfer length. */
Albert Lee3aef5232005-10-04 08:47:43 -04001090 switch (scsicmd[0]) {
1091 case READ_10:
1092 case WRITE_10:
1093 scsi_10_lba_len(scsicmd, &block, &n_block);
1094 break;
1095 case READ_6:
1096 case WRITE_6:
1097 scsi_6_lba_len(scsicmd, &block, &n_block);
Albert Leec187c4b2005-10-04 08:46:51 -04001098
1099 /* for 6-byte r/w commands, transfer length 0
1100 * means 256 blocks of data, not 0 block.
1101 */
Jeff Garzik76b2bf92005-08-29 19:24:43 -04001102 if (!n_block)
1103 n_block = 256;
Albert Lee3aef5232005-10-04 08:47:43 -04001104 break;
1105 case READ_16:
1106 case WRITE_16:
1107 scsi_16_lba_len(scsicmd, &block, &n_block);
1108 break;
1109 default:
Albert Lee8bf62ec2005-05-12 15:29:42 -04001110 DPRINTK("no-byte command\n");
Douglas Gilbertae006512005-10-09 09:09:35 -04001111 goto invalid_fld;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001112 }
1113
Albert Lee8bf62ec2005-05-12 15:29:42 -04001114 /* Check and compose ATA command */
1115 if (!n_block)
Albert Leec187c4b2005-10-04 08:46:51 -04001116 /* For 10-byte and 16-byte SCSI R/W commands, transfer
1117 * length 0 means transfer 0 block of data.
1118 * However, for ATA R/W commands, sector count 0 means
1119 * 256 or 65536 sectors, not 0 sectors as in SCSI.
1120 */
Douglas Gilbertae006512005-10-09 09:09:35 -04001121 goto nothing_to_do;
Albert Lee8bf62ec2005-05-12 15:29:42 -04001122
Albert Lee07506692005-10-12 15:04:18 +08001123 if (dev->flags & ATA_DFLAG_LBA) {
1124 tf->flags |= ATA_TFLAG_LBA;
1125
1126 if (dev->flags & ATA_DFLAG_LBA48) {
Albert Lee8bf62ec2005-05-12 15:29:42 -04001127 /* The request -may- be too large for LBA48. */
1128 if ((block >> 48) || (n_block > 65536))
Douglas Gilbertae006512005-10-09 09:09:35 -04001129 goto out_of_range;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001130
Albert Lee07506692005-10-12 15:04:18 +08001131 /* use LBA48 */
1132 tf->flags |= ATA_TFLAG_LBA48;
1133
Albert Lee8bf62ec2005-05-12 15:29:42 -04001134 tf->hob_nsect = (n_block >> 8) & 0xff;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001135
Albert Lee8bf62ec2005-05-12 15:29:42 -04001136 tf->hob_lbah = (block >> 40) & 0xff;
1137 tf->hob_lbam = (block >> 32) & 0xff;
1138 tf->hob_lbal = (block >> 24) & 0xff;
1139 } else {
Albert Lee07506692005-10-12 15:04:18 +08001140 /* use LBA28 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001141
Albert Lee8bf62ec2005-05-12 15:29:42 -04001142 /* The request -may- be too large for LBA28. */
1143 if ((block >> 28) || (n_block > 256))
Douglas Gilbertae006512005-10-09 09:09:35 -04001144 goto out_of_range;
Albert Lee8bf62ec2005-05-12 15:29:42 -04001145
1146 tf->device |= (block >> 24) & 0xf;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001147 }
1148
Albert Lee8cbd6df2005-10-12 15:06:27 +08001149 ata_rwcmd_protocol(qc);
1150
Albert Lee8bf62ec2005-05-12 15:29:42 -04001151 qc->nsect = n_block;
1152 tf->nsect = n_block & 0xff;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001153
Albert Lee8bf62ec2005-05-12 15:29:42 -04001154 tf->lbah = (block >> 16) & 0xff;
1155 tf->lbam = (block >> 8) & 0xff;
1156 tf->lbal = block & 0xff;
1157
1158 tf->device |= ATA_LBA;
1159 } else {
1160 /* CHS */
1161 u32 sect, head, cyl, track;
1162
1163 /* The request -may- be too large for CHS addressing. */
1164 if ((block >> 28) || (n_block > 256))
Douglas Gilbertae006512005-10-09 09:09:35 -04001165 goto out_of_range;
Albert Leec187c4b2005-10-04 08:46:51 -04001166
Albert Lee8cbd6df2005-10-12 15:06:27 +08001167 ata_rwcmd_protocol(qc);
1168
Albert Lee8bf62ec2005-05-12 15:29:42 -04001169 /* Convert LBA to CHS */
1170 track = (u32)block / dev->sectors;
1171 cyl = track / dev->heads;
1172 head = track % dev->heads;
1173 sect = (u32)block % dev->sectors + 1;
1174
Albert Leec187c4b2005-10-04 08:46:51 -04001175 DPRINTK("block %u track %u cyl %u head %u sect %u\n",
Albert Lee8bf62ec2005-05-12 15:29:42 -04001176 (u32)block, track, cyl, head, sect);
Albert Leec187c4b2005-10-04 08:46:51 -04001177
Albert Lee8bf62ec2005-05-12 15:29:42 -04001178 /* Check whether the converted CHS can fit.
1179 Cylinder: 0-65535
1180 Head: 0-15
1181 Sector: 1-255*/
Albert Leec187c4b2005-10-04 08:46:51 -04001182 if ((cyl >> 16) || (head >> 4) || (sect >> 8) || (!sect))
Douglas Gilbertae006512005-10-09 09:09:35 -04001183 goto out_of_range;
Albert Leec187c4b2005-10-04 08:46:51 -04001184
Albert Lee8bf62ec2005-05-12 15:29:42 -04001185 qc->nsect = n_block;
1186 tf->nsect = n_block & 0xff; /* Sector count 0 means 256 sectors */
1187 tf->lbal = sect;
1188 tf->lbam = cyl;
1189 tf->lbah = cyl >> 8;
1190 tf->device |= head;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001191 }
1192
Albert Lee8bf62ec2005-05-12 15:29:42 -04001193 return 0;
Jeff Garzik13593262005-08-27 04:20:12 -04001194
Douglas Gilbertae006512005-10-09 09:09:35 -04001195invalid_fld:
1196 ata_scsi_set_sense(qc->scsicmd, ILLEGAL_REQUEST, 0x24, 0x0);
1197 /* "Invalid field in cbd" */
1198 return 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001199
Douglas Gilbertae006512005-10-09 09:09:35 -04001200out_of_range:
1201 ata_scsi_set_sense(qc->scsicmd, ILLEGAL_REQUEST, 0x21, 0x0);
1202 /* "Logical Block Address out of range" */
1203 return 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001204
Douglas Gilbertae006512005-10-09 09:09:35 -04001205nothing_to_do:
1206 qc->scsicmd->result = SAM_STAT_GOOD;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001207 return 1;
1208}
1209
Jeff Garzika7dac442005-10-30 04:44:42 -05001210static int ata_scsi_qc_complete(struct ata_queued_cmd *qc,
1211 unsigned int err_mask)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001212{
1213 struct scsi_cmnd *cmd = qc->scsicmd;
Jeff Garzika7dac442005-10-30 04:44:42 -05001214 u8 *cdb = cmd->cmnd;
1215 int need_sense = (err_mask != 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001216
Jeff Garzikb0955182005-05-12 15:45:22 -04001217 /* For ATA pass thru (SAT) commands, generate a sense block if
1218 * user mandated it or if there's an error. Note that if we
1219 * generate because the user forced us to, a check condition
1220 * is generated and the ATA register values are returned
1221 * whether the command completed successfully or not. If there
1222 * was no error, SK, ASC and ASCQ will all be zero.
1223 */
Jeff Garzika7dac442005-10-30 04:44:42 -05001224 if (((cdb[0] == ATA_16) || (cdb[0] == ATA_12)) &&
1225 ((cdb[2] & 0x20) || need_sense)) {
Jeff Garzikb0955182005-05-12 15:45:22 -04001226 ata_gen_ata_desc_sense(qc);
1227 } else {
1228 if (!need_sense) {
1229 cmd->result = SAM_STAT_GOOD;
1230 } else {
1231 /* TODO: decide which descriptor format to use
1232 * for 48b LBA devices and call that here
1233 * instead of the fixed desc, which is only
1234 * good for smaller LBA (and maybe CHS?)
1235 * devices.
1236 */
1237 ata_gen_fixed_sense(qc);
1238 }
1239 }
1240
1241 if (need_sense) {
1242 /* The ata_gen_..._sense routines fill in tf */
1243 ata_dump_status(qc->ap->id, &qc->tf);
1244 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001245
1246 qc->scsidone(cmd);
1247
1248 return 0;
1249}
1250
1251/**
1252 * ata_scsi_translate - Translate then issue SCSI command to ATA device
1253 * @ap: ATA port to which the command is addressed
1254 * @dev: ATA device to which the command is addressed
1255 * @cmd: SCSI command to execute
1256 * @done: SCSI command completion function
1257 * @xlat_func: Actor which translates @cmd to an ATA taskfile
1258 *
1259 * Our ->queuecommand() function has decided that the SCSI
1260 * command issued can be directly translated into an ATA
1261 * command, rather than handled internally.
1262 *
1263 * This function sets up an ata_queued_cmd structure for the
1264 * SCSI command, and sends that ata_queued_cmd to the hardware.
1265 *
Douglas Gilbertae006512005-10-09 09:09:35 -04001266 * The xlat_func argument (actor) returns 0 if ready to execute
1267 * ATA command, else 1 to finish translation. If 1 is returned
1268 * then cmd->result (and possibly cmd->sense_buffer) are assumed
1269 * to be set reflecting an error condition or clean (early)
1270 * termination.
1271 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07001272 * LOCKING:
1273 * spin_lock_irqsave(host_set lock)
1274 */
1275
1276static void ata_scsi_translate(struct ata_port *ap, struct ata_device *dev,
1277 struct scsi_cmnd *cmd,
1278 void (*done)(struct scsi_cmnd *),
1279 ata_xlat_func_t xlat_func)
1280{
1281 struct ata_queued_cmd *qc;
1282 u8 *scsicmd = cmd->cmnd;
1283
1284 VPRINTK("ENTER\n");
1285
1286 qc = ata_scsi_qc_new(ap, dev, cmd, done);
1287 if (!qc)
Douglas Gilbertae006512005-10-09 09:09:35 -04001288 goto err_mem;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001289
1290 /* data is present; dma-map it */
Jeff Garzik0274aa22005-06-22 13:50:56 -04001291 if (cmd->sc_data_direction == DMA_FROM_DEVICE ||
1292 cmd->sc_data_direction == DMA_TO_DEVICE) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001293 if (unlikely(cmd->request_bufflen < 1)) {
1294 printk(KERN_WARNING "ata%u(%u): WARNING: zero len r/w req\n",
1295 ap->id, dev->devno);
Douglas Gilbertae006512005-10-09 09:09:35 -04001296 goto err_did;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001297 }
1298
1299 if (cmd->use_sg)
1300 ata_sg_init(qc, cmd->request_buffer, cmd->use_sg);
1301 else
1302 ata_sg_init_one(qc, cmd->request_buffer,
1303 cmd->request_bufflen);
1304
1305 qc->dma_dir = cmd->sc_data_direction;
1306 }
1307
1308 qc->complete_fn = ata_scsi_qc_complete;
1309
1310 if (xlat_func(qc, scsicmd))
Douglas Gilbertae006512005-10-09 09:09:35 -04001311 goto early_finish;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001312
1313 /* select device, send command to hardware */
1314 if (ata_qc_issue(qc))
Douglas Gilbertae006512005-10-09 09:09:35 -04001315 goto err_did;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001316
1317 VPRINTK("EXIT\n");
1318 return;
1319
Douglas Gilbertae006512005-10-09 09:09:35 -04001320early_finish:
1321 ata_qc_free(qc);
1322 done(cmd);
1323 DPRINTK("EXIT - early finish (good or error)\n");
1324 return;
1325
1326err_did:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001327 ata_qc_free(qc);
Douglas Gilbertae006512005-10-09 09:09:35 -04001328err_mem:
1329 cmd->result = (DID_ERROR << 16);
1330 done(cmd);
1331 DPRINTK("EXIT - internal\n");
1332 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001333}
1334
1335/**
1336 * ata_scsi_rbuf_get - Map response buffer.
1337 * @cmd: SCSI command containing buffer to be mapped.
1338 * @buf_out: Pointer to mapped area.
1339 *
1340 * Maps buffer contained within SCSI command @cmd.
1341 *
1342 * LOCKING:
1343 * spin_lock_irqsave(host_set lock)
1344 *
1345 * RETURNS:
1346 * Length of response buffer.
1347 */
1348
1349static unsigned int ata_scsi_rbuf_get(struct scsi_cmnd *cmd, u8 **buf_out)
1350{
1351 u8 *buf;
1352 unsigned int buflen;
1353
1354 if (cmd->use_sg) {
1355 struct scatterlist *sg;
1356
1357 sg = (struct scatterlist *) cmd->request_buffer;
1358 buf = kmap_atomic(sg->page, KM_USER0) + sg->offset;
1359 buflen = sg->length;
1360 } else {
1361 buf = cmd->request_buffer;
1362 buflen = cmd->request_bufflen;
1363 }
1364
1365 *buf_out = buf;
1366 return buflen;
1367}
1368
1369/**
1370 * ata_scsi_rbuf_put - Unmap response buffer.
1371 * @cmd: SCSI command containing buffer to be unmapped.
1372 * @buf: buffer to unmap
1373 *
1374 * Unmaps response buffer contained within @cmd.
1375 *
1376 * LOCKING:
1377 * spin_lock_irqsave(host_set lock)
1378 */
1379
1380static inline void ata_scsi_rbuf_put(struct scsi_cmnd *cmd, u8 *buf)
1381{
1382 if (cmd->use_sg) {
1383 struct scatterlist *sg;
1384
1385 sg = (struct scatterlist *) cmd->request_buffer;
1386 kunmap_atomic(buf - sg->offset, KM_USER0);
1387 }
1388}
1389
1390/**
1391 * ata_scsi_rbuf_fill - wrapper for SCSI command simulators
1392 * @args: device IDENTIFY data / SCSI command of interest.
1393 * @actor: Callback hook for desired SCSI command simulator
1394 *
1395 * Takes care of the hard work of simulating a SCSI command...
1396 * Mapping the response buffer, calling the command's handler,
1397 * and handling the handler's return value. This return value
1398 * indicates whether the handler wishes the SCSI command to be
Douglas Gilbertae006512005-10-09 09:09:35 -04001399 * completed successfully (0), or not (in which case cmd->result
1400 * and sense buffer are assumed to be set).
Linus Torvalds1da177e2005-04-16 15:20:36 -07001401 *
1402 * LOCKING:
1403 * spin_lock_irqsave(host_set lock)
1404 */
1405
1406void ata_scsi_rbuf_fill(struct ata_scsi_args *args,
1407 unsigned int (*actor) (struct ata_scsi_args *args,
1408 u8 *rbuf, unsigned int buflen))
1409{
1410 u8 *rbuf;
1411 unsigned int buflen, rc;
1412 struct scsi_cmnd *cmd = args->cmd;
1413
1414 buflen = ata_scsi_rbuf_get(cmd, &rbuf);
1415 memset(rbuf, 0, buflen);
1416 rc = actor(args, rbuf, buflen);
1417 ata_scsi_rbuf_put(cmd, rbuf);
1418
Douglas Gilbertae006512005-10-09 09:09:35 -04001419 if (rc == 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001420 cmd->result = SAM_STAT_GOOD;
Douglas Gilbertae006512005-10-09 09:09:35 -04001421 args->done(cmd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001422}
1423
1424/**
1425 * ata_scsiop_inq_std - Simulate INQUIRY command
1426 * @args: device IDENTIFY data / SCSI command of interest.
1427 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1428 * @buflen: Response buffer length.
1429 *
1430 * Returns standard device identification data associated
1431 * with non-EVPD INQUIRY command output.
1432 *
1433 * LOCKING:
1434 * spin_lock_irqsave(host_set lock)
1435 */
1436
1437unsigned int ata_scsiop_inq_std(struct ata_scsi_args *args, u8 *rbuf,
1438 unsigned int buflen)
1439{
1440 u8 hdr[] = {
1441 TYPE_DISK,
1442 0,
1443 0x5, /* claim SPC-3 version compatibility */
1444 2,
1445 95 - 4
1446 };
1447
1448 /* set scsi removeable (RMB) bit per ata bit */
1449 if (ata_id_removeable(args->id))
1450 hdr[1] |= (1 << 7);
1451
1452 VPRINTK("ENTER\n");
1453
1454 memcpy(rbuf, hdr, sizeof(hdr));
1455
1456 if (buflen > 35) {
1457 memcpy(&rbuf[8], "ATA ", 8);
1458 ata_dev_id_string(args->id, &rbuf[16], ATA_ID_PROD_OFS, 16);
1459 ata_dev_id_string(args->id, &rbuf[32], ATA_ID_FW_REV_OFS, 4);
1460 if (rbuf[32] == 0 || rbuf[32] == ' ')
1461 memcpy(&rbuf[32], "n/a ", 4);
1462 }
1463
1464 if (buflen > 63) {
1465 const u8 versions[] = {
1466 0x60, /* SAM-3 (no version claimed) */
1467
1468 0x03,
1469 0x20, /* SBC-2 (no version claimed) */
1470
1471 0x02,
1472 0x60 /* SPC-3 (no version claimed) */
1473 };
1474
1475 memcpy(rbuf + 59, versions, sizeof(versions));
1476 }
1477
1478 return 0;
1479}
1480
1481/**
1482 * ata_scsiop_inq_00 - Simulate INQUIRY EVPD page 0, list of pages
1483 * @args: device IDENTIFY data / SCSI command of interest.
1484 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1485 * @buflen: Response buffer length.
1486 *
1487 * Returns list of inquiry EVPD pages available.
1488 *
1489 * LOCKING:
1490 * spin_lock_irqsave(host_set lock)
1491 */
1492
1493unsigned int ata_scsiop_inq_00(struct ata_scsi_args *args, u8 *rbuf,
1494 unsigned int buflen)
1495{
1496 const u8 pages[] = {
1497 0x00, /* page 0x00, this page */
1498 0x80, /* page 0x80, unit serial no page */
1499 0x83 /* page 0x83, device ident page */
1500 };
1501 rbuf[3] = sizeof(pages); /* number of supported EVPD pages */
1502
1503 if (buflen > 6)
1504 memcpy(rbuf + 4, pages, sizeof(pages));
1505
1506 return 0;
1507}
1508
1509/**
1510 * ata_scsiop_inq_80 - Simulate INQUIRY EVPD page 80, device serial number
1511 * @args: device IDENTIFY data / SCSI command of interest.
1512 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1513 * @buflen: Response buffer length.
1514 *
1515 * Returns ATA device serial number.
1516 *
1517 * LOCKING:
1518 * spin_lock_irqsave(host_set lock)
1519 */
1520
1521unsigned int ata_scsiop_inq_80(struct ata_scsi_args *args, u8 *rbuf,
1522 unsigned int buflen)
1523{
1524 const u8 hdr[] = {
1525 0,
1526 0x80, /* this page code */
1527 0,
1528 ATA_SERNO_LEN, /* page len */
1529 };
1530 memcpy(rbuf, hdr, sizeof(hdr));
1531
1532 if (buflen > (ATA_SERNO_LEN + 4 - 1))
1533 ata_dev_id_string(args->id, (unsigned char *) &rbuf[4],
1534 ATA_ID_SERNO_OFS, ATA_SERNO_LEN);
1535
1536 return 0;
1537}
1538
1539static const char *inq_83_str = "Linux ATA-SCSI simulator";
1540
1541/**
1542 * ata_scsiop_inq_83 - Simulate INQUIRY EVPD page 83, device identity
1543 * @args: device IDENTIFY data / SCSI command of interest.
1544 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1545 * @buflen: Response buffer length.
1546 *
1547 * Returns device identification. Currently hardcoded to
1548 * return "Linux ATA-SCSI simulator".
1549 *
1550 * LOCKING:
1551 * spin_lock_irqsave(host_set lock)
1552 */
1553
1554unsigned int ata_scsiop_inq_83(struct ata_scsi_args *args, u8 *rbuf,
1555 unsigned int buflen)
1556{
1557 rbuf[1] = 0x83; /* this page code */
1558 rbuf[3] = 4 + strlen(inq_83_str); /* page len */
1559
1560 /* our one and only identification descriptor (vendor-specific) */
1561 if (buflen > (strlen(inq_83_str) + 4 + 4 - 1)) {
1562 rbuf[4 + 0] = 2; /* code set: ASCII */
1563 rbuf[4 + 3] = strlen(inq_83_str);
1564 memcpy(rbuf + 4 + 4, inq_83_str, strlen(inq_83_str));
1565 }
1566
1567 return 0;
1568}
1569
1570/**
Jeff Garzik0cba6322005-05-30 19:49:12 -04001571 * ata_scsiop_noop - Command handler that simply returns success.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001572 * @args: device IDENTIFY data / SCSI command of interest.
1573 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1574 * @buflen: Response buffer length.
1575 *
1576 * No operation. Simply returns success to caller, to indicate
1577 * that the caller should successfully complete this SCSI command.
1578 *
1579 * LOCKING:
1580 * spin_lock_irqsave(host_set lock)
1581 */
1582
1583unsigned int ata_scsiop_noop(struct ata_scsi_args *args, u8 *rbuf,
1584 unsigned int buflen)
1585{
1586 VPRINTK("ENTER\n");
1587 return 0;
1588}
1589
1590/**
1591 * ata_msense_push - Push data onto MODE SENSE data output buffer
1592 * @ptr_io: (input/output) Location to store more output data
1593 * @last: End of output data buffer
1594 * @buf: Pointer to BLOB being added to output buffer
1595 * @buflen: Length of BLOB
1596 *
1597 * Store MODE SENSE data on an output buffer.
1598 *
1599 * LOCKING:
1600 * None.
1601 */
1602
1603static void ata_msense_push(u8 **ptr_io, const u8 *last,
1604 const u8 *buf, unsigned int buflen)
1605{
1606 u8 *ptr = *ptr_io;
1607
1608 if ((ptr + buflen - 1) > last)
1609 return;
1610
1611 memcpy(ptr, buf, buflen);
1612
1613 ptr += buflen;
1614
1615 *ptr_io = ptr;
1616}
1617
1618/**
1619 * ata_msense_caching - Simulate MODE SENSE caching info page
1620 * @id: device IDENTIFY data
1621 * @ptr_io: (input/output) Location to store more output data
1622 * @last: End of output data buffer
1623 *
1624 * Generate a caching info page, which conditionally indicates
1625 * write caching to the SCSI layer, depending on device
1626 * capabilities.
1627 *
1628 * LOCKING:
1629 * None.
1630 */
1631
1632static unsigned int ata_msense_caching(u16 *id, u8 **ptr_io,
1633 const u8 *last)
1634{
Douglas Gilbert00ac37f2005-10-28 15:58:28 -04001635 u8 page[CACHE_MPAGE_LEN];
Linus Torvalds1da177e2005-04-16 15:20:36 -07001636
Douglas Gilbert00ac37f2005-10-28 15:58:28 -04001637 memcpy(page, def_cache_mpage, sizeof(page));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001638 if (ata_id_wcache_enabled(id))
1639 page[2] |= (1 << 2); /* write cache enable */
1640 if (!ata_id_rahead_enabled(id))
1641 page[12] |= (1 << 5); /* disable read ahead */
1642
1643 ata_msense_push(ptr_io, last, page, sizeof(page));
1644 return sizeof(page);
1645}
1646
1647/**
1648 * ata_msense_ctl_mode - Simulate MODE SENSE control mode page
1649 * @dev: Device associated with this MODE SENSE command
1650 * @ptr_io: (input/output) Location to store more output data
1651 * @last: End of output data buffer
1652 *
1653 * Generate a generic MODE SENSE control mode page.
1654 *
1655 * LOCKING:
1656 * None.
1657 */
1658
1659static unsigned int ata_msense_ctl_mode(u8 **ptr_io, const u8 *last)
1660{
Douglas Gilbert00ac37f2005-10-28 15:58:28 -04001661 ata_msense_push(ptr_io, last, def_control_mpage,
1662 sizeof(def_control_mpage));
1663 return sizeof(def_control_mpage);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001664}
1665
1666/**
1667 * ata_msense_rw_recovery - Simulate MODE SENSE r/w error recovery page
1668 * @dev: Device associated with this MODE SENSE command
1669 * @ptr_io: (input/output) Location to store more output data
1670 * @last: End of output data buffer
1671 *
1672 * Generate a generic MODE SENSE r/w error recovery page.
1673 *
1674 * LOCKING:
1675 * None.
1676 */
1677
1678static unsigned int ata_msense_rw_recovery(u8 **ptr_io, const u8 *last)
1679{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001680
Douglas Gilbert00ac37f2005-10-28 15:58:28 -04001681 ata_msense_push(ptr_io, last, def_rw_recovery_mpage,
1682 sizeof(def_rw_recovery_mpage));
1683 return sizeof(def_rw_recovery_mpage);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001684}
1685
1686/**
1687 * ata_scsiop_mode_sense - Simulate MODE SENSE 6, 10 commands
1688 * @args: device IDENTIFY data / SCSI command of interest.
1689 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1690 * @buflen: Response buffer length.
1691 *
Douglas Gilbert00ac37f2005-10-28 15:58:28 -04001692 * Simulate MODE SENSE commands. Assume this is invoked for direct
1693 * access devices (e.g. disks) only. There should be no block
1694 * descriptor for other device types.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001695 *
1696 * LOCKING:
1697 * spin_lock_irqsave(host_set lock)
1698 */
1699
1700unsigned int ata_scsiop_mode_sense(struct ata_scsi_args *args, u8 *rbuf,
1701 unsigned int buflen)
1702{
1703 u8 *scsicmd = args->cmd->cmnd, *p, *last;
Douglas Gilbert00ac37f2005-10-28 15:58:28 -04001704 const u8 sat_blk_desc[] = {
1705 0, 0, 0, 0, /* number of blocks: sat unspecified */
1706 0,
1707 0, 0x2, 0x0 /* block length: 512 bytes */
1708 };
1709 u8 pg, spg;
1710 unsigned int ebd, page_control, six_byte, output_len, alloc_len, minlen;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001711
1712 VPRINTK("ENTER\n");
1713
1714 six_byte = (scsicmd[0] == MODE_SENSE);
Douglas Gilbert00ac37f2005-10-28 15:58:28 -04001715 ebd = !(scsicmd[1] & 0x8); /* dbd bit inverted == edb */
1716 /*
1717 * LLBA bit in msense(10) ignored (compliant)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001718 */
Douglas Gilbert00ac37f2005-10-28 15:58:28 -04001719
Linus Torvalds1da177e2005-04-16 15:20:36 -07001720 page_control = scsicmd[2] >> 6;
Douglas Gilbertae006512005-10-09 09:09:35 -04001721 switch (page_control) {
1722 case 0: /* current */
1723 break; /* supported */
1724 case 3: /* saved */
1725 goto saving_not_supp;
1726 case 1: /* changeable */
1727 case 2: /* defaults */
1728 default:
1729 goto invalid_fld;
1730 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001731
Douglas Gilbert00ac37f2005-10-28 15:58:28 -04001732 if (six_byte) {
1733 output_len = 4 + (ebd ? 8 : 0);
1734 alloc_len = scsicmd[4];
1735 } else {
1736 output_len = 8 + (ebd ? 8 : 0);
1737 alloc_len = (scsicmd[7] << 8) + scsicmd[8];
1738 }
1739 minlen = (alloc_len < buflen) ? alloc_len : buflen;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001740
1741 p = rbuf + output_len;
Douglas Gilbert00ac37f2005-10-28 15:58:28 -04001742 last = rbuf + minlen - 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001743
Douglas Gilbert00ac37f2005-10-28 15:58:28 -04001744 pg = scsicmd[2] & 0x3f;
1745 spg = scsicmd[3];
1746 /*
1747 * No mode subpages supported (yet) but asking for _all_
1748 * subpages may be valid
1749 */
1750 if (spg && (spg != ALL_SUB_MPAGES))
1751 goto invalid_fld;
1752
1753 switch(pg) {
1754 case RW_RECOVERY_MPAGE:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001755 output_len += ata_msense_rw_recovery(&p, last);
1756 break;
1757
Douglas Gilbert00ac37f2005-10-28 15:58:28 -04001758 case CACHE_MPAGE:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001759 output_len += ata_msense_caching(args->id, &p, last);
1760 break;
1761
Douglas Gilbert00ac37f2005-10-28 15:58:28 -04001762 case CONTROL_MPAGE: {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001763 output_len += ata_msense_ctl_mode(&p, last);
1764 break;
1765 }
1766
Douglas Gilbert00ac37f2005-10-28 15:58:28 -04001767 case ALL_MPAGES:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001768 output_len += ata_msense_rw_recovery(&p, last);
1769 output_len += ata_msense_caching(args->id, &p, last);
1770 output_len += ata_msense_ctl_mode(&p, last);
1771 break;
1772
1773 default: /* invalid page code */
Douglas Gilbertae006512005-10-09 09:09:35 -04001774 goto invalid_fld;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001775 }
1776
Douglas Gilbert00ac37f2005-10-28 15:58:28 -04001777 if (minlen < 1)
1778 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001779 if (six_byte) {
1780 output_len--;
1781 rbuf[0] = output_len;
Douglas Gilbert00ac37f2005-10-28 15:58:28 -04001782 if (ebd) {
1783 if (minlen > 3)
1784 rbuf[3] = sizeof(sat_blk_desc);
1785 if (minlen > 11)
1786 memcpy(rbuf + 4, sat_blk_desc,
1787 sizeof(sat_blk_desc));
1788 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001789 } else {
1790 output_len -= 2;
1791 rbuf[0] = output_len >> 8;
Douglas Gilbert00ac37f2005-10-28 15:58:28 -04001792 if (minlen > 1)
1793 rbuf[1] = output_len;
1794 if (ebd) {
1795 if (minlen > 7)
1796 rbuf[7] = sizeof(sat_blk_desc);
1797 if (minlen > 15)
1798 memcpy(rbuf + 8, sat_blk_desc,
1799 sizeof(sat_blk_desc));
1800 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001801 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001802 return 0;
Douglas Gilbertae006512005-10-09 09:09:35 -04001803
1804invalid_fld:
1805 ata_scsi_set_sense(args->cmd, ILLEGAL_REQUEST, 0x24, 0x0);
1806 /* "Invalid field in cbd" */
1807 return 1;
1808
1809saving_not_supp:
1810 ata_scsi_set_sense(args->cmd, ILLEGAL_REQUEST, 0x39, 0x0);
1811 /* "Saving parameters not supported" */
1812 return 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001813}
1814
1815/**
1816 * ata_scsiop_read_cap - Simulate READ CAPACITY[ 16] commands
1817 * @args: device IDENTIFY data / SCSI command of interest.
1818 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1819 * @buflen: Response buffer length.
1820 *
1821 * Simulate READ CAPACITY commands.
1822 *
1823 * LOCKING:
1824 * spin_lock_irqsave(host_set lock)
1825 */
1826
1827unsigned int ata_scsiop_read_cap(struct ata_scsi_args *args, u8 *rbuf,
1828 unsigned int buflen)
1829{
1830 u64 n_sectors;
1831 u32 tmp;
1832
1833 VPRINTK("ENTER\n");
1834
Albert Lee8bf62ec2005-05-12 15:29:42 -04001835 if (ata_id_has_lba(args->id)) {
1836 if (ata_id_has_lba48(args->id))
1837 n_sectors = ata_id_u64(args->id, 100);
1838 else
1839 n_sectors = ata_id_u32(args->id, 60);
1840 } else {
1841 /* CHS default translation */
1842 n_sectors = args->id[1] * args->id[3] * args->id[6];
1843
1844 if (ata_id_current_chs_valid(args->id))
1845 /* CHS current translation */
1846 n_sectors = ata_id_u32(args->id, 57);
1847 }
1848
Linus Torvalds1da177e2005-04-16 15:20:36 -07001849 n_sectors--; /* ATA TotalUserSectors - 1 */
1850
Linus Torvalds1da177e2005-04-16 15:20:36 -07001851 if (args->cmd->cmnd[0] == READ_CAPACITY) {
Philip Pokorny0c144d02005-05-28 01:24:47 -07001852 if( n_sectors >= 0xffffffffULL )
1853 tmp = 0xffffffff ; /* Return max count on overflow */
1854 else
1855 tmp = n_sectors ;
1856
Linus Torvalds1da177e2005-04-16 15:20:36 -07001857 /* sector count, 32-bit */
1858 rbuf[0] = tmp >> (8 * 3);
1859 rbuf[1] = tmp >> (8 * 2);
1860 rbuf[2] = tmp >> (8 * 1);
1861 rbuf[3] = tmp;
1862
1863 /* sector size */
1864 tmp = ATA_SECT_SIZE;
1865 rbuf[6] = tmp >> 8;
1866 rbuf[7] = tmp;
1867
1868 } else {
1869 /* sector count, 64-bit */
Philip Pokorny0c144d02005-05-28 01:24:47 -07001870 tmp = n_sectors >> (8 * 4);
1871 rbuf[2] = tmp >> (8 * 3);
1872 rbuf[3] = tmp >> (8 * 2);
1873 rbuf[4] = tmp >> (8 * 1);
1874 rbuf[5] = tmp;
1875 tmp = n_sectors;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001876 rbuf[6] = tmp >> (8 * 3);
1877 rbuf[7] = tmp >> (8 * 2);
1878 rbuf[8] = tmp >> (8 * 1);
1879 rbuf[9] = tmp;
1880
1881 /* sector size */
1882 tmp = ATA_SECT_SIZE;
1883 rbuf[12] = tmp >> 8;
1884 rbuf[13] = tmp;
1885 }
1886
1887 return 0;
1888}
1889
1890/**
1891 * ata_scsiop_report_luns - Simulate REPORT LUNS command
1892 * @args: device IDENTIFY data / SCSI command of interest.
1893 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1894 * @buflen: Response buffer length.
1895 *
1896 * Simulate REPORT LUNS command.
1897 *
1898 * LOCKING:
1899 * spin_lock_irqsave(host_set lock)
1900 */
1901
1902unsigned int ata_scsiop_report_luns(struct ata_scsi_args *args, u8 *rbuf,
1903 unsigned int buflen)
1904{
1905 VPRINTK("ENTER\n");
1906 rbuf[3] = 8; /* just one lun, LUN 0, size 8 bytes */
1907
1908 return 0;
1909}
1910
1911/**
Douglas Gilbert845c5832005-10-09 08:55:41 -04001912 * ata_scsi_set_sense - Set SCSI sense data and status
1913 * @cmd: SCSI request to be handled
1914 * @sk: SCSI-defined sense key
1915 * @asc: SCSI-defined additional sense code
1916 * @ascq: SCSI-defined additional sense code qualifier
1917 *
1918 * Helper function that builds a valid fixed format, current
1919 * response code and the given sense key (sk), additional sense
1920 * code (asc) and additional sense code qualifier (ascq) with
1921 * a SCSI command status of %SAM_STAT_CHECK_CONDITION and
1922 * DRIVER_SENSE set in the upper bits of scsi_cmnd::result .
1923 *
1924 * LOCKING:
1925 * Not required
1926 */
1927
1928void ata_scsi_set_sense(struct scsi_cmnd *cmd, u8 sk, u8 asc, u8 ascq)
1929{
1930 cmd->result = (DRIVER_SENSE << 24) | SAM_STAT_CHECK_CONDITION;
1931
1932 cmd->sense_buffer[0] = 0x70; /* fixed format, current */
1933 cmd->sense_buffer[2] = sk;
1934 cmd->sense_buffer[7] = 18 - 8; /* additional sense length */
1935 cmd->sense_buffer[12] = asc;
1936 cmd->sense_buffer[13] = ascq;
1937}
1938
1939/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07001940 * ata_scsi_badcmd - End a SCSI request with an error
1941 * @cmd: SCSI request to be handled
1942 * @done: SCSI command completion function
1943 * @asc: SCSI-defined additional sense code
1944 * @ascq: SCSI-defined additional sense code qualifier
1945 *
1946 * Helper function that completes a SCSI command with
1947 * %SAM_STAT_CHECK_CONDITION, with a sense key %ILLEGAL_REQUEST
1948 * and the specified additional sense codes.
1949 *
1950 * LOCKING:
1951 * spin_lock_irqsave(host_set lock)
1952 */
1953
1954void ata_scsi_badcmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *), u8 asc, u8 ascq)
1955{
1956 DPRINTK("ENTER\n");
Douglas Gilbertae006512005-10-09 09:09:35 -04001957 ata_scsi_set_sense(cmd, ILLEGAL_REQUEST, asc, ascq);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001958
1959 done(cmd);
1960}
1961
Jeff Garzika939c962005-10-05 17:09:16 -04001962void atapi_request_sense(struct ata_port *ap, struct ata_device *dev,
1963 struct scsi_cmnd *cmd)
1964{
1965 DECLARE_COMPLETION(wait);
1966 struct ata_queued_cmd *qc;
1967 unsigned long flags;
1968 int rc;
1969
1970 DPRINTK("ATAPI request sense\n");
1971
1972 qc = ata_qc_new_init(ap, dev);
1973 BUG_ON(qc == NULL);
1974
1975 /* FIXME: is this needed? */
1976 memset(cmd->sense_buffer, 0, sizeof(cmd->sense_buffer));
1977
1978 ata_sg_init_one(qc, cmd->sense_buffer, sizeof(cmd->sense_buffer));
1979 qc->dma_dir = DMA_FROM_DEVICE;
1980
1981 memset(&qc->cdb, 0, ap->cdb_len);
1982 qc->cdb[0] = REQUEST_SENSE;
1983 qc->cdb[4] = SCSI_SENSE_BUFFERSIZE;
1984
1985 qc->tf.flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
1986 qc->tf.command = ATA_CMD_PACKET;
1987
1988 qc->tf.protocol = ATA_PROT_ATAPI;
1989 qc->tf.lbam = (8 * 1024) & 0xff;
1990 qc->tf.lbah = (8 * 1024) >> 8;
1991 qc->nbytes = SCSI_SENSE_BUFFERSIZE;
1992
1993 qc->waiting = &wait;
1994 qc->complete_fn = ata_qc_complete_noop;
1995
1996 spin_lock_irqsave(&ap->host_set->lock, flags);
1997 rc = ata_qc_issue(qc);
1998 spin_unlock_irqrestore(&ap->host_set->lock, flags);
1999
2000 if (rc)
2001 ata_port_disable(ap);
2002 else
2003 wait_for_completion(&wait);
2004
2005 DPRINTK("EXIT\n");
2006}
2007
Jeff Garzika7dac442005-10-30 04:44:42 -05002008static int atapi_qc_complete(struct ata_queued_cmd *qc, unsigned int err_mask)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002009{
2010 struct scsi_cmnd *cmd = qc->scsicmd;
2011
Jeff Garzika7dac442005-10-30 04:44:42 -05002012 VPRINTK("ENTER, err_mask 0x%X\n", err_mask);
Jeff Garzike12669e2005-10-05 18:39:23 -04002013
Jeff Garzika7dac442005-10-30 04:44:42 -05002014 if (unlikely(err_mask & AC_ERR_DEV)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002015 DPRINTK("request check condition\n");
2016
Jeff Garzika15dbeb2005-10-05 15:02:14 -04002017 /* FIXME: command completion with check condition
2018 * but no sense causes the error handler to run,
2019 * which then issues REQUEST SENSE, fills in the sense
2020 * buffer, and completes the command (for the second
2021 * time). We need to issue REQUEST SENSE some other
2022 * way, to avoid completing the command twice.
2023 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002024 cmd->result = SAM_STAT_CHECK_CONDITION;
2025
2026 qc->scsidone(cmd);
2027
2028 return 1;
Jeff Garzike12669e2005-10-05 18:39:23 -04002029 }
2030
Jeff Garzika7dac442005-10-30 04:44:42 -05002031 else if (unlikely(err_mask))
2032 /* FIXME: not quite right; we don't want the
2033 * translation of taskfile registers into
2034 * a sense descriptors, since that's only
2035 * correct for ATA, not ATAPI
2036 */
2037 ata_gen_ata_desc_sense(qc);
2038
Jeff Garzike12669e2005-10-05 18:39:23 -04002039 else {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002040 u8 *scsicmd = cmd->cmnd;
2041
2042 if (scsicmd[0] == INQUIRY) {
2043 u8 *buf = NULL;
2044 unsigned int buflen;
2045
2046 buflen = ata_scsi_rbuf_get(cmd, &buf);
Jeff Garzika15dbeb2005-10-05 15:02:14 -04002047
2048 /* ATAPI devices typically report zero for their SCSI version,
2049 * and sometimes deviate from the spec WRT response data
2050 * format. If SCSI version is reported as zero like normal,
2051 * then we make the following fixups: 1) Fake MMC-5 version,
2052 * to indicate to the Linux scsi midlayer this is a modern
2053 * device. 2) Ensure response data format / ATAPI information
2054 * are always correct.
2055 */
2056 /* FIXME: do we ever override EVPD pages and the like, with
2057 * this code?
2058 */
2059 if (buf[2] == 0) {
2060 buf[2] = 0x5;
2061 buf[3] = 0x32;
2062 }
2063
Linus Torvalds1da177e2005-04-16 15:20:36 -07002064 ata_scsi_rbuf_put(cmd, buf);
2065 }
Jeff Garzika15dbeb2005-10-05 15:02:14 -04002066
Linus Torvalds1da177e2005-04-16 15:20:36 -07002067 cmd->result = SAM_STAT_GOOD;
2068 }
2069
2070 qc->scsidone(cmd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002071 return 0;
2072}
2073/**
2074 * atapi_xlat - Initialize PACKET taskfile
2075 * @qc: command structure to be initialized
2076 * @scsicmd: SCSI CDB associated with this PACKET command
2077 *
2078 * LOCKING:
2079 * spin_lock_irqsave(host_set lock)
2080 *
2081 * RETURNS:
2082 * Zero on success, non-zero on failure.
2083 */
2084
Jeff Garzik057ace52005-10-22 14:27:05 -04002085static unsigned int atapi_xlat(struct ata_queued_cmd *qc, const u8 *scsicmd)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002086{
2087 struct scsi_cmnd *cmd = qc->scsicmd;
2088 struct ata_device *dev = qc->dev;
2089 int using_pio = (dev->flags & ATA_DFLAG_PIO);
Jeff Garzik0274aa22005-06-22 13:50:56 -04002090 int nodata = (cmd->sc_data_direction == DMA_NONE);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002091
2092 if (!using_pio)
2093 /* Check whether ATAPI DMA is safe */
2094 if (ata_check_atapi_dma(qc))
2095 using_pio = 1;
2096
2097 memcpy(&qc->cdb, scsicmd, qc->ap->cdb_len);
2098
2099 qc->complete_fn = atapi_qc_complete;
2100
2101 qc->tf.flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
Jeff Garzik0274aa22005-06-22 13:50:56 -04002102 if (cmd->sc_data_direction == DMA_TO_DEVICE) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002103 qc->tf.flags |= ATA_TFLAG_WRITE;
2104 DPRINTK("direction: write\n");
2105 }
2106
2107 qc->tf.command = ATA_CMD_PACKET;
2108
2109 /* no data, or PIO data xfer */
2110 if (using_pio || nodata) {
2111 if (nodata)
2112 qc->tf.protocol = ATA_PROT_ATAPI_NODATA;
2113 else
2114 qc->tf.protocol = ATA_PROT_ATAPI;
2115 qc->tf.lbam = (8 * 1024) & 0xff;
2116 qc->tf.lbah = (8 * 1024) >> 8;
2117 }
2118
2119 /* DMA data xfer */
2120 else {
2121 qc->tf.protocol = ATA_PROT_ATAPI_DMA;
2122 qc->tf.feature |= ATAPI_PKT_DMA;
2123
2124#ifdef ATAPI_ENABLE_DMADIR
2125 /* some SATA bridges need us to indicate data xfer direction */
Jeff Garzik0274aa22005-06-22 13:50:56 -04002126 if (cmd->sc_data_direction != DMA_TO_DEVICE)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002127 qc->tf.feature |= ATAPI_DMADIR;
2128#endif
2129 }
2130
2131 qc->nbytes = cmd->bufflen;
2132
2133 return 0;
2134}
2135
2136/**
2137 * ata_scsi_find_dev - lookup ata_device from scsi_cmnd
2138 * @ap: ATA port to which the device is attached
2139 * @scsidev: SCSI device from which we derive the ATA device
2140 *
2141 * Given various information provided in struct scsi_cmnd,
2142 * map that onto an ATA bus, and using that mapping
2143 * determine which ata_device is associated with the
2144 * SCSI command to be sent.
2145 *
2146 * LOCKING:
2147 * spin_lock_irqsave(host_set lock)
2148 *
2149 * RETURNS:
2150 * Associated ATA device, or %NULL if not found.
2151 */
2152
2153static struct ata_device *
Jeff Garzik057ace52005-10-22 14:27:05 -04002154ata_scsi_find_dev(struct ata_port *ap, const struct scsi_device *scsidev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002155{
2156 struct ata_device *dev;
2157
2158 /* skip commands not addressed to targets we simulate */
2159 if (likely(scsidev->id < ATA_MAX_DEVICES))
2160 dev = &ap->device[scsidev->id];
2161 else
2162 return NULL;
2163
2164 if (unlikely((scsidev->channel != 0) ||
2165 (scsidev->lun != 0)))
2166 return NULL;
2167
2168 if (unlikely(!ata_dev_present(dev)))
2169 return NULL;
2170
Jeff Garzik6f106232005-08-30 21:52:18 -04002171 if (!atapi_enabled) {
Jeff Garzik1623c812005-08-30 03:37:42 -04002172 if (unlikely(dev->class == ATA_DEV_ATAPI))
2173 return NULL;
2174 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002175
2176 return dev;
2177}
2178
Jeff Garzikb0955182005-05-12 15:45:22 -04002179/*
2180 * ata_scsi_map_proto - Map pass-thru protocol value to taskfile value.
2181 * @byte1: Byte 1 from pass-thru CDB.
2182 *
2183 * RETURNS:
2184 * ATA_PROT_UNKNOWN if mapping failed/unimplemented, protocol otherwise.
2185 */
2186static u8
2187ata_scsi_map_proto(u8 byte1)
2188{
2189 switch((byte1 & 0x1e) >> 1) {
2190 case 3: /* Non-data */
2191 return ATA_PROT_NODATA;
2192
2193 case 6: /* DMA */
2194 return ATA_PROT_DMA;
2195
2196 case 4: /* PIO Data-in */
2197 case 5: /* PIO Data-out */
2198 if (byte1 & 0xe0) {
2199 return ATA_PROT_PIO_MULT;
2200 }
2201 return ATA_PROT_PIO;
2202
2203 case 10: /* Device Reset */
2204 case 0: /* Hard Reset */
2205 case 1: /* SRST */
2206 case 2: /* Bus Idle */
2207 case 7: /* Packet */
2208 case 8: /* DMA Queued */
2209 case 9: /* Device Diagnostic */
2210 case 11: /* UDMA Data-in */
2211 case 12: /* UDMA Data-Out */
2212 case 13: /* FPDMA */
2213 default: /* Reserved */
2214 break;
2215 }
2216
2217 return ATA_PROT_UNKNOWN;
2218}
2219
2220/**
2221 * ata_scsi_pass_thru - convert ATA pass-thru CDB to taskfile
2222 * @qc: command structure to be initialized
2223 * @cmd: SCSI command to convert
2224 *
2225 * Handles either 12 or 16-byte versions of the CDB.
2226 *
2227 * RETURNS:
2228 * Zero on success, non-zero on failure.
2229 */
2230static unsigned int
Douglas Gilbert00ac37f2005-10-28 15:58:28 -04002231ata_scsi_pass_thru(struct ata_queued_cmd *qc, const u8 *scsicmd)
Jeff Garzikb0955182005-05-12 15:45:22 -04002232{
2233 struct ata_taskfile *tf = &(qc->tf);
2234 struct scsi_cmnd *cmd = qc->scsicmd;
2235
2236 if ((tf->protocol = ata_scsi_map_proto(scsicmd[1])) == ATA_PROT_UNKNOWN)
2237 return 1;
2238
2239 /*
2240 * 12 and 16 byte CDBs use different offsets to
2241 * provide the various register values.
2242 */
2243 if (scsicmd[0] == ATA_16) {
2244 /*
2245 * 16-byte CDB - may contain extended commands.
2246 *
2247 * If that is the case, copy the upper byte register values.
2248 */
2249 if (scsicmd[1] & 0x01) {
2250 tf->hob_feature = scsicmd[3];
2251 tf->hob_nsect = scsicmd[5];
2252 tf->hob_lbal = scsicmd[7];
2253 tf->hob_lbam = scsicmd[9];
2254 tf->hob_lbah = scsicmd[11];
2255 tf->flags |= ATA_TFLAG_LBA48;
2256 } else
2257 tf->flags &= ~ATA_TFLAG_LBA48;
2258
2259 /*
2260 * Always copy low byte, device and command registers.
2261 */
2262 tf->feature = scsicmd[4];
2263 tf->nsect = scsicmd[6];
2264 tf->lbal = scsicmd[8];
2265 tf->lbam = scsicmd[10];
2266 tf->lbah = scsicmd[12];
2267 tf->device = scsicmd[13];
2268 tf->command = scsicmd[14];
2269 } else {
2270 /*
2271 * 12-byte CDB - incapable of extended commands.
2272 */
2273 tf->flags &= ~ATA_TFLAG_LBA48;
2274
2275 tf->feature = scsicmd[3];
2276 tf->nsect = scsicmd[4];
2277 tf->lbal = scsicmd[5];
2278 tf->lbam = scsicmd[6];
2279 tf->lbah = scsicmd[7];
2280 tf->device = scsicmd[8];
2281 tf->command = scsicmd[9];
2282 }
2283
2284 /*
2285 * Filter SET_FEATURES - XFER MODE command -- otherwise,
2286 * SET_FEATURES - XFER MODE must be preceded/succeeded
2287 * by an update to hardware-specific registers for each
2288 * controller (i.e. the reason for ->set_piomode(),
2289 * ->set_dmamode(), and ->post_set_mode() hooks).
2290 */
2291 if ((tf->command == ATA_CMD_SET_FEATURES)
2292 && (tf->feature == SETFEATURES_XFER))
2293 return 1;
2294
2295 /*
2296 * Set flags so that all registers will be written,
2297 * and pass on write indication (used for PIO/DMA
2298 * setup.)
2299 */
2300 tf->flags |= (ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE);
2301
Jeff Garzik0274aa22005-06-22 13:50:56 -04002302 if (cmd->sc_data_direction == DMA_TO_DEVICE)
Jeff Garzikb0955182005-05-12 15:45:22 -04002303 tf->flags |= ATA_TFLAG_WRITE;
2304
2305 /*
2306 * Set transfer length.
2307 *
2308 * TODO: find out if we need to do more here to
2309 * cover scatter/gather case.
2310 */
2311 qc->nsect = cmd->bufflen / ATA_SECT_SIZE;
2312
2313 return 0;
2314}
2315
Linus Torvalds1da177e2005-04-16 15:20:36 -07002316/**
2317 * ata_get_xlat_func - check if SCSI to ATA translation is possible
2318 * @dev: ATA device
2319 * @cmd: SCSI command opcode to consider
2320 *
2321 * Look up the SCSI command given, and determine whether the
2322 * SCSI command is to be translated or simulated.
2323 *
2324 * RETURNS:
2325 * Pointer to translation function if possible, %NULL if not.
2326 */
2327
2328static inline ata_xlat_func_t ata_get_xlat_func(struct ata_device *dev, u8 cmd)
2329{
2330 switch (cmd) {
2331 case READ_6:
2332 case READ_10:
2333 case READ_16:
2334
2335 case WRITE_6:
2336 case WRITE_10:
2337 case WRITE_16:
2338 return ata_scsi_rw_xlat;
2339
2340 case SYNCHRONIZE_CACHE:
2341 if (ata_try_flush_cache(dev))
2342 return ata_scsi_flush_xlat;
2343 break;
2344
2345 case VERIFY:
2346 case VERIFY_16:
2347 return ata_scsi_verify_xlat;
Jeff Garzikb0955182005-05-12 15:45:22 -04002348
2349 case ATA_12:
2350 case ATA_16:
2351 return ata_scsi_pass_thru;
Jeff Garzikda613962005-08-29 19:01:43 -04002352
Douglas Gilbert972dcaf2005-08-11 03:35:53 -04002353 case START_STOP:
2354 return ata_scsi_start_stop_xlat;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002355 }
2356
2357 return NULL;
2358}
2359
2360/**
2361 * ata_scsi_dump_cdb - dump SCSI command contents to dmesg
2362 * @ap: ATA port to which the command was being sent
2363 * @cmd: SCSI command to dump
2364 *
2365 * Prints the contents of a SCSI command via printk().
2366 */
2367
2368static inline void ata_scsi_dump_cdb(struct ata_port *ap,
2369 struct scsi_cmnd *cmd)
2370{
2371#ifdef ATA_DEBUG
2372 struct scsi_device *scsidev = cmd->device;
2373 u8 *scsicmd = cmd->cmnd;
2374
2375 DPRINTK("CDB (%u:%d,%d,%d) %02x %02x %02x %02x %02x %02x %02x %02x %02x\n",
2376 ap->id,
2377 scsidev->channel, scsidev->id, scsidev->lun,
2378 scsicmd[0], scsicmd[1], scsicmd[2], scsicmd[3],
2379 scsicmd[4], scsicmd[5], scsicmd[6], scsicmd[7],
2380 scsicmd[8]);
2381#endif
2382}
2383
2384/**
2385 * ata_scsi_queuecmd - Issue SCSI cdb to libata-managed device
2386 * @cmd: SCSI command to be sent
2387 * @done: Completion function, called when command is complete
2388 *
2389 * In some cases, this function translates SCSI commands into
2390 * ATA taskfiles, and queues the taskfiles to be sent to
2391 * hardware. In other cases, this function simulates a
2392 * SCSI device by evaluating and responding to certain
2393 * SCSI commands. This creates the overall effect of
2394 * ATA and ATAPI devices appearing as SCSI devices.
2395 *
2396 * LOCKING:
2397 * Releases scsi-layer-held lock, and obtains host_set lock.
2398 *
2399 * RETURNS:
2400 * Zero.
2401 */
2402
2403int ata_scsi_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *))
2404{
2405 struct ata_port *ap;
2406 struct ata_device *dev;
2407 struct scsi_device *scsidev = cmd->device;
2408
2409 ap = (struct ata_port *) &scsidev->host->hostdata[0];
2410
2411 ata_scsi_dump_cdb(ap, cmd);
2412
2413 dev = ata_scsi_find_dev(ap, scsidev);
2414 if (unlikely(!dev)) {
2415 cmd->result = (DID_BAD_TARGET << 16);
2416 done(cmd);
2417 goto out_unlock;
2418 }
2419
2420 if (dev->class == ATA_DEV_ATA) {
2421 ata_xlat_func_t xlat_func = ata_get_xlat_func(dev,
2422 cmd->cmnd[0]);
2423
2424 if (xlat_func)
2425 ata_scsi_translate(ap, dev, cmd, done, xlat_func);
2426 else
2427 ata_scsi_simulate(dev->id, cmd, done);
2428 } else
2429 ata_scsi_translate(ap, dev, cmd, done, atapi_xlat);
2430
2431out_unlock:
2432 return 0;
2433}
2434
2435/**
2436 * ata_scsi_simulate - simulate SCSI command on ATA device
2437 * @id: current IDENTIFY data for target device.
2438 * @cmd: SCSI command being sent to device.
2439 * @done: SCSI command completion function.
2440 *
2441 * Interprets and directly executes a select list of SCSI commands
2442 * that can be handled internally.
2443 *
2444 * LOCKING:
2445 * spin_lock_irqsave(host_set lock)
2446 */
2447
2448void ata_scsi_simulate(u16 *id,
2449 struct scsi_cmnd *cmd,
2450 void (*done)(struct scsi_cmnd *))
2451{
2452 struct ata_scsi_args args;
Jeff Garzik057ace52005-10-22 14:27:05 -04002453 const u8 *scsicmd = cmd->cmnd;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002454
2455 args.id = id;
2456 args.cmd = cmd;
2457 args.done = done;
2458
2459 switch(scsicmd[0]) {
2460 /* no-op's, complete with success */
2461 case SYNCHRONIZE_CACHE:
2462 case REZERO_UNIT:
2463 case SEEK_6:
2464 case SEEK_10:
2465 case TEST_UNIT_READY:
2466 case FORMAT_UNIT: /* FIXME: correct? */
2467 case SEND_DIAGNOSTIC: /* FIXME: correct? */
2468 ata_scsi_rbuf_fill(&args, ata_scsiop_noop);
2469 break;
2470
2471 case INQUIRY:
2472 if (scsicmd[1] & 2) /* is CmdDt set? */
Douglas Gilbertae006512005-10-09 09:09:35 -04002473 ata_scsi_invalid_field(cmd, done);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002474 else if ((scsicmd[1] & 1) == 0) /* is EVPD clear? */
2475 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_std);
2476 else if (scsicmd[2] == 0x00)
2477 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_00);
2478 else if (scsicmd[2] == 0x80)
2479 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_80);
2480 else if (scsicmd[2] == 0x83)
2481 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_83);
2482 else
Douglas Gilbertae006512005-10-09 09:09:35 -04002483 ata_scsi_invalid_field(cmd, done);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002484 break;
2485
2486 case MODE_SENSE:
2487 case MODE_SENSE_10:
2488 ata_scsi_rbuf_fill(&args, ata_scsiop_mode_sense);
2489 break;
2490
2491 case MODE_SELECT: /* unconditionally return */
2492 case MODE_SELECT_10: /* bad-field-in-cdb */
Douglas Gilbertae006512005-10-09 09:09:35 -04002493 ata_scsi_invalid_field(cmd, done);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002494 break;
2495
2496 case READ_CAPACITY:
2497 ata_scsi_rbuf_fill(&args, ata_scsiop_read_cap);
2498 break;
2499
2500 case SERVICE_ACTION_IN:
2501 if ((scsicmd[1] & 0x1f) == SAI_READ_CAPACITY_16)
2502 ata_scsi_rbuf_fill(&args, ata_scsiop_read_cap);
2503 else
Douglas Gilbertae006512005-10-09 09:09:35 -04002504 ata_scsi_invalid_field(cmd, done);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002505 break;
2506
2507 case REPORT_LUNS:
2508 ata_scsi_rbuf_fill(&args, ata_scsiop_report_luns);
2509 break;
2510
Jeff Garzikb0955182005-05-12 15:45:22 -04002511 /* mandatory commands we haven't implemented yet */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002512 case REQUEST_SENSE:
2513
2514 /* all other commands */
2515 default:
Douglas Gilbertae006512005-10-09 09:09:35 -04002516 ata_scsi_set_sense(cmd, ILLEGAL_REQUEST, 0x20, 0x0);
2517 /* "Invalid command operation code" */
2518 done(cmd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002519 break;
2520 }
2521}
2522
Jeff Garzik644dd0c2005-10-03 15:55:19 -04002523void ata_scsi_scan_host(struct ata_port *ap)
2524{
Jeff Garzik3f19ee82005-10-03 21:36:41 -04002525 struct ata_device *dev;
Jeff Garzik644dd0c2005-10-03 15:55:19 -04002526 unsigned int i;
2527
2528 if (ap->flags & ATA_FLAG_PORT_DISABLED)
2529 return;
2530
Jeff Garzik3f19ee82005-10-03 21:36:41 -04002531 for (i = 0; i < ATA_MAX_DEVICES; i++) {
2532 dev = &ap->device[i];
2533
2534 if (ata_dev_present(dev))
2535 scsi_scan_target(&ap->host->shost_gendev, 0, i, 0, 0);
2536 }
Jeff Garzik644dd0c2005-10-03 15:55:19 -04002537}
2538