[PATCH] libata: make ata_dev_knobble() per-device
[GitHub/mt8127/android_kernel_alcatel_ttab.git] / drivers / scsi / libata-scsi.c
CommitLineData
1da177e4 1/*
af36d7f0
JG
2 * 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 *
1da177e4
LT
34 */
35
36#include <linux/kernel.h>
37#include <linux/blkdev.h>
38#include <linux/spinlock.h>
39#include <scsi/scsi.h>
1da177e4 40#include <scsi/scsi_host.h>
85837ebd 41#include <scsi/scsi_eh.h>
005a5a06 42#include <scsi/scsi_device.h>
193515d5 43#include <scsi/scsi_request.h>
1da177e4 44#include <linux/libata.h>
b095518e 45#include <linux/hdreg.h>
1da177e4
LT
46#include <asm/uaccess.h>
47
48#include "libata.h"
49
b095518e
JG
50#define SECTOR_SIZE 512
51
057ace5e 52typedef unsigned int (*ata_xlat_func_t)(struct ata_queued_cmd *qc, const u8 *scsicmd);
1da177e4 53static struct ata_device *
057ace5e 54ata_scsi_find_dev(struct ata_port *ap, const struct scsi_device *scsidev);
1da177e4 55
00ac37f5
DG
56#define RW_RECOVERY_MPAGE 0x1
57#define RW_RECOVERY_MPAGE_LEN 12
58#define CACHE_MPAGE 0x8
59#define CACHE_MPAGE_LEN 20
60#define CONTROL_MPAGE 0xa
61#define CONTROL_MPAGE_LEN 12
62#define ALL_MPAGES 0x3f
63#define ALL_SUB_MPAGES 0xff
64
65
66static const u8 def_rw_recovery_mpage[] = {
67 RW_RECOVERY_MPAGE,
68 RW_RECOVERY_MPAGE_LEN - 2,
69 (1 << 7) | /* AWRE, sat-r06 say it shall be 0 */
70 (1 << 6), /* ARRE (auto read reallocation) */
71 0, /* read retry count */
72 0, 0, 0, 0,
73 0, /* write retry count */
74 0, 0, 0
75};
76
77static const u8 def_cache_mpage[CACHE_MPAGE_LEN] = {
78 CACHE_MPAGE,
79 CACHE_MPAGE_LEN - 2,
80 0, /* contains WCE, needs to be 0 for logic */
81 0, 0, 0, 0, 0, 0, 0, 0, 0,
82 0, /* contains DRA, needs to be 0 for logic */
83 0, 0, 0, 0, 0, 0, 0
84};
85
86static const u8 def_control_mpage[CONTROL_MPAGE_LEN] = {
87 CONTROL_MPAGE,
88 CONTROL_MPAGE_LEN - 2,
89 2, /* DSENSE=0, GLTSD=1 */
90 0, /* [QAM+QERR may be 1, see 05-359r1] */
91 0, 0, 0, 0, 0xff, 0xff,
92 0, 30 /* extended self test time, see 05-359r1 */
93};
94
1da177e4 95
ae006510
DG
96static void ata_scsi_invalid_field(struct scsi_cmnd *cmd,
97 void (*done)(struct scsi_cmnd *))
98{
99 ata_scsi_set_sense(cmd, ILLEGAL_REQUEST, 0x24, 0x0);
100 /* "Invalid field in cbd" */
101 done(cmd);
102}
103
1da177e4
LT
104/**
105 * ata_std_bios_param - generic bios head/sector/cylinder calculator used by sd.
106 * @sdev: SCSI device for which BIOS geometry is to be determined
107 * @bdev: block device associated with @sdev
108 * @capacity: capacity of SCSI device
109 * @geom: location to which geometry will be output
110 *
111 * Generic bios head/sector/cylinder calculator
112 * used by sd. Most BIOSes nowadays expect a XXX/255/16 (CHS)
113 * mapping. Some situations may arise where the disk is not
114 * bootable if this is not used.
115 *
116 * LOCKING:
117 * Defined by the SCSI layer. We don't really care.
118 *
119 * RETURNS:
120 * Zero.
121 */
122int ata_std_bios_param(struct scsi_device *sdev, struct block_device *bdev,
123 sector_t capacity, int geom[])
124{
125 geom[0] = 255;
126 geom[1] = 63;
127 sector_div(capacity, 255*63);
128 geom[2] = capacity;
129
130 return 0;
131}
132
b095518e
JG
133/**
134 * ata_cmd_ioctl - Handler for HDIO_DRIVE_CMD ioctl
8e8b77dd 135 * @scsidev: Device to which we are issuing command
b095518e
JG
136 * @arg: User provided data for issuing command
137 *
138 * LOCKING:
139 * Defined by the SCSI layer. We don't really care.
140 *
141 * RETURNS:
142 * Zero on success, negative errno on error.
143 */
144
145int ata_cmd_ioctl(struct scsi_device *scsidev, void __user *arg)
146{
147 int rc = 0;
148 u8 scsi_cmd[MAX_COMMAND_SIZE];
149 u8 args[4], *argbuf = NULL;
150 int argsize = 0;
85837ebd
MC
151 struct scsi_sense_hdr sshdr;
152 enum dma_data_direction data_dir;
b095518e 153
c893a3ae 154 if (arg == NULL)
b095518e
JG
155 return -EINVAL;
156
157 if (copy_from_user(args, arg, sizeof(args)))
158 return -EFAULT;
159
b095518e
JG
160 memset(scsi_cmd, 0, sizeof(scsi_cmd));
161
162 if (args[3]) {
163 argsize = SECTOR_SIZE * args[3];
164 argbuf = kmalloc(argsize, GFP_KERNEL);
54dac83c
JR
165 if (argbuf == NULL) {
166 rc = -ENOMEM;
167 goto error;
168 }
b095518e
JG
169
170 scsi_cmd[1] = (4 << 1); /* PIO Data-in */
171 scsi_cmd[2] = 0x0e; /* no off.line or cc, read from dev,
172 block count in sector count field */
85837ebd 173 data_dir = DMA_FROM_DEVICE;
b095518e
JG
174 } else {
175 scsi_cmd[1] = (3 << 1); /* Non-data */
176 /* scsi_cmd[2] is already 0 -- no off.line, cc, or data xfer */
85837ebd 177 data_dir = DMA_NONE;
b095518e
JG
178 }
179
180 scsi_cmd[0] = ATA_16;
181
182 scsi_cmd[4] = args[2];
183 if (args[0] == WIN_SMART) { /* hack -- ide driver does this too... */
184 scsi_cmd[6] = args[3];
185 scsi_cmd[8] = args[1];
186 scsi_cmd[10] = 0x4f;
187 scsi_cmd[12] = 0xc2;
188 } else {
189 scsi_cmd[6] = args[1];
190 }
191 scsi_cmd[14] = args[0];
192
193 /* Good values for timeout and retries? Values below
194 from scsi_ioctl_send_command() for default case... */
85837ebd
MC
195 if (scsi_execute_req(scsidev, scsi_cmd, data_dir, argbuf, argsize,
196 &sshdr, (10*HZ), 5)) {
b095518e
JG
197 rc = -EIO;
198 goto error;
199 }
200
201 /* Need code to retrieve data from check condition? */
202
203 if ((argbuf)
c893a3ae 204 && copy_to_user(arg + sizeof(args), argbuf, argsize))
b095518e
JG
205 rc = -EFAULT;
206error:
b095518e
JG
207 if (argbuf)
208 kfree(argbuf);
209
210 return rc;
211}
212
213/**
214 * ata_task_ioctl - Handler for HDIO_DRIVE_TASK ioctl
8e8b77dd 215 * @scsidev: Device to which we are issuing command
b095518e
JG
216 * @arg: User provided data for issuing command
217 *
218 * LOCKING:
219 * Defined by the SCSI layer. We don't really care.
220 *
221 * RETURNS:
222 * Zero on success, negative errno on error.
223 */
224int ata_task_ioctl(struct scsi_device *scsidev, void __user *arg)
225{
226 int rc = 0;
227 u8 scsi_cmd[MAX_COMMAND_SIZE];
228 u8 args[7];
85837ebd 229 struct scsi_sense_hdr sshdr;
b095518e 230
c893a3ae 231 if (arg == NULL)
b095518e
JG
232 return -EINVAL;
233
234 if (copy_from_user(args, arg, sizeof(args)))
235 return -EFAULT;
236
237 memset(scsi_cmd, 0, sizeof(scsi_cmd));
238 scsi_cmd[0] = ATA_16;
239 scsi_cmd[1] = (3 << 1); /* Non-data */
240 /* scsi_cmd[2] is already 0 -- no off.line, cc, or data xfer */
241 scsi_cmd[4] = args[1];
242 scsi_cmd[6] = args[2];
243 scsi_cmd[8] = args[3];
244 scsi_cmd[10] = args[4];
245 scsi_cmd[12] = args[5];
246 scsi_cmd[14] = args[0];
247
b095518e 248 /* Good values for timeout and retries? Values below
85837ebd
MC
249 from scsi_ioctl_send_command() for default case... */
250 if (scsi_execute_req(scsidev, scsi_cmd, DMA_NONE, NULL, 0, &sshdr,
251 (10*HZ), 5))
b095518e 252 rc = -EIO;
b095518e
JG
253
254 /* Need code to retrieve data from check condition? */
b095518e
JG
255 return rc;
256}
257
1da177e4
LT
258int ata_scsi_ioctl(struct scsi_device *scsidev, int cmd, void __user *arg)
259{
260 struct ata_port *ap;
261 struct ata_device *dev;
262 int val = -EINVAL, rc = -EINVAL;
263
264 ap = (struct ata_port *) &scsidev->host->hostdata[0];
265 if (!ap)
266 goto out;
267
268 dev = ata_scsi_find_dev(ap, scsidev);
269 if (!dev) {
270 rc = -ENODEV;
271 goto out;
272 }
273
274 switch (cmd) {
275 case ATA_IOC_GET_IO32:
276 val = 0;
277 if (copy_to_user(arg, &val, 1))
278 return -EFAULT;
279 return 0;
280
281 case ATA_IOC_SET_IO32:
282 val = (unsigned long) arg;
283 if (val != 0)
284 return -EINVAL;
285 return 0;
286
b095518e
JG
287 case HDIO_DRIVE_CMD:
288 if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
289 return -EACCES;
290 return ata_cmd_ioctl(scsidev, arg);
291
292 case HDIO_DRIVE_TASK:
293 if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
294 return -EACCES;
295 return ata_task_ioctl(scsidev, arg);
296
1da177e4
LT
297 default:
298 rc = -ENOTTY;
299 break;
300 }
301
302out:
303 return rc;
304}
305
306/**
307 * ata_scsi_qc_new - acquire new ata_queued_cmd reference
308 * @ap: ATA port to which the new command is attached
309 * @dev: ATA device to which the new command is attached
310 * @cmd: SCSI command that originated this ATA command
311 * @done: SCSI command completion function
312 *
313 * Obtain a reference to an unused ata_queued_cmd structure,
314 * which is the basic libata structure representing a single
315 * ATA command sent to the hardware.
316 *
317 * If a command was available, fill in the SCSI-specific
318 * portions of the structure with information on the
319 * current command.
320 *
321 * LOCKING:
322 * spin_lock_irqsave(host_set lock)
323 *
324 * RETURNS:
325 * Command allocated, or %NULL if none available.
326 */
327struct ata_queued_cmd *ata_scsi_qc_new(struct ata_port *ap,
328 struct ata_device *dev,
329 struct scsi_cmnd *cmd,
330 void (*done)(struct scsi_cmnd *))
331{
332 struct ata_queued_cmd *qc;
333
334 qc = ata_qc_new_init(ap, dev);
335 if (qc) {
336 qc->scsicmd = cmd;
337 qc->scsidone = done;
338
339 if (cmd->use_sg) {
cedc9a47 340 qc->__sg = (struct scatterlist *) cmd->request_buffer;
1da177e4
LT
341 qc->n_elem = cmd->use_sg;
342 } else {
cedc9a47 343 qc->__sg = &qc->sgent;
1da177e4
LT
344 qc->n_elem = 1;
345 }
346 } else {
347 cmd->result = (DID_OK << 16) | (QUEUE_FULL << 1);
348 done(cmd);
349 }
350
351 return qc;
352}
353
b095518e
JG
354/**
355 * ata_dump_status - user friendly display of error info
356 * @id: id of the port in question
357 * @tf: ptr to filled out taskfile
358 *
359 * Decode and dump the ATA error/status registers for the user so
360 * that they have some idea what really happened at the non
361 * make-believe layer.
362 *
363 * LOCKING:
364 * inherited from caller
365 */
366void ata_dump_status(unsigned id, struct ata_taskfile *tf)
367{
368 u8 stat = tf->command, err = tf->feature;
369
370 printk(KERN_WARNING "ata%u: status=0x%02x { ", id, stat);
371 if (stat & ATA_BUSY) {
372 printk("Busy }\n"); /* Data is not valid in this case */
373 } else {
374 if (stat & 0x40) printk("DriveReady ");
375 if (stat & 0x20) printk("DeviceFault ");
376 if (stat & 0x10) printk("SeekComplete ");
377 if (stat & 0x08) printk("DataRequest ");
378 if (stat & 0x04) printk("CorrectedError ");
379 if (stat & 0x02) printk("Index ");
380 if (stat & 0x01) printk("Error ");
381 printk("}\n");
382
383 if (err) {
384 printk(KERN_WARNING "ata%u: error=0x%02x { ", id, err);
385 if (err & 0x04) printk("DriveStatusError ");
386 if (err & 0x80) {
387 if (err & 0x04) printk("BadCRC ");
388 else printk("Sector ");
389 }
390 if (err & 0x40) printk("UncorrectableError ");
391 if (err & 0x10) printk("SectorIdNotFound ");
392 if (err & 0x02) printk("TrackZeroNotFound ");
393 if (err & 0x01) printk("AddrMarkNotFound ");
394 printk("}\n");
395 }
396 }
397}
398
9b847548
JA
399int ata_scsi_device_resume(struct scsi_device *sdev)
400{
401 struct ata_port *ap = (struct ata_port *) &sdev->host->hostdata[0];
402 struct ata_device *dev = &ap->device[sdev->id];
403
404 return ata_device_resume(ap, dev);
405}
406
407int ata_scsi_device_suspend(struct scsi_device *sdev)
408{
409 struct ata_port *ap = (struct ata_port *) &sdev->host->hostdata[0];
410 struct ata_device *dev = &ap->device[sdev->id];
411
412 return ata_device_suspend(ap, dev);
413}
414
1da177e4
LT
415/**
416 * ata_to_sense_error - convert ATA error to SCSI error
8e8b77dd 417 * @id: ATA device number
1da177e4 418 * @drv_stat: value contained in ATA status register
b095518e
JG
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
1da177e4 423 *
b095518e
JG
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.
1da177e4
LT
427 *
428 * LOCKING:
429 * spin_lock_irqsave(host_set lock)
430 */
b095518e
JG
431void ata_to_sense_error(unsigned id, u8 drv_stat, u8 drv_err, u8 *sk, u8 *asc,
432 u8 *ascq)
1da177e4 433{
b095518e 434 int i;
ffe75ef6 435
1da177e4 436 /* Based on the 3ware driver translation table */
98ac62de 437 static const unsigned char sense_table[][4] = {
1da177e4
LT
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 };
98ac62de 468 static const unsigned char stat_table[][4] = {
1da177e4
LT
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 };
1da177e4 476
1da177e4
LT
477 /*
478 * Is this an error we can process/parse
479 */
b095518e
JG
480 if (drv_stat & ATA_BUSY) {
481 drv_err = 0; /* Ignore the err bits, they're invalid */
1da177e4 482 }
b095518e
JG
483
484 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 }
495 }
496 /* No immediate match */
497 printk(KERN_WARNING "ata%u: no sense translation for "
498 "error 0x%02x\n", id, drv_err);
1da177e4 499 }
b095518e
JG
500
501 /* Fall back to interpreting status bits */
502 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;
1da177e4 508 }
b095518e
JG
509 }
510 /* 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
0e5dec47 551 cmd->result = (DRIVER_SENSE << 24) | SAM_STAT_CHECK_CONDITION;
b095518e
JG
552
553 /*
554 * Read the controller registers.
555 */
a4631474 556 WARN_ON(qc->ap->ops->tf_read == NULL);
b095518e 557 qc->ap->ops->tf_read(qc->ap, tf);
1da177e4 558
b095518e
JG
559 /*
560 * Use ata_to_sense_error() to map status register bits
561 * onto sense key, asc & ascq.
562 */
a7dac447 563 if (tf->command & (ATA_BUSY | ATA_DF | ATA_ERR | ATA_DRQ)) {
b095518e
JG
564 ata_to_sense_error(qc->ap->id, tf->command, tf->feature,
565 &sb[1], &sb[2], &sb[3]);
566 sb[1] &= 0x0f;
1da177e4
LT
567 }
568
b095518e
JG
569 /*
570 * Sense data is current and format is descriptor.
571 */
572 sb[0] = 0x72;
1da177e4 573
b095518e
JG
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;
1da177e4 605 }
b095518e 606}
1da177e4 607
b095518e
JG
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
0e5dec47 626 cmd->result = (DRIVER_SENSE << 24) | SAM_STAT_CHECK_CONDITION;
b095518e
JG
627
628 /*
629 * Read the controller registers.
630 */
a4631474 631 WARN_ON(qc->ap->ops->tf_read == NULL);
b095518e
JG
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 */
a7dac447 638 if (tf->command & (ATA_BUSY | ATA_DF | ATA_ERR | ATA_DRQ)) {
b095518e
JG
639 ata_to_sense_error(qc->ap->id, tf->command, tf->feature,
640 &sb[2], &sb[12], &sb[13]);
641 sb[2] &= 0x0f;
1da177e4 642 }
1da177e4
LT
643
644 sb[0] = 0x70;
b095518e 645 sb[7] = 0x0a;
0274aa25 646
a7dac447
JG
647 if (tf->flags & ATA_TFLAG_LBA48) {
648 /* TODO: find solution for LBA48 descriptors */
649 }
650
651 else if (tf->flags & ATA_TFLAG_LBA) {
b095518e
JG
652 /* 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;
1da177e4 658 }
a7dac447
JG
659
660 else {
661 /* TODO: C/H/S */
662 }
1da177e4
LT
663}
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)) {
f85bdb9c
JL
698 /*
699 * do not overwrite sdev->host->max_sectors, since
700 * other drives on this host may not support LBA48
701 */
1da177e4
LT
702 blk_queue_max_sectors(sdev->request_queue, 2048);
703 }
cedc9a47
JG
704
705 /*
706 * SATA DMA transfers must be multiples of 4 byte, so
707 * we need to pad ATAPI transfers using an extra sg.
708 * Decrement max hw segments accordingly.
709 */
710 if (dev->class == ATA_DEV_ATAPI) {
711 request_queue_t *q = sdev->request_queue;
712 blk_queue_max_hw_segments(q, q->max_hw_segments - 1);
713 }
1da177e4
LT
714 }
715
716 return 0; /* scsi layer doesn't check return value, sigh */
717}
718
f29841e0
TH
719/**
720 * ata_scsi_timed_out - SCSI layer time out callback
721 * @cmd: timed out SCSI command
722 *
723 * Handles SCSI layer timeout. We race with normal completion of
724 * the qc for @cmd. If the qc is already gone, we lose and let
725 * the scsi command finish (EH_HANDLED). Otherwise, the qc has
726 * timed out and EH should be invoked. Prevent ata_qc_complete()
727 * from finishing it by setting EH_SCHEDULED and return
728 * EH_NOT_HANDLED.
729 *
730 * LOCKING:
731 * Called from timer context
732 *
733 * RETURNS:
734 * EH_HANDLED or EH_NOT_HANDLED
735 */
736enum scsi_eh_timer_return ata_scsi_timed_out(struct scsi_cmnd *cmd)
737{
738 struct Scsi_Host *host = cmd->device->host;
739 struct ata_port *ap = (struct ata_port *) &host->hostdata[0];
740 unsigned long flags;
741 struct ata_queued_cmd *qc;
742 enum scsi_eh_timer_return ret = EH_HANDLED;
743
744 DPRINTK("ENTER\n");
745
746 spin_lock_irqsave(&ap->host_set->lock, flags);
747 qc = ata_qc_from_tag(ap, ap->active_tag);
748 if (qc) {
a4631474 749 WARN_ON(qc->scsicmd != cmd);
f29841e0
TH
750 qc->flags |= ATA_QCFLAG_EH_SCHEDULED;
751 qc->err_mask |= AC_ERR_TIMEOUT;
752 ret = EH_NOT_HANDLED;
753 }
754 spin_unlock_irqrestore(&ap->host_set->lock, flags);
755
756 DPRINTK("EXIT, ret=%d\n", ret);
757 return ret;
758}
759
1da177e4
LT
760/**
761 * ata_scsi_error - SCSI layer error handler callback
762 * @host: SCSI host on which error occurred
763 *
764 * Handles SCSI-layer-thrown error events.
765 *
766 * LOCKING:
767 * Inherited from SCSI layer (none, can sleep)
768 *
769 * RETURNS:
770 * Zero.
771 */
772
773int ata_scsi_error(struct Scsi_Host *host)
774{
775 struct ata_port *ap;
5140788f 776 unsigned long flags;
1da177e4
LT
777
778 DPRINTK("ENTER\n");
779
5140788f
JG
780 ap = (struct ata_port *) &host->hostdata[0];
781
dde44589 782 spin_lock_irqsave(&ap->host_set->lock, flags);
a4631474 783 WARN_ON(ap->flags & ATA_FLAG_IN_EH);
dde44589 784 ap->flags |= ATA_FLAG_IN_EH;
a4631474 785 WARN_ON(ata_qc_from_tag(ap, ap->active_tag) == NULL);
dde44589
TH
786 spin_unlock_irqrestore(&ap->host_set->lock, flags);
787
1da177e4
LT
788 ap->ops->eng_timeout(ap);
789
a4631474 790 WARN_ON(host->host_failed || !list_empty(&host->eh_cmd_q));
a72ec4ce
TH
791
792 scsi_eh_flush_done_q(&ap->eh_done_q);
1da177e4 793
dde44589
TH
794 spin_lock_irqsave(&ap->host_set->lock, flags);
795 ap->flags &= ~ATA_FLAG_IN_EH;
796 spin_unlock_irqrestore(&ap->host_set->lock, flags);
797
1da177e4
LT
798 DPRINTK("EXIT\n");
799 return 0;
800}
801
a72ec4ce
TH
802static void ata_eh_scsidone(struct scsi_cmnd *scmd)
803{
804 /* nada */
805}
806
807static void __ata_eh_qc_complete(struct ata_queued_cmd *qc)
808{
809 struct ata_port *ap = qc->ap;
810 struct scsi_cmnd *scmd = qc->scsicmd;
811 unsigned long flags;
812
813 spin_lock_irqsave(&ap->host_set->lock, flags);
814 qc->scsidone = ata_eh_scsidone;
341963b9 815 __ata_qc_complete(qc);
a4631474 816 WARN_ON(ata_tag_valid(qc->tag));
a72ec4ce
TH
817 spin_unlock_irqrestore(&ap->host_set->lock, flags);
818
819 scsi_eh_finish_cmd(scmd, &ap->eh_done_q);
820}
821
822/**
823 * ata_eh_qc_complete - Complete an active ATA command from EH
824 * @qc: Command to complete
825 *
826 * Indicate to the mid and upper layers that an ATA command has
827 * completed. To be used from EH.
828 */
829void ata_eh_qc_complete(struct ata_queued_cmd *qc)
830{
831 struct scsi_cmnd *scmd = qc->scsicmd;
832 scmd->retries = scmd->allowed;
833 __ata_eh_qc_complete(qc);
834}
835
836/**
837 * ata_eh_qc_retry - Tell midlayer to retry an ATA command after EH
838 * @qc: Command to retry
839 *
840 * Indicate to the mid and upper layers that an ATA command
841 * should be retried. To be used from EH.
842 *
843 * SCSI midlayer limits the number of retries to scmd->allowed.
844 * This function might need to adjust scmd->retries for commands
845 * which get retried due to unrelated NCQ failures.
846 */
847void ata_eh_qc_retry(struct ata_queued_cmd *qc)
848{
849 __ata_eh_qc_complete(qc);
850}
851
972dcafb
DG
852/**
853 * ata_scsi_start_stop_xlat - Translate SCSI START STOP UNIT command
854 * @qc: Storage for translated ATA taskfile
855 * @scsicmd: SCSI command to translate
856 *
857 * Sets up an ATA taskfile to issue STANDBY (to stop) or READ VERIFY
858 * (to start). Perhaps these commands should be preceded by
859 * CHECK POWER MODE to see what power mode the device is already in.
860 * [See SAT revision 5 at www.t10.org]
861 *
862 * LOCKING:
863 * spin_lock_irqsave(host_set lock)
864 *
865 * RETURNS:
866 * Zero on success, non-zero on error.
867 */
868
869static unsigned int ata_scsi_start_stop_xlat(struct ata_queued_cmd *qc,
057ace5e 870 const u8 *scsicmd)
972dcafb
DG
871{
872 struct ata_taskfile *tf = &qc->tf;
873
874 tf->flags |= ATA_TFLAG_DEVICE | ATA_TFLAG_ISADDR;
875 tf->protocol = ATA_PROT_NODATA;
876 if (scsicmd[1] & 0x1) {
877 ; /* ignore IMMED bit, violates sat-r05 */
878 }
879 if (scsicmd[4] & 0x2)
ae006510 880 goto invalid_fld; /* LOEJ bit set not supported */
972dcafb 881 if (((scsicmd[4] >> 4) & 0xf) != 0)
ae006510 882 goto invalid_fld; /* power conditions not supported */
972dcafb
DG
883 if (scsicmd[4] & 0x1) {
884 tf->nsect = 1; /* 1 sector, lba=0 */
9d5b1302
AL
885
886 if (qc->dev->flags & ATA_DFLAG_LBA) {
887 qc->tf.flags |= ATA_TFLAG_LBA;
888
889 tf->lbah = 0x0;
890 tf->lbam = 0x0;
891 tf->lbal = 0x0;
892 tf->device |= ATA_LBA;
893 } else {
894 /* CHS */
895 tf->lbal = 0x1; /* sect */
896 tf->lbam = 0x0; /* cyl low */
897 tf->lbah = 0x0; /* cyl high */
898 }
899
972dcafb
DG
900 tf->command = ATA_CMD_VERIFY; /* READ VERIFY */
901 } else {
902 tf->nsect = 0; /* time period value (0 implies now) */
903 tf->command = ATA_CMD_STANDBY;
904 /* Consider: ATA STANDBY IMMEDIATE command */
905 }
906 /*
907 * Standby and Idle condition timers could be implemented but that
908 * would require libata to implement the Power condition mode page
909 * and allow the user to change it. Changing mode pages requires
910 * MODE SELECT to be implemented.
911 */
912
913 return 0;
ae006510
DG
914
915invalid_fld:
916 ata_scsi_set_sense(qc->scsicmd, ILLEGAL_REQUEST, 0x24, 0x0);
917 /* "Invalid field in cbd" */
918 return 1;
972dcafb
DG
919}
920
921
1da177e4
LT
922/**
923 * ata_scsi_flush_xlat - Translate SCSI SYNCHRONIZE CACHE command
924 * @qc: Storage for translated ATA taskfile
925 * @scsicmd: SCSI command to translate (ignored)
926 *
927 * Sets up an ATA taskfile to issue FLUSH CACHE or
928 * FLUSH CACHE EXT.
929 *
930 * LOCKING:
931 * spin_lock_irqsave(host_set lock)
932 *
933 * RETURNS:
934 * Zero on success, non-zero on error.
935 */
936
057ace5e 937static unsigned int ata_scsi_flush_xlat(struct ata_queued_cmd *qc, const u8 *scsicmd)
1da177e4
LT
938{
939 struct ata_taskfile *tf = &qc->tf;
940
941 tf->flags |= ATA_TFLAG_DEVICE;
942 tf->protocol = ATA_PROT_NODATA;
943
07506697 944 if ((qc->dev->flags & ATA_DFLAG_LBA48) &&
1da177e4
LT
945 (ata_id_has_flush_ext(qc->dev->id)))
946 tf->command = ATA_CMD_FLUSH_EXT;
947 else
948 tf->command = ATA_CMD_FLUSH;
949
950 return 0;
951}
952
3aef5231
AL
953/**
954 * scsi_6_lba_len - Get LBA and transfer length
955 * @scsicmd: SCSI command to translate
956 *
957 * Calculate LBA and transfer length for 6-byte commands.
958 *
959 * RETURNS:
960 * @plba: the LBA
961 * @plen: the transfer length
962 */
963
057ace5e 964static void scsi_6_lba_len(const u8 *scsicmd, u64 *plba, u32 *plen)
3aef5231
AL
965{
966 u64 lba = 0;
967 u32 len = 0;
968
969 VPRINTK("six-byte command\n");
970
971 lba |= ((u64)scsicmd[2]) << 8;
972 lba |= ((u64)scsicmd[3]);
973
974 len |= ((u32)scsicmd[4]);
975
976 *plba = lba;
977 *plen = len;
978}
979
980/**
981 * scsi_10_lba_len - Get LBA and transfer length
982 * @scsicmd: SCSI command to translate
983 *
984 * Calculate LBA and transfer length for 10-byte commands.
985 *
986 * RETURNS:
987 * @plba: the LBA
988 * @plen: the transfer length
989 */
990
057ace5e 991static void scsi_10_lba_len(const u8 *scsicmd, u64 *plba, u32 *plen)
3aef5231
AL
992{
993 u64 lba = 0;
994 u32 len = 0;
995
996 VPRINTK("ten-byte command\n");
997
998 lba |= ((u64)scsicmd[2]) << 24;
999 lba |= ((u64)scsicmd[3]) << 16;
1000 lba |= ((u64)scsicmd[4]) << 8;
1001 lba |= ((u64)scsicmd[5]);
1002
1003 len |= ((u32)scsicmd[7]) << 8;
1004 len |= ((u32)scsicmd[8]);
1005
1006 *plba = lba;
1007 *plen = len;
1008}
1009
1010/**
1011 * scsi_16_lba_len - Get LBA and transfer length
1012 * @scsicmd: SCSI command to translate
1013 *
1014 * Calculate LBA and transfer length for 16-byte commands.
1015 *
1016 * RETURNS:
1017 * @plba: the LBA
1018 * @plen: the transfer length
1019 */
1020
057ace5e 1021static void scsi_16_lba_len(const u8 *scsicmd, u64 *plba, u32 *plen)
3aef5231
AL
1022{
1023 u64 lba = 0;
1024 u32 len = 0;
1025
1026 VPRINTK("sixteen-byte command\n");
1027
1028 lba |= ((u64)scsicmd[2]) << 56;
1029 lba |= ((u64)scsicmd[3]) << 48;
1030 lba |= ((u64)scsicmd[4]) << 40;
1031 lba |= ((u64)scsicmd[5]) << 32;
1032 lba |= ((u64)scsicmd[6]) << 24;
1033 lba |= ((u64)scsicmd[7]) << 16;
1034 lba |= ((u64)scsicmd[8]) << 8;
1035 lba |= ((u64)scsicmd[9]);
1036
1037 len |= ((u32)scsicmd[10]) << 24;
1038 len |= ((u32)scsicmd[11]) << 16;
1039 len |= ((u32)scsicmd[12]) << 8;
1040 len |= ((u32)scsicmd[13]);
1041
1042 *plba = lba;
1043 *plen = len;
1044}
1045
1da177e4
LT
1046/**
1047 * ata_scsi_verify_xlat - Translate SCSI VERIFY command into an ATA one
1048 * @qc: Storage for translated ATA taskfile
1049 * @scsicmd: SCSI command to translate
1050 *
1051 * Converts SCSI VERIFY command to an ATA READ VERIFY command.
1052 *
1053 * LOCKING:
1054 * spin_lock_irqsave(host_set lock)
1055 *
1056 * RETURNS:
1057 * Zero on success, non-zero on error.
1058 */
1059
057ace5e 1060static unsigned int ata_scsi_verify_xlat(struct ata_queued_cmd *qc, const u8 *scsicmd)
1da177e4
LT
1061{
1062 struct ata_taskfile *tf = &qc->tf;
8bf62ece 1063 struct ata_device *dev = qc->dev;
1da177e4 1064 u64 dev_sectors = qc->dev->n_sectors;
3aef5231
AL
1065 u64 block;
1066 u32 n_block;
1da177e4
LT
1067
1068 tf->flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
1069 tf->protocol = ATA_PROT_NODATA;
1da177e4 1070
3aef5231
AL
1071 if (scsicmd[0] == VERIFY)
1072 scsi_10_lba_len(scsicmd, &block, &n_block);
1073 else if (scsicmd[0] == VERIFY_16)
1074 scsi_16_lba_len(scsicmd, &block, &n_block);
1da177e4 1075 else
ae006510 1076 goto invalid_fld;
1da177e4 1077
8bf62ece 1078 if (!n_block)
ae006510 1079 goto nothing_to_do;
8bf62ece 1080 if (block >= dev_sectors)
ae006510 1081 goto out_of_range;
8bf62ece 1082 if ((block + n_block) > dev_sectors)
ae006510 1083 goto out_of_range;
1da177e4 1084
07506697
AL
1085 if (dev->flags & ATA_DFLAG_LBA) {
1086 tf->flags |= ATA_TFLAG_LBA;
1087
c6a33e24
AL
1088 if (lba_28_ok(block, n_block)) {
1089 /* use LBA28 */
1090 tf->command = ATA_CMD_VERIFY;
1091 tf->device |= (block >> 24) & 0xf;
1092 } else if (lba_48_ok(block, n_block)) {
1093 if (!(dev->flags & ATA_DFLAG_LBA48))
1094 goto out_of_range;
07506697
AL
1095
1096 /* use LBA48 */
1097 tf->flags |= ATA_TFLAG_LBA48;
8bf62ece 1098 tf->command = ATA_CMD_VERIFY_EXT;
1da177e4 1099
8bf62ece 1100 tf->hob_nsect = (n_block >> 8) & 0xff;
1da177e4 1101
8bf62ece
AL
1102 tf->hob_lbah = (block >> 40) & 0xff;
1103 tf->hob_lbam = (block >> 32) & 0xff;
1104 tf->hob_lbal = (block >> 24) & 0xff;
c6a33e24
AL
1105 } else
1106 /* request too large even for LBA48 */
1107 goto out_of_range;
8bf62ece
AL
1108
1109 tf->nsect = n_block & 0xff;
1da177e4 1110
8bf62ece
AL
1111 tf->lbah = (block >> 16) & 0xff;
1112 tf->lbam = (block >> 8) & 0xff;
1113 tf->lbal = block & 0xff;
1da177e4 1114
8bf62ece
AL
1115 tf->device |= ATA_LBA;
1116 } else {
1117 /* CHS */
1118 u32 sect, head, cyl, track;
1119
c6a33e24
AL
1120 if (!lba_28_ok(block, n_block))
1121 goto out_of_range;
07506697 1122
8bf62ece
AL
1123 /* Convert LBA to CHS */
1124 track = (u32)block / dev->sectors;
1125 cyl = track / dev->heads;
1126 head = track % dev->heads;
1127 sect = (u32)block % dev->sectors + 1;
1128
c187c4b5
AL
1129 DPRINTK("block %u track %u cyl %u head %u sect %u\n",
1130 (u32)block, track, cyl, head, sect);
8bf62ece
AL
1131
1132 /* Check whether the converted CHS can fit.
1133 Cylinder: 0-65535
1134 Head: 0-15
1135 Sector: 1-255*/
1136 if ((cyl >> 16) || (head >> 4) || (sect >> 8) || (!sect))
ae006510 1137 goto out_of_range;
8bf62ece
AL
1138
1139 tf->command = ATA_CMD_VERIFY;
1140 tf->nsect = n_block & 0xff; /* Sector count 0 means 256 sectors */
1141 tf->lbal = sect;
1142 tf->lbam = cyl;
1143 tf->lbah = cyl >> 8;
1144 tf->device |= head;
1145 }
1da177e4
LT
1146
1147 return 0;
ae006510
DG
1148
1149invalid_fld:
1150 ata_scsi_set_sense(qc->scsicmd, ILLEGAL_REQUEST, 0x24, 0x0);
1151 /* "Invalid field in cbd" */
1152 return 1;
1153
1154out_of_range:
1155 ata_scsi_set_sense(qc->scsicmd, ILLEGAL_REQUEST, 0x21, 0x0);
1156 /* "Logical Block Address out of range" */
1157 return 1;
1158
1159nothing_to_do:
1160 qc->scsicmd->result = SAM_STAT_GOOD;
1161 return 1;
1da177e4
LT
1162}
1163
1164/**
1165 * ata_scsi_rw_xlat - Translate SCSI r/w command into an ATA one
1166 * @qc: Storage for translated ATA taskfile
1167 * @scsicmd: SCSI command to translate
1168 *
1169 * Converts any of six SCSI read/write commands into the
1170 * ATA counterpart, including starting sector (LBA),
1171 * sector count, and taking into account the device's LBA48
1172 * support.
1173 *
1174 * Commands %READ_6, %READ_10, %READ_16, %WRITE_6, %WRITE_10, and
1175 * %WRITE_16 are currently supported.
1176 *
1177 * LOCKING:
1178 * spin_lock_irqsave(host_set lock)
1179 *
1180 * RETURNS:
1181 * Zero on success, non-zero on error.
1182 */
1183
057ace5e 1184static unsigned int ata_scsi_rw_xlat(struct ata_queued_cmd *qc, const u8 *scsicmd)
1da177e4
LT
1185{
1186 struct ata_taskfile *tf = &qc->tf;
8bf62ece 1187 struct ata_device *dev = qc->dev;
3aef5231
AL
1188 u64 block;
1189 u32 n_block;
1da177e4
LT
1190
1191 tf->flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
1da177e4 1192
8cbd6df1
AL
1193 if (scsicmd[0] == WRITE_10 || scsicmd[0] == WRITE_6 ||
1194 scsicmd[0] == WRITE_16)
1da177e4 1195 tf->flags |= ATA_TFLAG_WRITE;
1da177e4 1196
9a3dccc4 1197 /* Calculate the SCSI LBA, transfer length and FUA. */
3aef5231
AL
1198 switch (scsicmd[0]) {
1199 case READ_10:
1200 case WRITE_10:
1201 scsi_10_lba_len(scsicmd, &block, &n_block);
9a3dccc4
TH
1202 if (unlikely(scsicmd[1] & (1 << 3)))
1203 tf->flags |= ATA_TFLAG_FUA;
3aef5231
AL
1204 break;
1205 case READ_6:
1206 case WRITE_6:
1207 scsi_6_lba_len(scsicmd, &block, &n_block);
c187c4b5
AL
1208
1209 /* for 6-byte r/w commands, transfer length 0
1210 * means 256 blocks of data, not 0 block.
1211 */
76b2bf9b
JG
1212 if (!n_block)
1213 n_block = 256;
3aef5231
AL
1214 break;
1215 case READ_16:
1216 case WRITE_16:
1217 scsi_16_lba_len(scsicmd, &block, &n_block);
9a3dccc4
TH
1218 if (unlikely(scsicmd[1] & (1 << 3)))
1219 tf->flags |= ATA_TFLAG_FUA;
3aef5231
AL
1220 break;
1221 default:
8bf62ece 1222 DPRINTK("no-byte command\n");
ae006510 1223 goto invalid_fld;
1da177e4
LT
1224 }
1225
8bf62ece
AL
1226 /* Check and compose ATA command */
1227 if (!n_block)
c187c4b5
AL
1228 /* For 10-byte and 16-byte SCSI R/W commands, transfer
1229 * length 0 means transfer 0 block of data.
1230 * However, for ATA R/W commands, sector count 0 means
1231 * 256 or 65536 sectors, not 0 sectors as in SCSI.
f51750d5
AC
1232 *
1233 * WARNING: one or two older ATA drives treat 0 as 0...
c187c4b5 1234 */
ae006510 1235 goto nothing_to_do;
1da177e4 1236
07506697
AL
1237 if (dev->flags & ATA_DFLAG_LBA) {
1238 tf->flags |= ATA_TFLAG_LBA;
1239
c6a33e24
AL
1240 if (lba_28_ok(block, n_block)) {
1241 /* use LBA28 */
1242 tf->device |= (block >> 24) & 0xf;
1243 } else if (lba_48_ok(block, n_block)) {
1244 if (!(dev->flags & ATA_DFLAG_LBA48))
ae006510 1245 goto out_of_range;
1da177e4 1246
07506697
AL
1247 /* use LBA48 */
1248 tf->flags |= ATA_TFLAG_LBA48;
1249
8bf62ece
AL
1250 tf->hob_nsect = (n_block >> 8) & 0xff;
1251
1252 tf->hob_lbah = (block >> 40) & 0xff;
1253 tf->hob_lbam = (block >> 32) & 0xff;
1254 tf->hob_lbal = (block >> 24) & 0xff;
c6a33e24
AL
1255 } else
1256 /* request too large even for LBA48 */
1257 goto out_of_range;
c187c4b5 1258
9a3dccc4
TH
1259 if (unlikely(ata_rwcmd_protocol(qc) < 0))
1260 goto invalid_fld;
8cbd6df1 1261
8bf62ece
AL
1262 qc->nsect = n_block;
1263 tf->nsect = n_block & 0xff;
1da177e4 1264
8bf62ece
AL
1265 tf->lbah = (block >> 16) & 0xff;
1266 tf->lbam = (block >> 8) & 0xff;
1267 tf->lbal = block & 0xff;
1da177e4 1268
8bf62ece
AL
1269 tf->device |= ATA_LBA;
1270 } else {
1271 /* CHS */
1272 u32 sect, head, cyl, track;
1273
1274 /* The request -may- be too large for CHS addressing. */
c6a33e24 1275 if (!lba_28_ok(block, n_block))
ae006510 1276 goto out_of_range;
c187c4b5 1277
9a3dccc4
TH
1278 if (unlikely(ata_rwcmd_protocol(qc) < 0))
1279 goto invalid_fld;
8cbd6df1 1280
8bf62ece
AL
1281 /* Convert LBA to CHS */
1282 track = (u32)block / dev->sectors;
1283 cyl = track / dev->heads;
1284 head = track % dev->heads;
1285 sect = (u32)block % dev->sectors + 1;
1286
c187c4b5 1287 DPRINTK("block %u track %u cyl %u head %u sect %u\n",
8bf62ece 1288 (u32)block, track, cyl, head, sect);
c187c4b5 1289
8bf62ece
AL
1290 /* Check whether the converted CHS can fit.
1291 Cylinder: 0-65535
1292 Head: 0-15
1293 Sector: 1-255*/
c187c4b5 1294 if ((cyl >> 16) || (head >> 4) || (sect >> 8) || (!sect))
ae006510 1295 goto out_of_range;
c187c4b5 1296
8bf62ece
AL
1297 qc->nsect = n_block;
1298 tf->nsect = n_block & 0xff; /* Sector count 0 means 256 sectors */
1299 tf->lbal = sect;
1300 tf->lbam = cyl;
1301 tf->lbah = cyl >> 8;
1302 tf->device |= head;
1da177e4
LT
1303 }
1304
8bf62ece 1305 return 0;
ae006510
DG
1306
1307invalid_fld:
1308 ata_scsi_set_sense(qc->scsicmd, ILLEGAL_REQUEST, 0x24, 0x0);
1309 /* "Invalid field in cbd" */
1310 return 1;
1311
1312out_of_range:
1313 ata_scsi_set_sense(qc->scsicmd, ILLEGAL_REQUEST, 0x21, 0x0);
1314 /* "Logical Block Address out of range" */
1315 return 1;
1316
1317nothing_to_do:
1318 qc->scsicmd->result = SAM_STAT_GOOD;
1319 return 1;
1da177e4
LT
1320}
1321
77853bf2 1322static void ata_scsi_qc_complete(struct ata_queued_cmd *qc)
1da177e4
LT
1323{
1324 struct scsi_cmnd *cmd = qc->scsicmd;
a7dac447 1325 u8 *cdb = cmd->cmnd;
a22e2eb0 1326 int need_sense = (qc->err_mask != 0);
b095518e
JG
1327
1328 /* For ATA pass thru (SAT) commands, generate a sense block if
1329 * user mandated it or if there's an error. Note that if we
1330 * generate because the user forced us to, a check condition
1331 * is generated and the ATA register values are returned
1332 * whether the command completed successfully or not. If there
1333 * was no error, SK, ASC and ASCQ will all be zero.
1334 */
a7dac447
JG
1335 if (((cdb[0] == ATA_16) || (cdb[0] == ATA_12)) &&
1336 ((cdb[2] & 0x20) || need_sense)) {
b095518e
JG
1337 ata_gen_ata_desc_sense(qc);
1338 } else {
1339 if (!need_sense) {
1340 cmd->result = SAM_STAT_GOOD;
1341 } else {
1342 /* TODO: decide which descriptor format to use
1343 * for 48b LBA devices and call that here
1344 * instead of the fixed desc, which is only
1345 * good for smaller LBA (and maybe CHS?)
1346 * devices.
1347 */
1348 ata_gen_fixed_sense(qc);
1349 }
1350 }
1da177e4 1351
b095518e
JG
1352 if (need_sense) {
1353 /* The ata_gen_..._sense routines fill in tf */
1354 ata_dump_status(qc->ap->id, &qc->tf);
1355 }
1da177e4
LT
1356
1357 qc->scsidone(cmd);
1358
77853bf2 1359 ata_qc_free(qc);
1da177e4
LT
1360}
1361
1362/**
1363 * ata_scsi_translate - Translate then issue SCSI command to ATA device
1364 * @ap: ATA port to which the command is addressed
1365 * @dev: ATA device to which the command is addressed
1366 * @cmd: SCSI command to execute
1367 * @done: SCSI command completion function
1368 * @xlat_func: Actor which translates @cmd to an ATA taskfile
1369 *
1370 * Our ->queuecommand() function has decided that the SCSI
1371 * command issued can be directly translated into an ATA
1372 * command, rather than handled internally.
1373 *
1374 * This function sets up an ata_queued_cmd structure for the
1375 * SCSI command, and sends that ata_queued_cmd to the hardware.
1376 *
ae006510
DG
1377 * The xlat_func argument (actor) returns 0 if ready to execute
1378 * ATA command, else 1 to finish translation. If 1 is returned
1379 * then cmd->result (and possibly cmd->sense_buffer) are assumed
1380 * to be set reflecting an error condition or clean (early)
1381 * termination.
1382 *
1da177e4
LT
1383 * LOCKING:
1384 * spin_lock_irqsave(host_set lock)
1385 */
1386
1387static void ata_scsi_translate(struct ata_port *ap, struct ata_device *dev,
1388 struct scsi_cmnd *cmd,
1389 void (*done)(struct scsi_cmnd *),
1390 ata_xlat_func_t xlat_func)
1391{
1392 struct ata_queued_cmd *qc;
1393 u8 *scsicmd = cmd->cmnd;
1394
1395 VPRINTK("ENTER\n");
1396
1397 qc = ata_scsi_qc_new(ap, dev, cmd, done);
1398 if (!qc)
ae006510 1399 goto err_mem;
1da177e4
LT
1400
1401 /* data is present; dma-map it */
be7db055
CH
1402 if (cmd->sc_data_direction == DMA_FROM_DEVICE ||
1403 cmd->sc_data_direction == DMA_TO_DEVICE) {
1da177e4
LT
1404 if (unlikely(cmd->request_bufflen < 1)) {
1405 printk(KERN_WARNING "ata%u(%u): WARNING: zero len r/w req\n",
1406 ap->id, dev->devno);
ae006510 1407 goto err_did;
1da177e4
LT
1408 }
1409
1410 if (cmd->use_sg)
1411 ata_sg_init(qc, cmd->request_buffer, cmd->use_sg);
1412 else
1413 ata_sg_init_one(qc, cmd->request_buffer,
1414 cmd->request_bufflen);
1415
1416 qc->dma_dir = cmd->sc_data_direction;
1417 }
1418
1419 qc->complete_fn = ata_scsi_qc_complete;
1420
1421 if (xlat_func(qc, scsicmd))
ae006510 1422 goto early_finish;
1da177e4
LT
1423
1424 /* select device, send command to hardware */
9a3d9eb0
TH
1425 qc->err_mask = ata_qc_issue(qc);
1426 if (qc->err_mask)
8e436af9 1427 ata_qc_complete(qc);
1da177e4
LT
1428
1429 VPRINTK("EXIT\n");
1430 return;
1431
ae006510
DG
1432early_finish:
1433 ata_qc_free(qc);
1434 done(cmd);
1435 DPRINTK("EXIT - early finish (good or error)\n");
1436 return;
1437
1438err_did:
1da177e4 1439 ata_qc_free(qc);
ae006510
DG
1440err_mem:
1441 cmd->result = (DID_ERROR << 16);
1442 done(cmd);
1443 DPRINTK("EXIT - internal\n");
1444 return;
1da177e4
LT
1445}
1446
1447/**
1448 * ata_scsi_rbuf_get - Map response buffer.
1449 * @cmd: SCSI command containing buffer to be mapped.
1450 * @buf_out: Pointer to mapped area.
1451 *
1452 * Maps buffer contained within SCSI command @cmd.
1453 *
1454 * LOCKING:
1455 * spin_lock_irqsave(host_set lock)
1456 *
1457 * RETURNS:
1458 * Length of response buffer.
1459 */
1460
1461static unsigned int ata_scsi_rbuf_get(struct scsi_cmnd *cmd, u8 **buf_out)
1462{
1463 u8 *buf;
1464 unsigned int buflen;
1465
1466 if (cmd->use_sg) {
1467 struct scatterlist *sg;
1468
1469 sg = (struct scatterlist *) cmd->request_buffer;
1470 buf = kmap_atomic(sg->page, KM_USER0) + sg->offset;
1471 buflen = sg->length;
1472 } else {
1473 buf = cmd->request_buffer;
1474 buflen = cmd->request_bufflen;
1475 }
1476
1477 *buf_out = buf;
1478 return buflen;
1479}
1480
1481/**
1482 * ata_scsi_rbuf_put - Unmap response buffer.
1483 * @cmd: SCSI command containing buffer to be unmapped.
1484 * @buf: buffer to unmap
1485 *
1486 * Unmaps response buffer contained within @cmd.
1487 *
1488 * LOCKING:
1489 * spin_lock_irqsave(host_set lock)
1490 */
1491
1492static inline void ata_scsi_rbuf_put(struct scsi_cmnd *cmd, u8 *buf)
1493{
1494 if (cmd->use_sg) {
1495 struct scatterlist *sg;
1496
1497 sg = (struct scatterlist *) cmd->request_buffer;
1498 kunmap_atomic(buf - sg->offset, KM_USER0);
1499 }
1500}
1501
1502/**
1503 * ata_scsi_rbuf_fill - wrapper for SCSI command simulators
1504 * @args: device IDENTIFY data / SCSI command of interest.
1505 * @actor: Callback hook for desired SCSI command simulator
1506 *
1507 * Takes care of the hard work of simulating a SCSI command...
1508 * Mapping the response buffer, calling the command's handler,
1509 * and handling the handler's return value. This return value
1510 * indicates whether the handler wishes the SCSI command to be
ae006510
DG
1511 * completed successfully (0), or not (in which case cmd->result
1512 * and sense buffer are assumed to be set).
1da177e4
LT
1513 *
1514 * LOCKING:
1515 * spin_lock_irqsave(host_set lock)
1516 */
1517
1518void ata_scsi_rbuf_fill(struct ata_scsi_args *args,
1519 unsigned int (*actor) (struct ata_scsi_args *args,
1520 u8 *rbuf, unsigned int buflen))
1521{
1522 u8 *rbuf;
1523 unsigned int buflen, rc;
1524 struct scsi_cmnd *cmd = args->cmd;
1525
1526 buflen = ata_scsi_rbuf_get(cmd, &rbuf);
1527 memset(rbuf, 0, buflen);
1528 rc = actor(args, rbuf, buflen);
1529 ata_scsi_rbuf_put(cmd, rbuf);
1530
ae006510 1531 if (rc == 0)
1da177e4 1532 cmd->result = SAM_STAT_GOOD;
ae006510 1533 args->done(cmd);
1da177e4
LT
1534}
1535
1536/**
1537 * ata_scsiop_inq_std - Simulate INQUIRY command
1538 * @args: device IDENTIFY data / SCSI command of interest.
1539 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1540 * @buflen: Response buffer length.
1541 *
1542 * Returns standard device identification data associated
1543 * with non-EVPD INQUIRY command output.
1544 *
1545 * LOCKING:
1546 * spin_lock_irqsave(host_set lock)
1547 */
1548
1549unsigned int ata_scsiop_inq_std(struct ata_scsi_args *args, u8 *rbuf,
1550 unsigned int buflen)
1551{
1552 u8 hdr[] = {
1553 TYPE_DISK,
1554 0,
1555 0x5, /* claim SPC-3 version compatibility */
1556 2,
1557 95 - 4
1558 };
1559
1560 /* set scsi removeable (RMB) bit per ata bit */
1561 if (ata_id_removeable(args->id))
1562 hdr[1] |= (1 << 7);
1563
1564 VPRINTK("ENTER\n");
1565
1566 memcpy(rbuf, hdr, sizeof(hdr));
1567
1568 if (buflen > 35) {
1569 memcpy(&rbuf[8], "ATA ", 8);
1570 ata_dev_id_string(args->id, &rbuf[16], ATA_ID_PROD_OFS, 16);
1571 ata_dev_id_string(args->id, &rbuf[32], ATA_ID_FW_REV_OFS, 4);
1572 if (rbuf[32] == 0 || rbuf[32] == ' ')
1573 memcpy(&rbuf[32], "n/a ", 4);
1574 }
1575
1576 if (buflen > 63) {
1577 const u8 versions[] = {
1578 0x60, /* SAM-3 (no version claimed) */
1579
1580 0x03,
1581 0x20, /* SBC-2 (no version claimed) */
1582
1583 0x02,
1584 0x60 /* SPC-3 (no version claimed) */
1585 };
1586
1587 memcpy(rbuf + 59, versions, sizeof(versions));
1588 }
1589
1590 return 0;
1591}
1592
1593/**
1594 * ata_scsiop_inq_00 - Simulate INQUIRY EVPD page 0, list of pages
1595 * @args: device IDENTIFY data / SCSI command of interest.
1596 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1597 * @buflen: Response buffer length.
1598 *
1599 * Returns list of inquiry EVPD pages available.
1600 *
1601 * LOCKING:
1602 * spin_lock_irqsave(host_set lock)
1603 */
1604
1605unsigned int ata_scsiop_inq_00(struct ata_scsi_args *args, u8 *rbuf,
1606 unsigned int buflen)
1607{
1608 const u8 pages[] = {
1609 0x00, /* page 0x00, this page */
1610 0x80, /* page 0x80, unit serial no page */
1611 0x83 /* page 0x83, device ident page */
1612 };
1613 rbuf[3] = sizeof(pages); /* number of supported EVPD pages */
1614
1615 if (buflen > 6)
1616 memcpy(rbuf + 4, pages, sizeof(pages));
1617
1618 return 0;
1619}
1620
1621/**
1622 * ata_scsiop_inq_80 - Simulate INQUIRY EVPD page 80, device serial number
1623 * @args: device IDENTIFY data / SCSI command of interest.
1624 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1625 * @buflen: Response buffer length.
1626 *
1627 * Returns ATA device serial number.
1628 *
1629 * LOCKING:
1630 * spin_lock_irqsave(host_set lock)
1631 */
1632
1633unsigned int ata_scsiop_inq_80(struct ata_scsi_args *args, u8 *rbuf,
1634 unsigned int buflen)
1635{
1636 const u8 hdr[] = {
1637 0,
1638 0x80, /* this page code */
1639 0,
1640 ATA_SERNO_LEN, /* page len */
1641 };
1642 memcpy(rbuf, hdr, sizeof(hdr));
1643
1644 if (buflen > (ATA_SERNO_LEN + 4 - 1))
1645 ata_dev_id_string(args->id, (unsigned char *) &rbuf[4],
1646 ATA_ID_SERNO_OFS, ATA_SERNO_LEN);
1647
1648 return 0;
1649}
1650
98ac62de 1651static const char * const inq_83_str = "Linux ATA-SCSI simulator";
1da177e4
LT
1652
1653/**
1654 * ata_scsiop_inq_83 - Simulate INQUIRY EVPD page 83, device identity
1655 * @args: device IDENTIFY data / SCSI command of interest.
1656 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1657 * @buflen: Response buffer length.
1658 *
1659 * Returns device identification. Currently hardcoded to
1660 * return "Linux ATA-SCSI simulator".
1661 *
1662 * LOCKING:
1663 * spin_lock_irqsave(host_set lock)
1664 */
1665
1666unsigned int ata_scsiop_inq_83(struct ata_scsi_args *args, u8 *rbuf,
1667 unsigned int buflen)
1668{
1669 rbuf[1] = 0x83; /* this page code */
1670 rbuf[3] = 4 + strlen(inq_83_str); /* page len */
1671
1672 /* our one and only identification descriptor (vendor-specific) */
1673 if (buflen > (strlen(inq_83_str) + 4 + 4 - 1)) {
1674 rbuf[4 + 0] = 2; /* code set: ASCII */
1675 rbuf[4 + 3] = strlen(inq_83_str);
1676 memcpy(rbuf + 4 + 4, inq_83_str, strlen(inq_83_str));
1677 }
1678
1679 return 0;
1680}
1681
1682/**
0cba632b 1683 * ata_scsiop_noop - Command handler that simply returns success.
1da177e4
LT
1684 * @args: device IDENTIFY data / SCSI command of interest.
1685 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1686 * @buflen: Response buffer length.
1687 *
1688 * No operation. Simply returns success to caller, to indicate
1689 * that the caller should successfully complete this SCSI command.
1690 *
1691 * LOCKING:
1692 * spin_lock_irqsave(host_set lock)
1693 */
1694
1695unsigned int ata_scsiop_noop(struct ata_scsi_args *args, u8 *rbuf,
1696 unsigned int buflen)
1697{
1698 VPRINTK("ENTER\n");
1699 return 0;
1700}
1701
1702/**
1703 * ata_msense_push - Push data onto MODE SENSE data output buffer
1704 * @ptr_io: (input/output) Location to store more output data
1705 * @last: End of output data buffer
1706 * @buf: Pointer to BLOB being added to output buffer
1707 * @buflen: Length of BLOB
1708 *
1709 * Store MODE SENSE data on an output buffer.
1710 *
1711 * LOCKING:
1712 * None.
1713 */
1714
1715static void ata_msense_push(u8 **ptr_io, const u8 *last,
1716 const u8 *buf, unsigned int buflen)
1717{
1718 u8 *ptr = *ptr_io;
1719
1720 if ((ptr + buflen - 1) > last)
1721 return;
1722
1723 memcpy(ptr, buf, buflen);
1724
1725 ptr += buflen;
1726
1727 *ptr_io = ptr;
1728}
1729
1730/**
1731 * ata_msense_caching - Simulate MODE SENSE caching info page
1732 * @id: device IDENTIFY data
1733 * @ptr_io: (input/output) Location to store more output data
1734 * @last: End of output data buffer
1735 *
1736 * Generate a caching info page, which conditionally indicates
1737 * write caching to the SCSI layer, depending on device
1738 * capabilities.
1739 *
1740 * LOCKING:
1741 * None.
1742 */
1743
1744static unsigned int ata_msense_caching(u16 *id, u8 **ptr_io,
1745 const u8 *last)
1746{
00ac37f5 1747 u8 page[CACHE_MPAGE_LEN];
1da177e4 1748
00ac37f5 1749 memcpy(page, def_cache_mpage, sizeof(page));
1da177e4
LT
1750 if (ata_id_wcache_enabled(id))
1751 page[2] |= (1 << 2); /* write cache enable */
1752 if (!ata_id_rahead_enabled(id))
1753 page[12] |= (1 << 5); /* disable read ahead */
1754
1755 ata_msense_push(ptr_io, last, page, sizeof(page));
1756 return sizeof(page);
1757}
1758
1759/**
1760 * ata_msense_ctl_mode - Simulate MODE SENSE control mode page
1761 * @dev: Device associated with this MODE SENSE command
1762 * @ptr_io: (input/output) Location to store more output data
1763 * @last: End of output data buffer
1764 *
1765 * Generate a generic MODE SENSE control mode page.
1766 *
1767 * LOCKING:
1768 * None.
1769 */
1770
1771static unsigned int ata_msense_ctl_mode(u8 **ptr_io, const u8 *last)
1772{
00ac37f5
DG
1773 ata_msense_push(ptr_io, last, def_control_mpage,
1774 sizeof(def_control_mpage));
1775 return sizeof(def_control_mpage);
1da177e4
LT
1776}
1777
1778/**
1779 * ata_msense_rw_recovery - Simulate MODE SENSE r/w error recovery page
1780 * @dev: Device associated with this MODE SENSE command
1781 * @ptr_io: (input/output) Location to store more output data
1782 * @last: End of output data buffer
1783 *
1784 * Generate a generic MODE SENSE r/w error recovery page.
1785 *
1786 * LOCKING:
1787 * None.
1788 */
1789
1790static unsigned int ata_msense_rw_recovery(u8 **ptr_io, const u8 *last)
1791{
1da177e4 1792
00ac37f5
DG
1793 ata_msense_push(ptr_io, last, def_rw_recovery_mpage,
1794 sizeof(def_rw_recovery_mpage));
1795 return sizeof(def_rw_recovery_mpage);
1da177e4
LT
1796}
1797
48bdc8ec
JA
1798/*
1799 * We can turn this into a real blacklist if it's needed, for now just
1800 * blacklist any Maxtor BANC1G10 revision firmware
1801 */
1802static int ata_dev_supports_fua(u16 *id)
1803{
1804 unsigned char model[41], fw[9];
1805
1806 if (!ata_id_has_fua(id))
1807 return 0;
1808
2e02671d
TH
1809 ata_dev_id_c_string(id, model, ATA_ID_PROD_OFS, sizeof(model));
1810 ata_dev_id_c_string(id, fw, ATA_ID_FW_REV_OFS, sizeof(fw));
48bdc8ec 1811
2e02671d 1812 if (strcmp(model, "Maxtor"))
48bdc8ec 1813 return 1;
2e02671d 1814 if (strcmp(fw, "BANC1G10"))
48bdc8ec
JA
1815 return 1;
1816
1817 return 0; /* blacklisted */
1818}
1819
1da177e4
LT
1820/**
1821 * ata_scsiop_mode_sense - Simulate MODE SENSE 6, 10 commands
1822 * @args: device IDENTIFY data / SCSI command of interest.
1823 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1824 * @buflen: Response buffer length.
1825 *
00ac37f5
DG
1826 * Simulate MODE SENSE commands. Assume this is invoked for direct
1827 * access devices (e.g. disks) only. There should be no block
1828 * descriptor for other device types.
1da177e4
LT
1829 *
1830 * LOCKING:
1831 * spin_lock_irqsave(host_set lock)
1832 */
1833
1834unsigned int ata_scsiop_mode_sense(struct ata_scsi_args *args, u8 *rbuf,
1835 unsigned int buflen)
1836{
9a3dccc4 1837 struct ata_device *dev = args->dev;
1da177e4 1838 u8 *scsicmd = args->cmd->cmnd, *p, *last;
00ac37f5
DG
1839 const u8 sat_blk_desc[] = {
1840 0, 0, 0, 0, /* number of blocks: sat unspecified */
1841 0,
1842 0, 0x2, 0x0 /* block length: 512 bytes */
1843 };
1844 u8 pg, spg;
1845 unsigned int ebd, page_control, six_byte, output_len, alloc_len, minlen;
9a3dccc4 1846 u8 dpofua;
1da177e4
LT
1847
1848 VPRINTK("ENTER\n");
1849
1850 six_byte = (scsicmd[0] == MODE_SENSE);
00ac37f5
DG
1851 ebd = !(scsicmd[1] & 0x8); /* dbd bit inverted == edb */
1852 /*
1853 * LLBA bit in msense(10) ignored (compliant)
1da177e4 1854 */
00ac37f5 1855
1da177e4 1856 page_control = scsicmd[2] >> 6;
ae006510
DG
1857 switch (page_control) {
1858 case 0: /* current */
1859 break; /* supported */
1860 case 3: /* saved */
1861 goto saving_not_supp;
1862 case 1: /* changeable */
1863 case 2: /* defaults */
1864 default:
1865 goto invalid_fld;
1866 }
1da177e4 1867
00ac37f5
DG
1868 if (six_byte) {
1869 output_len = 4 + (ebd ? 8 : 0);
1870 alloc_len = scsicmd[4];
1871 } else {
1872 output_len = 8 + (ebd ? 8 : 0);
1873 alloc_len = (scsicmd[7] << 8) + scsicmd[8];
1874 }
1875 minlen = (alloc_len < buflen) ? alloc_len : buflen;
1da177e4
LT
1876
1877 p = rbuf + output_len;
00ac37f5 1878 last = rbuf + minlen - 1;
1da177e4 1879
00ac37f5
DG
1880 pg = scsicmd[2] & 0x3f;
1881 spg = scsicmd[3];
1882 /*
1883 * No mode subpages supported (yet) but asking for _all_
1884 * subpages may be valid
1885 */
1886 if (spg && (spg != ALL_SUB_MPAGES))
1887 goto invalid_fld;
1888
1889 switch(pg) {
1890 case RW_RECOVERY_MPAGE:
1da177e4
LT
1891 output_len += ata_msense_rw_recovery(&p, last);
1892 break;
1893
00ac37f5 1894 case CACHE_MPAGE:
1da177e4
LT
1895 output_len += ata_msense_caching(args->id, &p, last);
1896 break;
1897
00ac37f5 1898 case CONTROL_MPAGE: {
1da177e4
LT
1899 output_len += ata_msense_ctl_mode(&p, last);
1900 break;
1901 }
1902
00ac37f5 1903 case ALL_MPAGES:
1da177e4
LT
1904 output_len += ata_msense_rw_recovery(&p, last);
1905 output_len += ata_msense_caching(args->id, &p, last);
1906 output_len += ata_msense_ctl_mode(&p, last);
1907 break;
1908
1909 default: /* invalid page code */
ae006510 1910 goto invalid_fld;
1da177e4
LT
1911 }
1912
00ac37f5
DG
1913 if (minlen < 1)
1914 return 0;
9a3dccc4
TH
1915
1916 dpofua = 0;
48bdc8ec 1917 if (ata_dev_supports_fua(args->id) && dev->flags & ATA_DFLAG_LBA48 &&
9a3dccc4
TH
1918 (!(dev->flags & ATA_DFLAG_PIO) || dev->multi_count))
1919 dpofua = 1 << 4;
1920
1da177e4
LT
1921 if (six_byte) {
1922 output_len--;
1923 rbuf[0] = output_len;
9a3dccc4
TH
1924 if (minlen > 2)
1925 rbuf[2] |= dpofua;
00ac37f5
DG
1926 if (ebd) {
1927 if (minlen > 3)
1928 rbuf[3] = sizeof(sat_blk_desc);
1929 if (minlen > 11)
1930 memcpy(rbuf + 4, sat_blk_desc,
1931 sizeof(sat_blk_desc));
1932 }
1da177e4
LT
1933 } else {
1934 output_len -= 2;
1935 rbuf[0] = output_len >> 8;
00ac37f5
DG
1936 if (minlen > 1)
1937 rbuf[1] = output_len;
9a3dccc4
TH
1938 if (minlen > 3)
1939 rbuf[3] |= dpofua;
00ac37f5
DG
1940 if (ebd) {
1941 if (minlen > 7)
1942 rbuf[7] = sizeof(sat_blk_desc);
1943 if (minlen > 15)
1944 memcpy(rbuf + 8, sat_blk_desc,
1945 sizeof(sat_blk_desc));
1946 }
1da177e4 1947 }
1da177e4 1948 return 0;
ae006510
DG
1949
1950invalid_fld:
1951 ata_scsi_set_sense(args->cmd, ILLEGAL_REQUEST, 0x24, 0x0);
1952 /* "Invalid field in cbd" */
1953 return 1;
1954
1955saving_not_supp:
1956 ata_scsi_set_sense(args->cmd, ILLEGAL_REQUEST, 0x39, 0x0);
1957 /* "Saving parameters not supported" */
1958 return 1;
1da177e4
LT
1959}
1960
1961/**
1962 * ata_scsiop_read_cap - Simulate READ CAPACITY[ 16] commands
1963 * @args: device IDENTIFY data / SCSI command of interest.
1964 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1965 * @buflen: Response buffer length.
1966 *
1967 * Simulate READ CAPACITY commands.
1968 *
1969 * LOCKING:
1970 * spin_lock_irqsave(host_set lock)
1971 */
1972
1973unsigned int ata_scsiop_read_cap(struct ata_scsi_args *args, u8 *rbuf,
1974 unsigned int buflen)
1975{
1976 u64 n_sectors;
1977 u32 tmp;
1978
1979 VPRINTK("ENTER\n");
1980
8bf62ece
AL
1981 if (ata_id_has_lba(args->id)) {
1982 if (ata_id_has_lba48(args->id))
1983 n_sectors = ata_id_u64(args->id, 100);
1984 else
1985 n_sectors = ata_id_u32(args->id, 60);
1986 } else {
1987 /* CHS default translation */
1988 n_sectors = args->id[1] * args->id[3] * args->id[6];
1989
1990 if (ata_id_current_chs_valid(args->id))
1991 /* CHS current translation */
1992 n_sectors = ata_id_u32(args->id, 57);
1993 }
1994
1da177e4
LT
1995 n_sectors--; /* ATA TotalUserSectors - 1 */
1996
1da177e4 1997 if (args->cmd->cmnd[0] == READ_CAPACITY) {
0c144d0d
PP
1998 if( n_sectors >= 0xffffffffULL )
1999 tmp = 0xffffffff ; /* Return max count on overflow */
2000 else
2001 tmp = n_sectors ;
2002
1da177e4
LT
2003 /* sector count, 32-bit */
2004 rbuf[0] = tmp >> (8 * 3);
2005 rbuf[1] = tmp >> (8 * 2);
2006 rbuf[2] = tmp >> (8 * 1);
2007 rbuf[3] = tmp;
2008
2009 /* sector size */
2010 tmp = ATA_SECT_SIZE;
2011 rbuf[6] = tmp >> 8;
2012 rbuf[7] = tmp;
2013
2014 } else {
2015 /* sector count, 64-bit */
0c144d0d
PP
2016 tmp = n_sectors >> (8 * 4);
2017 rbuf[2] = tmp >> (8 * 3);
2018 rbuf[3] = tmp >> (8 * 2);
2019 rbuf[4] = tmp >> (8 * 1);
2020 rbuf[5] = tmp;
2021 tmp = n_sectors;
1da177e4
LT
2022 rbuf[6] = tmp >> (8 * 3);
2023 rbuf[7] = tmp >> (8 * 2);
2024 rbuf[8] = tmp >> (8 * 1);
2025 rbuf[9] = tmp;
2026
2027 /* sector size */
2028 tmp = ATA_SECT_SIZE;
2029 rbuf[12] = tmp >> 8;
2030 rbuf[13] = tmp;
2031 }
2032
2033 return 0;
2034}
2035
2036/**
2037 * ata_scsiop_report_luns - Simulate REPORT LUNS command
2038 * @args: device IDENTIFY data / SCSI command of interest.
2039 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2040 * @buflen: Response buffer length.
2041 *
2042 * Simulate REPORT LUNS command.
2043 *
2044 * LOCKING:
2045 * spin_lock_irqsave(host_set lock)
2046 */
2047
2048unsigned int ata_scsiop_report_luns(struct ata_scsi_args *args, u8 *rbuf,
2049 unsigned int buflen)
2050{
2051 VPRINTK("ENTER\n");
2052 rbuf[3] = 8; /* just one lun, LUN 0, size 8 bytes */
2053
2054 return 0;
2055}
2056
845c5834
DG
2057/**
2058 * ata_scsi_set_sense - Set SCSI sense data and status
2059 * @cmd: SCSI request to be handled
2060 * @sk: SCSI-defined sense key
2061 * @asc: SCSI-defined additional sense code
2062 * @ascq: SCSI-defined additional sense code qualifier
2063 *
2064 * Helper function that builds a valid fixed format, current
2065 * response code and the given sense key (sk), additional sense
2066 * code (asc) and additional sense code qualifier (ascq) with
2067 * a SCSI command status of %SAM_STAT_CHECK_CONDITION and
2068 * DRIVER_SENSE set in the upper bits of scsi_cmnd::result .
2069 *
2070 * LOCKING:
2071 * Not required
2072 */
2073
2074void ata_scsi_set_sense(struct scsi_cmnd *cmd, u8 sk, u8 asc, u8 ascq)
2075{
2076 cmd->result = (DRIVER_SENSE << 24) | SAM_STAT_CHECK_CONDITION;
2077
2078 cmd->sense_buffer[0] = 0x70; /* fixed format, current */
2079 cmd->sense_buffer[2] = sk;
2080 cmd->sense_buffer[7] = 18 - 8; /* additional sense length */
2081 cmd->sense_buffer[12] = asc;
2082 cmd->sense_buffer[13] = ascq;
2083}
2084
1da177e4
LT
2085/**
2086 * ata_scsi_badcmd - End a SCSI request with an error
2087 * @cmd: SCSI request to be handled
2088 * @done: SCSI command completion function
2089 * @asc: SCSI-defined additional sense code
2090 * @ascq: SCSI-defined additional sense code qualifier
2091 *
2092 * Helper function that completes a SCSI command with
2093 * %SAM_STAT_CHECK_CONDITION, with a sense key %ILLEGAL_REQUEST
2094 * and the specified additional sense codes.
2095 *
2096 * LOCKING:
2097 * spin_lock_irqsave(host_set lock)
2098 */
2099
2100void ata_scsi_badcmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *), u8 asc, u8 ascq)
2101{
2102 DPRINTK("ENTER\n");
ae006510 2103 ata_scsi_set_sense(cmd, ILLEGAL_REQUEST, asc, ascq);
1da177e4
LT
2104
2105 done(cmd);
2106}
2107
77853bf2 2108static void atapi_sense_complete(struct ata_queued_cmd *qc)
a939c963 2109{
a22e2eb0 2110 if (qc->err_mask && ((qc->err_mask & AC_ERR_DEV) == 0))
c6e6e666
JG
2111 /* FIXME: not quite right; we don't want the
2112 * translation of taskfile registers into
2113 * a sense descriptors, since that's only
2114 * correct for ATA, not ATAPI
2115 */
2116 ata_gen_ata_desc_sense(qc);
a939c963 2117
c6e6e666 2118 qc->scsidone(qc->scsicmd);
77853bf2 2119 ata_qc_free(qc);
c6e6e666 2120}
a939c963 2121
c6e6e666
JG
2122/* is it pointless to prefer PIO for "safety reasons"? */
2123static inline int ata_pio_use_silly(struct ata_port *ap)
2124{
2125 return (ap->flags & ATA_FLAG_PIO_DMA);
2126}
2127
2128static void atapi_request_sense(struct ata_queued_cmd *qc)
2129{
2130 struct ata_port *ap = qc->ap;
2131 struct scsi_cmnd *cmd = qc->scsicmd;
2132
2133 DPRINTK("ATAPI request sense\n");
a939c963
JG
2134
2135 /* FIXME: is this needed? */
2136 memset(cmd->sense_buffer, 0, sizeof(cmd->sense_buffer));
2137
c6e6e666
JG
2138 ap->ops->tf_read(ap, &qc->tf);
2139
2140 /* fill these in, for the case where they are -not- overwritten */
2141 cmd->sense_buffer[0] = 0x70;
2142 cmd->sense_buffer[2] = qc->tf.feature >> 4;
2143
2144 ata_qc_reinit(qc);
2145
a939c963
JG
2146 ata_sg_init_one(qc, cmd->sense_buffer, sizeof(cmd->sense_buffer));
2147 qc->dma_dir = DMA_FROM_DEVICE;
2148
2149 memset(&qc->cdb, 0, ap->cdb_len);
2150 qc->cdb[0] = REQUEST_SENSE;
2151 qc->cdb[4] = SCSI_SENSE_BUFFERSIZE;
2152
2153 qc->tf.flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
2154 qc->tf.command = ATA_CMD_PACKET;
2155
c6e6e666
JG
2156 if (ata_pio_use_silly(ap)) {
2157 qc->tf.protocol = ATA_PROT_ATAPI_DMA;
2158 qc->tf.feature |= ATAPI_PKT_DMA;
2159 } else {
2160 qc->tf.protocol = ATA_PROT_ATAPI;
2161 qc->tf.lbam = (8 * 1024) & 0xff;
2162 qc->tf.lbah = (8 * 1024) >> 8;
2163 }
a939c963
JG
2164 qc->nbytes = SCSI_SENSE_BUFFERSIZE;
2165
c6e6e666 2166 qc->complete_fn = atapi_sense_complete;
a939c963 2167
9a3d9eb0
TH
2168 qc->err_mask = ata_qc_issue(qc);
2169 if (qc->err_mask)
a22e2eb0 2170 ata_qc_complete(qc);
a939c963
JG
2171
2172 DPRINTK("EXIT\n");
2173}
2174
77853bf2 2175static void atapi_qc_complete(struct ata_queued_cmd *qc)
1da177e4
LT
2176{
2177 struct scsi_cmnd *cmd = qc->scsicmd;
a22e2eb0 2178 unsigned int err_mask = qc->err_mask;
1da177e4 2179
a7dac447 2180 VPRINTK("ENTER, err_mask 0x%X\n", err_mask);
e12669e7 2181
a7dac447 2182 if (unlikely(err_mask & AC_ERR_DEV)) {
1da177e4 2183 cmd->result = SAM_STAT_CHECK_CONDITION;
c6e6e666 2184 atapi_request_sense(qc);
77853bf2 2185 return;
e12669e7
JG
2186 }
2187
a7dac447
JG
2188 else if (unlikely(err_mask))
2189 /* FIXME: not quite right; we don't want the
2190 * translation of taskfile registers into
2191 * a sense descriptors, since that's only
2192 * correct for ATA, not ATAPI
2193 */
2194 ata_gen_ata_desc_sense(qc);
2195
e12669e7 2196 else {
1da177e4
LT
2197 u8 *scsicmd = cmd->cmnd;
2198
fd71da46 2199 if ((scsicmd[0] == INQUIRY) && ((scsicmd[1] & 0x03) == 0)) {
1da177e4
LT
2200 u8 *buf = NULL;
2201 unsigned int buflen;
2202
2203 buflen = ata_scsi_rbuf_get(cmd, &buf);
a15dbeb4
JG
2204
2205 /* ATAPI devices typically report zero for their SCSI version,
2206 * and sometimes deviate from the spec WRT response data
2207 * format. If SCSI version is reported as zero like normal,
2208 * then we make the following fixups: 1) Fake MMC-5 version,
2209 * to indicate to the Linux scsi midlayer this is a modern
2210 * device. 2) Ensure response data format / ATAPI information
2211 * are always correct.
a15dbeb4
JG
2212 */
2213 if (buf[2] == 0) {
2214 buf[2] = 0x5;
2215 buf[3] = 0x32;
2216 }
2217
1da177e4
LT
2218 ata_scsi_rbuf_put(cmd, buf);
2219 }
a15dbeb4 2220
1da177e4
LT
2221 cmd->result = SAM_STAT_GOOD;
2222 }
2223
2224 qc->scsidone(cmd);
77853bf2 2225 ata_qc_free(qc);
1da177e4
LT
2226}
2227/**
2228 * atapi_xlat - Initialize PACKET taskfile
2229 * @qc: command structure to be initialized
2230 * @scsicmd: SCSI CDB associated with this PACKET command
2231 *
2232 * LOCKING:
2233 * spin_lock_irqsave(host_set lock)
2234 *
2235 * RETURNS:
2236 * Zero on success, non-zero on failure.
2237 */
2238
057ace5e 2239static unsigned int atapi_xlat(struct ata_queued_cmd *qc, const u8 *scsicmd)
1da177e4
LT
2240{
2241 struct scsi_cmnd *cmd = qc->scsicmd;
2242 struct ata_device *dev = qc->dev;
2243 int using_pio = (dev->flags & ATA_DFLAG_PIO);
be7db055 2244 int nodata = (cmd->sc_data_direction == DMA_NONE);
1da177e4
LT
2245
2246 if (!using_pio)
2247 /* Check whether ATAPI DMA is safe */
2248 if (ata_check_atapi_dma(qc))
2249 using_pio = 1;
2250
2251 memcpy(&qc->cdb, scsicmd, qc->ap->cdb_len);
2252
2253 qc->complete_fn = atapi_qc_complete;
2254
2255 qc->tf.flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
be7db055 2256 if (cmd->sc_data_direction == DMA_TO_DEVICE) {
1da177e4
LT
2257 qc->tf.flags |= ATA_TFLAG_WRITE;
2258 DPRINTK("direction: write\n");
2259 }
2260
2261 qc->tf.command = ATA_CMD_PACKET;
2262
2263 /* no data, or PIO data xfer */
2264 if (using_pio || nodata) {
2265 if (nodata)
2266 qc->tf.protocol = ATA_PROT_ATAPI_NODATA;
2267 else
2268 qc->tf.protocol = ATA_PROT_ATAPI;
2269 qc->tf.lbam = (8 * 1024) & 0xff;
2270 qc->tf.lbah = (8 * 1024) >> 8;
2271 }
2272
2273 /* DMA data xfer */
2274 else {
2275 qc->tf.protocol = ATA_PROT_ATAPI_DMA;
2276 qc->tf.feature |= ATAPI_PKT_DMA;
2277
2278#ifdef ATAPI_ENABLE_DMADIR
2279 /* some SATA bridges need us to indicate data xfer direction */
be7db055 2280 if (cmd->sc_data_direction != DMA_TO_DEVICE)
1da177e4
LT
2281 qc->tf.feature |= ATAPI_DMADIR;
2282#endif
2283 }
2284
2285 qc->nbytes = cmd->bufflen;
2286
2287 return 0;
2288}
2289
2290/**
2291 * ata_scsi_find_dev - lookup ata_device from scsi_cmnd
2292 * @ap: ATA port to which the device is attached
2293 * @scsidev: SCSI device from which we derive the ATA device
2294 *
2295 * Given various information provided in struct scsi_cmnd,
2296 * map that onto an ATA bus, and using that mapping
2297 * determine which ata_device is associated with the
2298 * SCSI command to be sent.
2299 *
2300 * LOCKING:
2301 * spin_lock_irqsave(host_set lock)
2302 *
2303 * RETURNS:
2304 * Associated ATA device, or %NULL if not found.
2305 */
2306
2307static struct ata_device *
057ace5e 2308ata_scsi_find_dev(struct ata_port *ap, const struct scsi_device *scsidev)
1da177e4
LT
2309{
2310 struct ata_device *dev;
2311
2312 /* skip commands not addressed to targets we simulate */
2313 if (likely(scsidev->id < ATA_MAX_DEVICES))
2314 dev = &ap->device[scsidev->id];
2315 else
2316 return NULL;
2317
2318 if (unlikely((scsidev->channel != 0) ||
2319 (scsidev->lun != 0)))
2320 return NULL;
2321
2322 if (unlikely(!ata_dev_present(dev)))
2323 return NULL;
2324
50630195
JG
2325 if (!atapi_enabled || (ap->flags & ATA_FLAG_NO_ATAPI)) {
2326 if (unlikely(dev->class == ATA_DEV_ATAPI)) {
2327 printk(KERN_WARNING "ata%u(%u): WARNING: ATAPI is %s, device ignored.\n",
2328 ap->id, dev->devno, atapi_enabled ? "not supported with this driver" : "disabled");
1623c81e 2329 return NULL;
50630195 2330 }
1623c81e 2331 }
1da177e4
LT
2332
2333 return dev;
2334}
2335
b095518e
JG
2336/*
2337 * ata_scsi_map_proto - Map pass-thru protocol value to taskfile value.
2338 * @byte1: Byte 1 from pass-thru CDB.
2339 *
2340 * RETURNS:
2341 * ATA_PROT_UNKNOWN if mapping failed/unimplemented, protocol otherwise.
2342 */
2343static u8
2344ata_scsi_map_proto(u8 byte1)
2345{
2346 switch((byte1 & 0x1e) >> 1) {
2347 case 3: /* Non-data */
2348 return ATA_PROT_NODATA;
2349
2350 case 6: /* DMA */
2351 return ATA_PROT_DMA;
2352
2353 case 4: /* PIO Data-in */
2354 case 5: /* PIO Data-out */
2355 if (byte1 & 0xe0) {
2356 return ATA_PROT_PIO_MULT;
2357 }
2358 return ATA_PROT_PIO;
2359
2360 case 10: /* Device Reset */
2361 case 0: /* Hard Reset */
2362 case 1: /* SRST */
2363 case 2: /* Bus Idle */
2364 case 7: /* Packet */
2365 case 8: /* DMA Queued */
2366 case 9: /* Device Diagnostic */
2367 case 11: /* UDMA Data-in */
2368 case 12: /* UDMA Data-Out */
2369 case 13: /* FPDMA */
2370 default: /* Reserved */
2371 break;
2372 }
2373
2374 return ATA_PROT_UNKNOWN;
2375}
2376
2377/**
2378 * ata_scsi_pass_thru - convert ATA pass-thru CDB to taskfile
2379 * @qc: command structure to be initialized
8e8b77dd 2380 * @scsicmd: SCSI command to convert
b095518e
JG
2381 *
2382 * Handles either 12 or 16-byte versions of the CDB.
2383 *
2384 * RETURNS:
2385 * Zero on success, non-zero on failure.
2386 */
2387static unsigned int
00ac37f5 2388ata_scsi_pass_thru(struct ata_queued_cmd *qc, const u8 *scsicmd)
b095518e
JG
2389{
2390 struct ata_taskfile *tf = &(qc->tf);
2391 struct scsi_cmnd *cmd = qc->scsicmd;
2392
2393 if ((tf->protocol = ata_scsi_map_proto(scsicmd[1])) == ATA_PROT_UNKNOWN)
9a405257 2394 goto invalid_fld;
b095518e
JG
2395
2396 /*
2397 * 12 and 16 byte CDBs use different offsets to
2398 * provide the various register values.
2399 */
2400 if (scsicmd[0] == ATA_16) {
2401 /*
2402 * 16-byte CDB - may contain extended commands.
2403 *
2404 * If that is the case, copy the upper byte register values.
2405 */
2406 if (scsicmd[1] & 0x01) {
2407 tf->hob_feature = scsicmd[3];
2408 tf->hob_nsect = scsicmd[5];
2409 tf->hob_lbal = scsicmd[7];
2410 tf->hob_lbam = scsicmd[9];
2411 tf->hob_lbah = scsicmd[11];
2412 tf->flags |= ATA_TFLAG_LBA48;
2413 } else
2414 tf->flags &= ~ATA_TFLAG_LBA48;
2415
2416 /*
2417 * Always copy low byte, device and command registers.
2418 */
2419 tf->feature = scsicmd[4];
2420 tf->nsect = scsicmd[6];
2421 tf->lbal = scsicmd[8];
2422 tf->lbam = scsicmd[10];
2423 tf->lbah = scsicmd[12];
2424 tf->device = scsicmd[13];
2425 tf->command = scsicmd[14];
2426 } else {
2427 /*
2428 * 12-byte CDB - incapable of extended commands.
2429 */
2430 tf->flags &= ~ATA_TFLAG_LBA48;
2431
2432 tf->feature = scsicmd[3];
2433 tf->nsect = scsicmd[4];
2434 tf->lbal = scsicmd[5];
2435 tf->lbam = scsicmd[6];
2436 tf->lbah = scsicmd[7];
2437 tf->device = scsicmd[8];
2438 tf->command = scsicmd[9];
2439 }
dcc2d1e7
ML
2440 /*
2441 * If slave is possible, enforce correct master/slave bit
2442 */
2443 if (qc->ap->flags & ATA_FLAG_SLAVE_POSS)
2444 tf->device = qc->dev->devno ?
2445 tf->device | ATA_DEV1 : tf->device & ~ATA_DEV1;
b095518e
JG
2446
2447 /*
2448 * Filter SET_FEATURES - XFER MODE command -- otherwise,
2449 * SET_FEATURES - XFER MODE must be preceded/succeeded
2450 * by an update to hardware-specific registers for each
2451 * controller (i.e. the reason for ->set_piomode(),
2452 * ->set_dmamode(), and ->post_set_mode() hooks).
2453 */
2454 if ((tf->command == ATA_CMD_SET_FEATURES)
2455 && (tf->feature == SETFEATURES_XFER))
9a405257 2456 goto invalid_fld;
b095518e
JG
2457
2458 /*
2459 * Set flags so that all registers will be written,
2460 * and pass on write indication (used for PIO/DMA
2461 * setup.)
2462 */
2463 tf->flags |= (ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE);
2464
0274aa25 2465 if (cmd->sc_data_direction == DMA_TO_DEVICE)
b095518e
JG
2466 tf->flags |= ATA_TFLAG_WRITE;
2467
2468 /*
2469 * Set transfer length.
2470 *
2471 * TODO: find out if we need to do more here to
2472 * cover scatter/gather case.
2473 */
2474 qc->nsect = cmd->bufflen / ATA_SECT_SIZE;
2475
2476 return 0;
9a405257
TH
2477
2478 invalid_fld:
2479 ata_scsi_set_sense(qc->scsicmd, ILLEGAL_REQUEST, 0x24, 0x00);
2480 /* "Invalid field in cdb" */
2481 return 1;
b095518e
JG
2482}
2483
1da177e4
LT
2484/**
2485 * ata_get_xlat_func - check if SCSI to ATA translation is possible
2486 * @dev: ATA device
2487 * @cmd: SCSI command opcode to consider
2488 *
2489 * Look up the SCSI command given, and determine whether the
2490 * SCSI command is to be translated or simulated.
2491 *
2492 * RETURNS:
2493 * Pointer to translation function if possible, %NULL if not.
2494 */
2495
2496static inline ata_xlat_func_t ata_get_xlat_func(struct ata_device *dev, u8 cmd)
2497{
2498 switch (cmd) {
2499 case READ_6:
2500 case READ_10:
2501 case READ_16:
2502
2503 case WRITE_6:
2504 case WRITE_10:
2505 case WRITE_16:
2506 return ata_scsi_rw_xlat;
2507
2508 case SYNCHRONIZE_CACHE:
2509 if (ata_try_flush_cache(dev))
2510 return ata_scsi_flush_xlat;
2511 break;
2512
2513 case VERIFY:
2514 case VERIFY_16:
2515 return ata_scsi_verify_xlat;
b095518e
JG
2516
2517 case ATA_12:
2518 case ATA_16:
2519 return ata_scsi_pass_thru;
da61396d 2520
972dcafb
DG
2521 case START_STOP:
2522 return ata_scsi_start_stop_xlat;
1da177e4
LT
2523 }
2524
2525 return NULL;
2526}
2527
2528/**
2529 * ata_scsi_dump_cdb - dump SCSI command contents to dmesg
2530 * @ap: ATA port to which the command was being sent
2531 * @cmd: SCSI command to dump
2532 *
2533 * Prints the contents of a SCSI command via printk().
2534 */
2535
2536static inline void ata_scsi_dump_cdb(struct ata_port *ap,
2537 struct scsi_cmnd *cmd)
2538{
2539#ifdef ATA_DEBUG
2540 struct scsi_device *scsidev = cmd->device;
2541 u8 *scsicmd = cmd->cmnd;
2542
2543 DPRINTK("CDB (%u:%d,%d,%d) %02x %02x %02x %02x %02x %02x %02x %02x %02x\n",
2544 ap->id,
2545 scsidev->channel, scsidev->id, scsidev->lun,
2546 scsicmd[0], scsicmd[1], scsicmd[2], scsicmd[3],
2547 scsicmd[4], scsicmd[5], scsicmd[6], scsicmd[7],
2548 scsicmd[8]);
2549#endif
2550}
2551
2552/**
2553 * ata_scsi_queuecmd - Issue SCSI cdb to libata-managed device
2554 * @cmd: SCSI command to be sent
2555 * @done: Completion function, called when command is complete
2556 *
2557 * In some cases, this function translates SCSI commands into
2558 * ATA taskfiles, and queues the taskfiles to be sent to
2559 * hardware. In other cases, this function simulates a
2560 * SCSI device by evaluating and responding to certain
2561 * SCSI commands. This creates the overall effect of
2562 * ATA and ATAPI devices appearing as SCSI devices.
2563 *
2564 * LOCKING:
2565 * Releases scsi-layer-held lock, and obtains host_set lock.
2566 *
2567 * RETURNS:
2568 * Zero.
2569 */
2570
2571int ata_scsi_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *))
2572{
2573 struct ata_port *ap;
2574 struct ata_device *dev;
2575 struct scsi_device *scsidev = cmd->device;
005a5a06 2576 struct Scsi_Host *shost = scsidev->host;
1da177e4 2577
005a5a06
JG
2578 ap = (struct ata_port *) &shost->hostdata[0];
2579
2580 spin_unlock(shost->host_lock);
2581 spin_lock(&ap->host_set->lock);
1da177e4
LT
2582
2583 ata_scsi_dump_cdb(ap, cmd);
2584
2585 dev = ata_scsi_find_dev(ap, scsidev);
2586 if (unlikely(!dev)) {
2587 cmd->result = (DID_BAD_TARGET << 16);
2588 done(cmd);
2589 goto out_unlock;
2590 }
2591
2592 if (dev->class == ATA_DEV_ATA) {
2593 ata_xlat_func_t xlat_func = ata_get_xlat_func(dev,
2594 cmd->cmnd[0]);
2595
2596 if (xlat_func)
2597 ata_scsi_translate(ap, dev, cmd, done, xlat_func);
2598 else
9a3dccc4 2599 ata_scsi_simulate(ap, dev, cmd, done);
1da177e4
LT
2600 } else
2601 ata_scsi_translate(ap, dev, cmd, done, atapi_xlat);
2602
2603out_unlock:
005a5a06
JG
2604 spin_unlock(&ap->host_set->lock);
2605 spin_lock(shost->host_lock);
1da177e4
LT
2606 return 0;
2607}
2608
2609/**
2610 * ata_scsi_simulate - simulate SCSI command on ATA device
c893a3ae
RD
2611 * @ap: port the device is connected to
2612 * @dev: the target device
1da177e4
LT
2613 * @cmd: SCSI command being sent to device.
2614 * @done: SCSI command completion function.
2615 *
2616 * Interprets and directly executes a select list of SCSI commands
2617 * that can be handled internally.
2618 *
2619 * LOCKING:
2620 * spin_lock_irqsave(host_set lock)
2621 */
2622
9a3dccc4 2623void ata_scsi_simulate(struct ata_port *ap, struct ata_device *dev,
1da177e4
LT
2624 struct scsi_cmnd *cmd,
2625 void (*done)(struct scsi_cmnd *))
2626{
2627 struct ata_scsi_args args;
057ace5e 2628 const u8 *scsicmd = cmd->cmnd;
1da177e4 2629
9a3dccc4
TH
2630 args.ap = ap;
2631 args.dev = dev;
2632 args.id = dev->id;
1da177e4
LT
2633 args.cmd = cmd;
2634 args.done = done;
2635
2636 switch(scsicmd[0]) {
2637 /* no-op's, complete with success */
2638 case SYNCHRONIZE_CACHE:
2639 case REZERO_UNIT:
2640 case SEEK_6:
2641 case SEEK_10:
2642 case TEST_UNIT_READY:
2643 case FORMAT_UNIT: /* FIXME: correct? */
2644 case SEND_DIAGNOSTIC: /* FIXME: correct? */
2645 ata_scsi_rbuf_fill(&args, ata_scsiop_noop);
2646 break;
2647
2648 case INQUIRY:
2649 if (scsicmd[1] & 2) /* is CmdDt set? */
ae006510 2650 ata_scsi_invalid_field(cmd, done);
1da177e4
LT
2651 else if ((scsicmd[1] & 1) == 0) /* is EVPD clear? */
2652 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_std);
2653 else if (scsicmd[2] == 0x00)
2654 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_00);
2655 else if (scsicmd[2] == 0x80)
2656 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_80);
2657 else if (scsicmd[2] == 0x83)
2658 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_83);
2659 else
ae006510 2660 ata_scsi_invalid_field(cmd, done);
1da177e4
LT
2661 break;
2662
2663 case MODE_SENSE:
2664 case MODE_SENSE_10:
2665 ata_scsi_rbuf_fill(&args, ata_scsiop_mode_sense);
2666 break;
2667
2668 case MODE_SELECT: /* unconditionally return */
2669 case MODE_SELECT_10: /* bad-field-in-cdb */
ae006510 2670 ata_scsi_invalid_field(cmd, done);
1da177e4
LT
2671 break;
2672
2673 case READ_CAPACITY:
2674 ata_scsi_rbuf_fill(&args, ata_scsiop_read_cap);
2675 break;
2676
2677 case SERVICE_ACTION_IN:
2678 if ((scsicmd[1] & 0x1f) == SAI_READ_CAPACITY_16)
2679 ata_scsi_rbuf_fill(&args, ata_scsiop_read_cap);
2680 else
ae006510 2681 ata_scsi_invalid_field(cmd, done);
1da177e4
LT
2682 break;
2683
2684 case REPORT_LUNS:
2685 ata_scsi_rbuf_fill(&args, ata_scsiop_report_luns);
2686 break;
2687
b095518e 2688 /* mandatory commands we haven't implemented yet */
1da177e4
LT
2689 case REQUEST_SENSE:
2690
2691 /* all other commands */
2692 default:
ae006510
DG
2693 ata_scsi_set_sense(cmd, ILLEGAL_REQUEST, 0x20, 0x0);
2694 /* "Invalid command operation code" */
2695 done(cmd);
1da177e4
LT
2696 break;
2697 }
2698}
2699
644dd0cc
JG
2700void ata_scsi_scan_host(struct ata_port *ap)
2701{
3f19ee8c 2702 struct ata_device *dev;
644dd0cc
JG
2703 unsigned int i;
2704
2705 if (ap->flags & ATA_FLAG_PORT_DISABLED)
2706 return;
2707
3f19ee8c
JG
2708 for (i = 0; i < ATA_MAX_DEVICES; i++) {
2709 dev = &ap->device[i];
2710
2711 if (ata_dev_present(dev))
2712 scsi_scan_target(&ap->host->shost_gendev, 0, i, 0, 0);
2713 }
644dd0cc
JG
2714}
2715