[PATCH] libata: Add the useful macros/constants needed for merging PATA stuff
[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
a6cce2a7
BK
665static void ata_scsi_sdev_config(struct scsi_device *sdev)
666{
667 sdev->use_10_for_rw = 1;
668 sdev->use_10_for_ms = 1;
669}
670
671static void ata_scsi_dev_config(struct scsi_device *sdev,
672 struct ata_device *dev)
673{
674 unsigned int max_sectors;
675
676 /* TODO: 2048 is an arbitrary number, not the
677 * hardware maximum. This should be increased to
678 * 65534 when Jens Axboe's patch for dynamically
679 * determining max_sectors is merged.
680 */
681 max_sectors = ATA_MAX_SECTORS;
682 if (dev->flags & ATA_DFLAG_LBA48)
683 max_sectors = 2048;
684 if (dev->max_sectors)
685 max_sectors = dev->max_sectors;
686
687 blk_queue_max_sectors(sdev->request_queue, max_sectors);
688
689 /*
690 * SATA DMA transfers must be multiples of 4 byte, so
691 * we need to pad ATAPI transfers using an extra sg.
692 * Decrement max hw segments accordingly.
693 */
694 if (dev->class == ATA_DEV_ATAPI) {
695 request_queue_t *q = sdev->request_queue;
696 blk_queue_max_hw_segments(q, q->max_hw_segments - 1);
697 }
698}
699
1da177e4
LT
700/**
701 * ata_scsi_slave_config - Set SCSI device attributes
702 * @sdev: SCSI device to examine
703 *
704 * This is called before we actually start reading
705 * and writing to the device, to configure certain
706 * SCSI mid-layer behaviors.
707 *
708 * LOCKING:
709 * Defined by SCSI layer. We don't really care.
710 */
711
712int ata_scsi_slave_config(struct scsi_device *sdev)
713{
a6cce2a7 714 ata_scsi_sdev_config(sdev);
1da177e4
LT
715
716 blk_queue_max_phys_segments(sdev->request_queue, LIBATA_MAX_PRD);
717
718 if (sdev->id < ATA_MAX_DEVICES) {
719 struct ata_port *ap;
720 struct ata_device *dev;
721
722 ap = (struct ata_port *) &sdev->host->hostdata[0];
723 dev = &ap->device[sdev->id];
724
a6cce2a7 725 ata_scsi_dev_config(sdev, dev);
1da177e4
LT
726 }
727
728 return 0; /* scsi layer doesn't check return value, sigh */
729}
730
f29841e0
TH
731/**
732 * ata_scsi_timed_out - SCSI layer time out callback
733 * @cmd: timed out SCSI command
734 *
735 * Handles SCSI layer timeout. We race with normal completion of
736 * the qc for @cmd. If the qc is already gone, we lose and let
737 * the scsi command finish (EH_HANDLED). Otherwise, the qc has
738 * timed out and EH should be invoked. Prevent ata_qc_complete()
739 * from finishing it by setting EH_SCHEDULED and return
740 * EH_NOT_HANDLED.
741 *
742 * LOCKING:
743 * Called from timer context
744 *
745 * RETURNS:
746 * EH_HANDLED or EH_NOT_HANDLED
747 */
748enum scsi_eh_timer_return ata_scsi_timed_out(struct scsi_cmnd *cmd)
749{
750 struct Scsi_Host *host = cmd->device->host;
751 struct ata_port *ap = (struct ata_port *) &host->hostdata[0];
752 unsigned long flags;
753 struct ata_queued_cmd *qc;
754 enum scsi_eh_timer_return ret = EH_HANDLED;
755
756 DPRINTK("ENTER\n");
757
758 spin_lock_irqsave(&ap->host_set->lock, flags);
759 qc = ata_qc_from_tag(ap, ap->active_tag);
760 if (qc) {
a4631474 761 WARN_ON(qc->scsicmd != cmd);
f29841e0
TH
762 qc->flags |= ATA_QCFLAG_EH_SCHEDULED;
763 qc->err_mask |= AC_ERR_TIMEOUT;
764 ret = EH_NOT_HANDLED;
765 }
766 spin_unlock_irqrestore(&ap->host_set->lock, flags);
767
768 DPRINTK("EXIT, ret=%d\n", ret);
769 return ret;
770}
771
1da177e4
LT
772/**
773 * ata_scsi_error - SCSI layer error handler callback
774 * @host: SCSI host on which error occurred
775 *
776 * Handles SCSI-layer-thrown error events.
777 *
778 * LOCKING:
779 * Inherited from SCSI layer (none, can sleep)
780 *
781 * RETURNS:
782 * Zero.
783 */
784
785int ata_scsi_error(struct Scsi_Host *host)
786{
787 struct ata_port *ap;
5140788f 788 unsigned long flags;
1da177e4
LT
789
790 DPRINTK("ENTER\n");
791
5140788f
JG
792 ap = (struct ata_port *) &host->hostdata[0];
793
dde44589 794 spin_lock_irqsave(&ap->host_set->lock, flags);
a4631474 795 WARN_ON(ap->flags & ATA_FLAG_IN_EH);
dde44589 796 ap->flags |= ATA_FLAG_IN_EH;
a4631474 797 WARN_ON(ata_qc_from_tag(ap, ap->active_tag) == NULL);
dde44589
TH
798 spin_unlock_irqrestore(&ap->host_set->lock, flags);
799
86e45b6b
TH
800 ata_port_flush_task(ap);
801
1da177e4
LT
802 ap->ops->eng_timeout(ap);
803
a4631474 804 WARN_ON(host->host_failed || !list_empty(&host->eh_cmd_q));
a72ec4ce
TH
805
806 scsi_eh_flush_done_q(&ap->eh_done_q);
1da177e4 807
dde44589
TH
808 spin_lock_irqsave(&ap->host_set->lock, flags);
809 ap->flags &= ~ATA_FLAG_IN_EH;
810 spin_unlock_irqrestore(&ap->host_set->lock, flags);
811
1da177e4
LT
812 DPRINTK("EXIT\n");
813 return 0;
814}
815
a72ec4ce
TH
816static void ata_eh_scsidone(struct scsi_cmnd *scmd)
817{
818 /* nada */
819}
820
821static void __ata_eh_qc_complete(struct ata_queued_cmd *qc)
822{
823 struct ata_port *ap = qc->ap;
824 struct scsi_cmnd *scmd = qc->scsicmd;
825 unsigned long flags;
826
827 spin_lock_irqsave(&ap->host_set->lock, flags);
828 qc->scsidone = ata_eh_scsidone;
341963b9 829 __ata_qc_complete(qc);
a4631474 830 WARN_ON(ata_tag_valid(qc->tag));
a72ec4ce
TH
831 spin_unlock_irqrestore(&ap->host_set->lock, flags);
832
833 scsi_eh_finish_cmd(scmd, &ap->eh_done_q);
834}
835
836/**
837 * ata_eh_qc_complete - Complete an active ATA command from EH
838 * @qc: Command to complete
839 *
840 * Indicate to the mid and upper layers that an ATA command has
841 * completed. To be used from EH.
842 */
843void ata_eh_qc_complete(struct ata_queued_cmd *qc)
844{
845 struct scsi_cmnd *scmd = qc->scsicmd;
846 scmd->retries = scmd->allowed;
847 __ata_eh_qc_complete(qc);
848}
849
850/**
851 * ata_eh_qc_retry - Tell midlayer to retry an ATA command after EH
852 * @qc: Command to retry
853 *
854 * Indicate to the mid and upper layers that an ATA command
855 * should be retried. To be used from EH.
856 *
857 * SCSI midlayer limits the number of retries to scmd->allowed.
858 * This function might need to adjust scmd->retries for commands
859 * which get retried due to unrelated NCQ failures.
860 */
861void ata_eh_qc_retry(struct ata_queued_cmd *qc)
862{
863 __ata_eh_qc_complete(qc);
864}
865
972dcafb
DG
866/**
867 * ata_scsi_start_stop_xlat - Translate SCSI START STOP UNIT command
868 * @qc: Storage for translated ATA taskfile
869 * @scsicmd: SCSI command to translate
870 *
871 * Sets up an ATA taskfile to issue STANDBY (to stop) or READ VERIFY
872 * (to start). Perhaps these commands should be preceded by
873 * CHECK POWER MODE to see what power mode the device is already in.
874 * [See SAT revision 5 at www.t10.org]
875 *
876 * LOCKING:
877 * spin_lock_irqsave(host_set lock)
878 *
879 * RETURNS:
880 * Zero on success, non-zero on error.
881 */
882
883static unsigned int ata_scsi_start_stop_xlat(struct ata_queued_cmd *qc,
057ace5e 884 const u8 *scsicmd)
972dcafb
DG
885{
886 struct ata_taskfile *tf = &qc->tf;
887
888 tf->flags |= ATA_TFLAG_DEVICE | ATA_TFLAG_ISADDR;
889 tf->protocol = ATA_PROT_NODATA;
890 if (scsicmd[1] & 0x1) {
891 ; /* ignore IMMED bit, violates sat-r05 */
892 }
893 if (scsicmd[4] & 0x2)
ae006510 894 goto invalid_fld; /* LOEJ bit set not supported */
972dcafb 895 if (((scsicmd[4] >> 4) & 0xf) != 0)
ae006510 896 goto invalid_fld; /* power conditions not supported */
972dcafb
DG
897 if (scsicmd[4] & 0x1) {
898 tf->nsect = 1; /* 1 sector, lba=0 */
9d5b1302
AL
899
900 if (qc->dev->flags & ATA_DFLAG_LBA) {
901 qc->tf.flags |= ATA_TFLAG_LBA;
902
903 tf->lbah = 0x0;
904 tf->lbam = 0x0;
905 tf->lbal = 0x0;
906 tf->device |= ATA_LBA;
907 } else {
908 /* CHS */
909 tf->lbal = 0x1; /* sect */
910 tf->lbam = 0x0; /* cyl low */
911 tf->lbah = 0x0; /* cyl high */
912 }
913
972dcafb
DG
914 tf->command = ATA_CMD_VERIFY; /* READ VERIFY */
915 } else {
916 tf->nsect = 0; /* time period value (0 implies now) */
917 tf->command = ATA_CMD_STANDBY;
918 /* Consider: ATA STANDBY IMMEDIATE command */
919 }
920 /*
921 * Standby and Idle condition timers could be implemented but that
922 * would require libata to implement the Power condition mode page
923 * and allow the user to change it. Changing mode pages requires
924 * MODE SELECT to be implemented.
925 */
926
927 return 0;
ae006510
DG
928
929invalid_fld:
930 ata_scsi_set_sense(qc->scsicmd, ILLEGAL_REQUEST, 0x24, 0x0);
931 /* "Invalid field in cbd" */
932 return 1;
972dcafb
DG
933}
934
935
1da177e4
LT
936/**
937 * ata_scsi_flush_xlat - Translate SCSI SYNCHRONIZE CACHE command
938 * @qc: Storage for translated ATA taskfile
939 * @scsicmd: SCSI command to translate (ignored)
940 *
941 * Sets up an ATA taskfile to issue FLUSH CACHE or
942 * FLUSH CACHE EXT.
943 *
944 * LOCKING:
945 * spin_lock_irqsave(host_set lock)
946 *
947 * RETURNS:
948 * Zero on success, non-zero on error.
949 */
950
057ace5e 951static unsigned int ata_scsi_flush_xlat(struct ata_queued_cmd *qc, const u8 *scsicmd)
1da177e4
LT
952{
953 struct ata_taskfile *tf = &qc->tf;
954
955 tf->flags |= ATA_TFLAG_DEVICE;
956 tf->protocol = ATA_PROT_NODATA;
957
07506697 958 if ((qc->dev->flags & ATA_DFLAG_LBA48) &&
1da177e4
LT
959 (ata_id_has_flush_ext(qc->dev->id)))
960 tf->command = ATA_CMD_FLUSH_EXT;
961 else
962 tf->command = ATA_CMD_FLUSH;
963
964 return 0;
965}
966
3aef5231
AL
967/**
968 * scsi_6_lba_len - Get LBA and transfer length
969 * @scsicmd: SCSI command to translate
970 *
971 * Calculate LBA and transfer length for 6-byte commands.
972 *
973 * RETURNS:
974 * @plba: the LBA
975 * @plen: the transfer length
976 */
977
057ace5e 978static void scsi_6_lba_len(const u8 *scsicmd, u64 *plba, u32 *plen)
3aef5231
AL
979{
980 u64 lba = 0;
981 u32 len = 0;
982
983 VPRINTK("six-byte command\n");
984
985 lba |= ((u64)scsicmd[2]) << 8;
986 lba |= ((u64)scsicmd[3]);
987
988 len |= ((u32)scsicmd[4]);
989
990 *plba = lba;
991 *plen = len;
992}
993
994/**
995 * scsi_10_lba_len - Get LBA and transfer length
996 * @scsicmd: SCSI command to translate
997 *
998 * Calculate LBA and transfer length for 10-byte commands.
999 *
1000 * RETURNS:
1001 * @plba: the LBA
1002 * @plen: the transfer length
1003 */
1004
057ace5e 1005static void scsi_10_lba_len(const u8 *scsicmd, u64 *plba, u32 *plen)
3aef5231
AL
1006{
1007 u64 lba = 0;
1008 u32 len = 0;
1009
1010 VPRINTK("ten-byte command\n");
1011
1012 lba |= ((u64)scsicmd[2]) << 24;
1013 lba |= ((u64)scsicmd[3]) << 16;
1014 lba |= ((u64)scsicmd[4]) << 8;
1015 lba |= ((u64)scsicmd[5]);
1016
1017 len |= ((u32)scsicmd[7]) << 8;
1018 len |= ((u32)scsicmd[8]);
1019
1020 *plba = lba;
1021 *plen = len;
1022}
1023
1024/**
1025 * scsi_16_lba_len - Get LBA and transfer length
1026 * @scsicmd: SCSI command to translate
1027 *
1028 * Calculate LBA and transfer length for 16-byte commands.
1029 *
1030 * RETURNS:
1031 * @plba: the LBA
1032 * @plen: the transfer length
1033 */
1034
057ace5e 1035static void scsi_16_lba_len(const u8 *scsicmd, u64 *plba, u32 *plen)
3aef5231
AL
1036{
1037 u64 lba = 0;
1038 u32 len = 0;
1039
1040 VPRINTK("sixteen-byte command\n");
1041
1042 lba |= ((u64)scsicmd[2]) << 56;
1043 lba |= ((u64)scsicmd[3]) << 48;
1044 lba |= ((u64)scsicmd[4]) << 40;
1045 lba |= ((u64)scsicmd[5]) << 32;
1046 lba |= ((u64)scsicmd[6]) << 24;
1047 lba |= ((u64)scsicmd[7]) << 16;
1048 lba |= ((u64)scsicmd[8]) << 8;
1049 lba |= ((u64)scsicmd[9]);
1050
1051 len |= ((u32)scsicmd[10]) << 24;
1052 len |= ((u32)scsicmd[11]) << 16;
1053 len |= ((u32)scsicmd[12]) << 8;
1054 len |= ((u32)scsicmd[13]);
1055
1056 *plba = lba;
1057 *plen = len;
1058}
1059
1da177e4
LT
1060/**
1061 * ata_scsi_verify_xlat - Translate SCSI VERIFY command into an ATA one
1062 * @qc: Storage for translated ATA taskfile
1063 * @scsicmd: SCSI command to translate
1064 *
1065 * Converts SCSI VERIFY command to an ATA READ VERIFY command.
1066 *
1067 * LOCKING:
1068 * spin_lock_irqsave(host_set lock)
1069 *
1070 * RETURNS:
1071 * Zero on success, non-zero on error.
1072 */
1073
057ace5e 1074static unsigned int ata_scsi_verify_xlat(struct ata_queued_cmd *qc, const u8 *scsicmd)
1da177e4
LT
1075{
1076 struct ata_taskfile *tf = &qc->tf;
8bf62ece 1077 struct ata_device *dev = qc->dev;
1da177e4 1078 u64 dev_sectors = qc->dev->n_sectors;
3aef5231
AL
1079 u64 block;
1080 u32 n_block;
1da177e4
LT
1081
1082 tf->flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
1083 tf->protocol = ATA_PROT_NODATA;
1da177e4 1084
3aef5231
AL
1085 if (scsicmd[0] == VERIFY)
1086 scsi_10_lba_len(scsicmd, &block, &n_block);
1087 else if (scsicmd[0] == VERIFY_16)
1088 scsi_16_lba_len(scsicmd, &block, &n_block);
1da177e4 1089 else
ae006510 1090 goto invalid_fld;
1da177e4 1091
8bf62ece 1092 if (!n_block)
ae006510 1093 goto nothing_to_do;
8bf62ece 1094 if (block >= dev_sectors)
ae006510 1095 goto out_of_range;
8bf62ece 1096 if ((block + n_block) > dev_sectors)
ae006510 1097 goto out_of_range;
1da177e4 1098
07506697
AL
1099 if (dev->flags & ATA_DFLAG_LBA) {
1100 tf->flags |= ATA_TFLAG_LBA;
1101
c6a33e24
AL
1102 if (lba_28_ok(block, n_block)) {
1103 /* use LBA28 */
1104 tf->command = ATA_CMD_VERIFY;
1105 tf->device |= (block >> 24) & 0xf;
1106 } else if (lba_48_ok(block, n_block)) {
1107 if (!(dev->flags & ATA_DFLAG_LBA48))
1108 goto out_of_range;
07506697
AL
1109
1110 /* use LBA48 */
1111 tf->flags |= ATA_TFLAG_LBA48;
8bf62ece 1112 tf->command = ATA_CMD_VERIFY_EXT;
1da177e4 1113
8bf62ece 1114 tf->hob_nsect = (n_block >> 8) & 0xff;
1da177e4 1115
8bf62ece
AL
1116 tf->hob_lbah = (block >> 40) & 0xff;
1117 tf->hob_lbam = (block >> 32) & 0xff;
1118 tf->hob_lbal = (block >> 24) & 0xff;
c6a33e24
AL
1119 } else
1120 /* request too large even for LBA48 */
1121 goto out_of_range;
8bf62ece
AL
1122
1123 tf->nsect = n_block & 0xff;
1da177e4 1124
8bf62ece
AL
1125 tf->lbah = (block >> 16) & 0xff;
1126 tf->lbam = (block >> 8) & 0xff;
1127 tf->lbal = block & 0xff;
1da177e4 1128
8bf62ece
AL
1129 tf->device |= ATA_LBA;
1130 } else {
1131 /* CHS */
1132 u32 sect, head, cyl, track;
1133
c6a33e24
AL
1134 if (!lba_28_ok(block, n_block))
1135 goto out_of_range;
07506697 1136
8bf62ece
AL
1137 /* Convert LBA to CHS */
1138 track = (u32)block / dev->sectors;
1139 cyl = track / dev->heads;
1140 head = track % dev->heads;
1141 sect = (u32)block % dev->sectors + 1;
1142
c187c4b5
AL
1143 DPRINTK("block %u track %u cyl %u head %u sect %u\n",
1144 (u32)block, track, cyl, head, sect);
8bf62ece
AL
1145
1146 /* Check whether the converted CHS can fit.
1147 Cylinder: 0-65535
1148 Head: 0-15
1149 Sector: 1-255*/
1150 if ((cyl >> 16) || (head >> 4) || (sect >> 8) || (!sect))
ae006510 1151 goto out_of_range;
8bf62ece
AL
1152
1153 tf->command = ATA_CMD_VERIFY;
1154 tf->nsect = n_block & 0xff; /* Sector count 0 means 256 sectors */
1155 tf->lbal = sect;
1156 tf->lbam = cyl;
1157 tf->lbah = cyl >> 8;
1158 tf->device |= head;
1159 }
1da177e4
LT
1160
1161 return 0;
ae006510
DG
1162
1163invalid_fld:
1164 ata_scsi_set_sense(qc->scsicmd, ILLEGAL_REQUEST, 0x24, 0x0);
1165 /* "Invalid field in cbd" */
1166 return 1;
1167
1168out_of_range:
1169 ata_scsi_set_sense(qc->scsicmd, ILLEGAL_REQUEST, 0x21, 0x0);
1170 /* "Logical Block Address out of range" */
1171 return 1;
1172
1173nothing_to_do:
1174 qc->scsicmd->result = SAM_STAT_GOOD;
1175 return 1;
1da177e4
LT
1176}
1177
1178/**
1179 * ata_scsi_rw_xlat - Translate SCSI r/w command into an ATA one
1180 * @qc: Storage for translated ATA taskfile
1181 * @scsicmd: SCSI command to translate
1182 *
1183 * Converts any of six SCSI read/write commands into the
1184 * ATA counterpart, including starting sector (LBA),
1185 * sector count, and taking into account the device's LBA48
1186 * support.
1187 *
1188 * Commands %READ_6, %READ_10, %READ_16, %WRITE_6, %WRITE_10, and
1189 * %WRITE_16 are currently supported.
1190 *
1191 * LOCKING:
1192 * spin_lock_irqsave(host_set lock)
1193 *
1194 * RETURNS:
1195 * Zero on success, non-zero on error.
1196 */
1197
057ace5e 1198static unsigned int ata_scsi_rw_xlat(struct ata_queued_cmd *qc, const u8 *scsicmd)
1da177e4
LT
1199{
1200 struct ata_taskfile *tf = &qc->tf;
8bf62ece 1201 struct ata_device *dev = qc->dev;
3aef5231
AL
1202 u64 block;
1203 u32 n_block;
1da177e4
LT
1204
1205 tf->flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
1da177e4 1206
8cbd6df1
AL
1207 if (scsicmd[0] == WRITE_10 || scsicmd[0] == WRITE_6 ||
1208 scsicmd[0] == WRITE_16)
1da177e4 1209 tf->flags |= ATA_TFLAG_WRITE;
1da177e4 1210
9a3dccc4 1211 /* Calculate the SCSI LBA, transfer length and FUA. */
3aef5231
AL
1212 switch (scsicmd[0]) {
1213 case READ_10:
1214 case WRITE_10:
1215 scsi_10_lba_len(scsicmd, &block, &n_block);
9a3dccc4
TH
1216 if (unlikely(scsicmd[1] & (1 << 3)))
1217 tf->flags |= ATA_TFLAG_FUA;
3aef5231
AL
1218 break;
1219 case READ_6:
1220 case WRITE_6:
1221 scsi_6_lba_len(scsicmd, &block, &n_block);
c187c4b5
AL
1222
1223 /* for 6-byte r/w commands, transfer length 0
1224 * means 256 blocks of data, not 0 block.
1225 */
76b2bf9b
JG
1226 if (!n_block)
1227 n_block = 256;
3aef5231
AL
1228 break;
1229 case READ_16:
1230 case WRITE_16:
1231 scsi_16_lba_len(scsicmd, &block, &n_block);
9a3dccc4
TH
1232 if (unlikely(scsicmd[1] & (1 << 3)))
1233 tf->flags |= ATA_TFLAG_FUA;
3aef5231
AL
1234 break;
1235 default:
8bf62ece 1236 DPRINTK("no-byte command\n");
ae006510 1237 goto invalid_fld;
1da177e4
LT
1238 }
1239
8bf62ece
AL
1240 /* Check and compose ATA command */
1241 if (!n_block)
c187c4b5
AL
1242 /* For 10-byte and 16-byte SCSI R/W commands, transfer
1243 * length 0 means transfer 0 block of data.
1244 * However, for ATA R/W commands, sector count 0 means
1245 * 256 or 65536 sectors, not 0 sectors as in SCSI.
f51750d5
AC
1246 *
1247 * WARNING: one or two older ATA drives treat 0 as 0...
c187c4b5 1248 */
ae006510 1249 goto nothing_to_do;
1da177e4 1250
07506697
AL
1251 if (dev->flags & ATA_DFLAG_LBA) {
1252 tf->flags |= ATA_TFLAG_LBA;
1253
c6a33e24
AL
1254 if (lba_28_ok(block, n_block)) {
1255 /* use LBA28 */
1256 tf->device |= (block >> 24) & 0xf;
1257 } else if (lba_48_ok(block, n_block)) {
1258 if (!(dev->flags & ATA_DFLAG_LBA48))
ae006510 1259 goto out_of_range;
1da177e4 1260
07506697
AL
1261 /* use LBA48 */
1262 tf->flags |= ATA_TFLAG_LBA48;
1263
8bf62ece
AL
1264 tf->hob_nsect = (n_block >> 8) & 0xff;
1265
1266 tf->hob_lbah = (block >> 40) & 0xff;
1267 tf->hob_lbam = (block >> 32) & 0xff;
1268 tf->hob_lbal = (block >> 24) & 0xff;
c6a33e24
AL
1269 } else
1270 /* request too large even for LBA48 */
1271 goto out_of_range;
c187c4b5 1272
9a3dccc4
TH
1273 if (unlikely(ata_rwcmd_protocol(qc) < 0))
1274 goto invalid_fld;
8cbd6df1 1275
8bf62ece
AL
1276 qc->nsect = n_block;
1277 tf->nsect = n_block & 0xff;
1da177e4 1278
8bf62ece
AL
1279 tf->lbah = (block >> 16) & 0xff;
1280 tf->lbam = (block >> 8) & 0xff;
1281 tf->lbal = block & 0xff;
1da177e4 1282
8bf62ece
AL
1283 tf->device |= ATA_LBA;
1284 } else {
1285 /* CHS */
1286 u32 sect, head, cyl, track;
1287
1288 /* The request -may- be too large for CHS addressing. */
c6a33e24 1289 if (!lba_28_ok(block, n_block))
ae006510 1290 goto out_of_range;
c187c4b5 1291
9a3dccc4
TH
1292 if (unlikely(ata_rwcmd_protocol(qc) < 0))
1293 goto invalid_fld;
8cbd6df1 1294
8bf62ece
AL
1295 /* Convert LBA to CHS */
1296 track = (u32)block / dev->sectors;
1297 cyl = track / dev->heads;
1298 head = track % dev->heads;
1299 sect = (u32)block % dev->sectors + 1;
1300
c187c4b5 1301 DPRINTK("block %u track %u cyl %u head %u sect %u\n",
8bf62ece 1302 (u32)block, track, cyl, head, sect);
c187c4b5 1303
8bf62ece
AL
1304 /* Check whether the converted CHS can fit.
1305 Cylinder: 0-65535
1306 Head: 0-15
1307 Sector: 1-255*/
c187c4b5 1308 if ((cyl >> 16) || (head >> 4) || (sect >> 8) || (!sect))
ae006510 1309 goto out_of_range;
c187c4b5 1310
8bf62ece
AL
1311 qc->nsect = n_block;
1312 tf->nsect = n_block & 0xff; /* Sector count 0 means 256 sectors */
1313 tf->lbal = sect;
1314 tf->lbam = cyl;
1315 tf->lbah = cyl >> 8;
1316 tf->device |= head;
1da177e4
LT
1317 }
1318
8bf62ece 1319 return 0;
ae006510
DG
1320
1321invalid_fld:
1322 ata_scsi_set_sense(qc->scsicmd, ILLEGAL_REQUEST, 0x24, 0x0);
1323 /* "Invalid field in cbd" */
1324 return 1;
1325
1326out_of_range:
1327 ata_scsi_set_sense(qc->scsicmd, ILLEGAL_REQUEST, 0x21, 0x0);
1328 /* "Logical Block Address out of range" */
1329 return 1;
1330
1331nothing_to_do:
1332 qc->scsicmd->result = SAM_STAT_GOOD;
1333 return 1;
1da177e4
LT
1334}
1335
77853bf2 1336static void ata_scsi_qc_complete(struct ata_queued_cmd *qc)
1da177e4
LT
1337{
1338 struct scsi_cmnd *cmd = qc->scsicmd;
a7dac447 1339 u8 *cdb = cmd->cmnd;
a22e2eb0 1340 int need_sense = (qc->err_mask != 0);
b095518e
JG
1341
1342 /* For ATA pass thru (SAT) commands, generate a sense block if
1343 * user mandated it or if there's an error. Note that if we
1344 * generate because the user forced us to, a check condition
1345 * is generated and the ATA register values are returned
1346 * whether the command completed successfully or not. If there
1347 * was no error, SK, ASC and ASCQ will all be zero.
1348 */
a7dac447
JG
1349 if (((cdb[0] == ATA_16) || (cdb[0] == ATA_12)) &&
1350 ((cdb[2] & 0x20) || need_sense)) {
b095518e
JG
1351 ata_gen_ata_desc_sense(qc);
1352 } else {
1353 if (!need_sense) {
1354 cmd->result = SAM_STAT_GOOD;
1355 } else {
1356 /* TODO: decide which descriptor format to use
1357 * for 48b LBA devices and call that here
1358 * instead of the fixed desc, which is only
1359 * good for smaller LBA (and maybe CHS?)
1360 * devices.
1361 */
1362 ata_gen_fixed_sense(qc);
1363 }
1364 }
1da177e4 1365
b095518e
JG
1366 if (need_sense) {
1367 /* The ata_gen_..._sense routines fill in tf */
1368 ata_dump_status(qc->ap->id, &qc->tf);
1369 }
1da177e4
LT
1370
1371 qc->scsidone(cmd);
1372
77853bf2 1373 ata_qc_free(qc);
1da177e4
LT
1374}
1375
1376/**
1377 * ata_scsi_translate - Translate then issue SCSI command to ATA device
1378 * @ap: ATA port to which the command is addressed
1379 * @dev: ATA device to which the command is addressed
1380 * @cmd: SCSI command to execute
1381 * @done: SCSI command completion function
1382 * @xlat_func: Actor which translates @cmd to an ATA taskfile
1383 *
1384 * Our ->queuecommand() function has decided that the SCSI
1385 * command issued can be directly translated into an ATA
1386 * command, rather than handled internally.
1387 *
1388 * This function sets up an ata_queued_cmd structure for the
1389 * SCSI command, and sends that ata_queued_cmd to the hardware.
1390 *
ae006510
DG
1391 * The xlat_func argument (actor) returns 0 if ready to execute
1392 * ATA command, else 1 to finish translation. If 1 is returned
1393 * then cmd->result (and possibly cmd->sense_buffer) are assumed
1394 * to be set reflecting an error condition or clean (early)
1395 * termination.
1396 *
1da177e4
LT
1397 * LOCKING:
1398 * spin_lock_irqsave(host_set lock)
1399 */
1400
1401static void ata_scsi_translate(struct ata_port *ap, struct ata_device *dev,
1402 struct scsi_cmnd *cmd,
1403 void (*done)(struct scsi_cmnd *),
1404 ata_xlat_func_t xlat_func)
1405{
1406 struct ata_queued_cmd *qc;
1407 u8 *scsicmd = cmd->cmnd;
1408
1409 VPRINTK("ENTER\n");
1410
1411 qc = ata_scsi_qc_new(ap, dev, cmd, done);
1412 if (!qc)
ae006510 1413 goto err_mem;
1da177e4
LT
1414
1415 /* data is present; dma-map it */
be7db055
CH
1416 if (cmd->sc_data_direction == DMA_FROM_DEVICE ||
1417 cmd->sc_data_direction == DMA_TO_DEVICE) {
1da177e4
LT
1418 if (unlikely(cmd->request_bufflen < 1)) {
1419 printk(KERN_WARNING "ata%u(%u): WARNING: zero len r/w req\n",
1420 ap->id, dev->devno);
ae006510 1421 goto err_did;
1da177e4
LT
1422 }
1423
1424 if (cmd->use_sg)
1425 ata_sg_init(qc, cmd->request_buffer, cmd->use_sg);
1426 else
1427 ata_sg_init_one(qc, cmd->request_buffer,
1428 cmd->request_bufflen);
1429
1430 qc->dma_dir = cmd->sc_data_direction;
1431 }
1432
1433 qc->complete_fn = ata_scsi_qc_complete;
1434
1435 if (xlat_func(qc, scsicmd))
ae006510 1436 goto early_finish;
1da177e4
LT
1437
1438 /* select device, send command to hardware */
9a3d9eb0
TH
1439 qc->err_mask = ata_qc_issue(qc);
1440 if (qc->err_mask)
8e436af9 1441 ata_qc_complete(qc);
1da177e4
LT
1442
1443 VPRINTK("EXIT\n");
1444 return;
1445
ae006510
DG
1446early_finish:
1447 ata_qc_free(qc);
1448 done(cmd);
1449 DPRINTK("EXIT - early finish (good or error)\n");
1450 return;
1451
1452err_did:
1da177e4 1453 ata_qc_free(qc);
ae006510
DG
1454err_mem:
1455 cmd->result = (DID_ERROR << 16);
1456 done(cmd);
1457 DPRINTK("EXIT - internal\n");
1458 return;
1da177e4
LT
1459}
1460
1461/**
1462 * ata_scsi_rbuf_get - Map response buffer.
1463 * @cmd: SCSI command containing buffer to be mapped.
1464 * @buf_out: Pointer to mapped area.
1465 *
1466 * Maps buffer contained within SCSI command @cmd.
1467 *
1468 * LOCKING:
1469 * spin_lock_irqsave(host_set lock)
1470 *
1471 * RETURNS:
1472 * Length of response buffer.
1473 */
1474
1475static unsigned int ata_scsi_rbuf_get(struct scsi_cmnd *cmd, u8 **buf_out)
1476{
1477 u8 *buf;
1478 unsigned int buflen;
1479
1480 if (cmd->use_sg) {
1481 struct scatterlist *sg;
1482
1483 sg = (struct scatterlist *) cmd->request_buffer;
1484 buf = kmap_atomic(sg->page, KM_USER0) + sg->offset;
1485 buflen = sg->length;
1486 } else {
1487 buf = cmd->request_buffer;
1488 buflen = cmd->request_bufflen;
1489 }
1490
1491 *buf_out = buf;
1492 return buflen;
1493}
1494
1495/**
1496 * ata_scsi_rbuf_put - Unmap response buffer.
1497 * @cmd: SCSI command containing buffer to be unmapped.
1498 * @buf: buffer to unmap
1499 *
1500 * Unmaps response buffer contained within @cmd.
1501 *
1502 * LOCKING:
1503 * spin_lock_irqsave(host_set lock)
1504 */
1505
1506static inline void ata_scsi_rbuf_put(struct scsi_cmnd *cmd, u8 *buf)
1507{
1508 if (cmd->use_sg) {
1509 struct scatterlist *sg;
1510
1511 sg = (struct scatterlist *) cmd->request_buffer;
1512 kunmap_atomic(buf - sg->offset, KM_USER0);
1513 }
1514}
1515
1516/**
1517 * ata_scsi_rbuf_fill - wrapper for SCSI command simulators
1518 * @args: device IDENTIFY data / SCSI command of interest.
1519 * @actor: Callback hook for desired SCSI command simulator
1520 *
1521 * Takes care of the hard work of simulating a SCSI command...
1522 * Mapping the response buffer, calling the command's handler,
1523 * and handling the handler's return value. This return value
1524 * indicates whether the handler wishes the SCSI command to be
ae006510
DG
1525 * completed successfully (0), or not (in which case cmd->result
1526 * and sense buffer are assumed to be set).
1da177e4
LT
1527 *
1528 * LOCKING:
1529 * spin_lock_irqsave(host_set lock)
1530 */
1531
1532void ata_scsi_rbuf_fill(struct ata_scsi_args *args,
1533 unsigned int (*actor) (struct ata_scsi_args *args,
1534 u8 *rbuf, unsigned int buflen))
1535{
1536 u8 *rbuf;
1537 unsigned int buflen, rc;
1538 struct scsi_cmnd *cmd = args->cmd;
1539
1540 buflen = ata_scsi_rbuf_get(cmd, &rbuf);
1541 memset(rbuf, 0, buflen);
1542 rc = actor(args, rbuf, buflen);
1543 ata_scsi_rbuf_put(cmd, rbuf);
1544
ae006510 1545 if (rc == 0)
1da177e4 1546 cmd->result = SAM_STAT_GOOD;
ae006510 1547 args->done(cmd);
1da177e4
LT
1548}
1549
1550/**
1551 * ata_scsiop_inq_std - Simulate INQUIRY command
1552 * @args: device IDENTIFY data / SCSI command of interest.
1553 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1554 * @buflen: Response buffer length.
1555 *
1556 * Returns standard device identification data associated
b142eb65 1557 * with non-VPD INQUIRY command output.
1da177e4
LT
1558 *
1559 * LOCKING:
1560 * spin_lock_irqsave(host_set lock)
1561 */
1562
1563unsigned int ata_scsiop_inq_std(struct ata_scsi_args *args, u8 *rbuf,
1564 unsigned int buflen)
1565{
1566 u8 hdr[] = {
1567 TYPE_DISK,
1568 0,
1569 0x5, /* claim SPC-3 version compatibility */
1570 2,
1571 95 - 4
1572 };
1573
1574 /* set scsi removeable (RMB) bit per ata bit */
1575 if (ata_id_removeable(args->id))
1576 hdr[1] |= (1 << 7);
1577
1578 VPRINTK("ENTER\n");
1579
1580 memcpy(rbuf, hdr, sizeof(hdr));
1581
1582 if (buflen > 35) {
1583 memcpy(&rbuf[8], "ATA ", 8);
6a62a04d
TH
1584 ata_id_string(args->id, &rbuf[16], ATA_ID_PROD_OFS, 16);
1585 ata_id_string(args->id, &rbuf[32], ATA_ID_FW_REV_OFS, 4);
1da177e4
LT
1586 if (rbuf[32] == 0 || rbuf[32] == ' ')
1587 memcpy(&rbuf[32], "n/a ", 4);
1588 }
1589
1590 if (buflen > 63) {
1591 const u8 versions[] = {
1592 0x60, /* SAM-3 (no version claimed) */
1593
1594 0x03,
1595 0x20, /* SBC-2 (no version claimed) */
1596
1597 0x02,
1598 0x60 /* SPC-3 (no version claimed) */
1599 };
1600
1601 memcpy(rbuf + 59, versions, sizeof(versions));
1602 }
1603
1604 return 0;
1605}
1606
1607/**
b142eb65 1608 * ata_scsiop_inq_00 - Simulate INQUIRY VPD page 0, list of pages
1da177e4
LT
1609 * @args: device IDENTIFY data / SCSI command of interest.
1610 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1611 * @buflen: Response buffer length.
1612 *
b142eb65 1613 * Returns list of inquiry VPD pages available.
1da177e4
LT
1614 *
1615 * LOCKING:
1616 * spin_lock_irqsave(host_set lock)
1617 */
1618
1619unsigned int ata_scsiop_inq_00(struct ata_scsi_args *args, u8 *rbuf,
1620 unsigned int buflen)
1621{
1622 const u8 pages[] = {
1623 0x00, /* page 0x00, this page */
1624 0x80, /* page 0x80, unit serial no page */
1625 0x83 /* page 0x83, device ident page */
1626 };
b142eb65 1627 rbuf[3] = sizeof(pages); /* number of supported VPD pages */
1da177e4
LT
1628
1629 if (buflen > 6)
1630 memcpy(rbuf + 4, pages, sizeof(pages));
1631
1632 return 0;
1633}
1634
1635/**
b142eb65 1636 * ata_scsiop_inq_80 - Simulate INQUIRY VPD page 80, device serial number
1da177e4
LT
1637 * @args: device IDENTIFY data / SCSI command of interest.
1638 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1639 * @buflen: Response buffer length.
1640 *
1641 * Returns ATA device serial number.
1642 *
1643 * LOCKING:
1644 * spin_lock_irqsave(host_set lock)
1645 */
1646
1647unsigned int ata_scsiop_inq_80(struct ata_scsi_args *args, u8 *rbuf,
1648 unsigned int buflen)
1649{
1650 const u8 hdr[] = {
1651 0,
1652 0x80, /* this page code */
1653 0,
1654 ATA_SERNO_LEN, /* page len */
1655 };
1656 memcpy(rbuf, hdr, sizeof(hdr));
1657
1658 if (buflen > (ATA_SERNO_LEN + 4 - 1))
6a62a04d
TH
1659 ata_id_string(args->id, (unsigned char *) &rbuf[4],
1660 ATA_ID_SERNO_OFS, ATA_SERNO_LEN);
1da177e4
LT
1661
1662 return 0;
1663}
1664
1da177e4 1665/**
b142eb65 1666 * ata_scsiop_inq_83 - Simulate INQUIRY VPD page 83, device identity
1da177e4
LT
1667 * @args: device IDENTIFY data / SCSI command of interest.
1668 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1669 * @buflen: Response buffer length.
1670 *
b142eb65
JG
1671 * Yields two logical unit device identification designators:
1672 * - vendor specific ASCII containing the ATA serial number
1673 * - SAT defined "t10 vendor id based" containing ASCII vendor
1674 * name ("ATA "), model and serial numbers.
1da177e4
LT
1675 *
1676 * LOCKING:
1677 * spin_lock_irqsave(host_set lock)
1678 */
1679
1680unsigned int ata_scsiop_inq_83(struct ata_scsi_args *args, u8 *rbuf,
1681 unsigned int buflen)
1682{
b142eb65
JG
1683 int num;
1684 const int sat_model_serial_desc_len = 68;
1685 const int ata_model_byte_len = 40;
1da177e4 1686
b142eb65
JG
1687 rbuf[1] = 0x83; /* this page code */
1688 num = 4;
1689
1690 if (buflen > (ATA_SERNO_LEN + num + 3)) {
1691 /* piv=0, assoc=lu, code_set=ACSII, designator=vendor */
1692 rbuf[num + 0] = 2;
1693 rbuf[num + 3] = ATA_SERNO_LEN;
1694 num += 4;
1695 ata_id_string(args->id, (unsigned char *) rbuf + num,
1696 ATA_ID_SERNO_OFS, ATA_SERNO_LEN);
1697 num += ATA_SERNO_LEN;
1da177e4 1698 }
b142eb65
JG
1699 if (buflen > (sat_model_serial_desc_len + num + 3)) {
1700 /* SAT defined lu model and serial numbers descriptor */
1701 /* piv=0, assoc=lu, code_set=ACSII, designator=t10 vendor id */
1702 rbuf[num + 0] = 2;
1703 rbuf[num + 1] = 1;
1704 rbuf[num + 3] = sat_model_serial_desc_len;
1705 num += 4;
1706 memcpy(rbuf + num, "ATA ", 8);
1707 num += 8;
1708 ata_id_string(args->id, (unsigned char *) rbuf + num,
1709 ATA_ID_PROD_OFS, ata_model_byte_len);
1710 num += ata_model_byte_len;
1711 ata_id_string(args->id, (unsigned char *) rbuf + num,
1712 ATA_ID_SERNO_OFS, ATA_SERNO_LEN);
1713 num += ATA_SERNO_LEN;
1714 }
1715 rbuf[3] = num - 4; /* page len (assume less than 256 bytes) */
1da177e4
LT
1716 return 0;
1717}
1718
1719/**
0cba632b 1720 * ata_scsiop_noop - Command handler that simply returns success.
1da177e4
LT
1721 * @args: device IDENTIFY data / SCSI command of interest.
1722 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1723 * @buflen: Response buffer length.
1724 *
1725 * No operation. Simply returns success to caller, to indicate
1726 * that the caller should successfully complete this SCSI command.
1727 *
1728 * LOCKING:
1729 * spin_lock_irqsave(host_set lock)
1730 */
1731
1732unsigned int ata_scsiop_noop(struct ata_scsi_args *args, u8 *rbuf,
1733 unsigned int buflen)
1734{
1735 VPRINTK("ENTER\n");
1736 return 0;
1737}
1738
1739/**
1740 * ata_msense_push - Push data onto MODE SENSE data output buffer
1741 * @ptr_io: (input/output) Location to store more output data
1742 * @last: End of output data buffer
1743 * @buf: Pointer to BLOB being added to output buffer
1744 * @buflen: Length of BLOB
1745 *
1746 * Store MODE SENSE data on an output buffer.
1747 *
1748 * LOCKING:
1749 * None.
1750 */
1751
1752static void ata_msense_push(u8 **ptr_io, const u8 *last,
1753 const u8 *buf, unsigned int buflen)
1754{
1755 u8 *ptr = *ptr_io;
1756
1757 if ((ptr + buflen - 1) > last)
1758 return;
1759
1760 memcpy(ptr, buf, buflen);
1761
1762 ptr += buflen;
1763
1764 *ptr_io = ptr;
1765}
1766
1767/**
1768 * ata_msense_caching - Simulate MODE SENSE caching info page
1769 * @id: device IDENTIFY data
1770 * @ptr_io: (input/output) Location to store more output data
1771 * @last: End of output data buffer
1772 *
1773 * Generate a caching info page, which conditionally indicates
1774 * write caching to the SCSI layer, depending on device
1775 * capabilities.
1776 *
1777 * LOCKING:
1778 * None.
1779 */
1780
1781static unsigned int ata_msense_caching(u16 *id, u8 **ptr_io,
1782 const u8 *last)
1783{
00ac37f5 1784 u8 page[CACHE_MPAGE_LEN];
1da177e4 1785
00ac37f5 1786 memcpy(page, def_cache_mpage, sizeof(page));
1da177e4
LT
1787 if (ata_id_wcache_enabled(id))
1788 page[2] |= (1 << 2); /* write cache enable */
1789 if (!ata_id_rahead_enabled(id))
1790 page[12] |= (1 << 5); /* disable read ahead */
1791
1792 ata_msense_push(ptr_io, last, page, sizeof(page));
1793 return sizeof(page);
1794}
1795
1796/**
1797 * ata_msense_ctl_mode - Simulate MODE SENSE control mode page
1798 * @dev: Device associated with this MODE SENSE command
1799 * @ptr_io: (input/output) Location to store more output data
1800 * @last: End of output data buffer
1801 *
1802 * Generate a generic MODE SENSE control mode page.
1803 *
1804 * LOCKING:
1805 * None.
1806 */
1807
1808static unsigned int ata_msense_ctl_mode(u8 **ptr_io, const u8 *last)
1809{
00ac37f5
DG
1810 ata_msense_push(ptr_io, last, def_control_mpage,
1811 sizeof(def_control_mpage));
1812 return sizeof(def_control_mpage);
1da177e4
LT
1813}
1814
1815/**
1816 * ata_msense_rw_recovery - Simulate MODE SENSE r/w error recovery page
1817 * @dev: Device associated with this MODE SENSE command
1818 * @ptr_io: (input/output) Location to store more output data
1819 * @last: End of output data buffer
1820 *
1821 * Generate a generic MODE SENSE r/w error recovery page.
1822 *
1823 * LOCKING:
1824 * None.
1825 */
1826
1827static unsigned int ata_msense_rw_recovery(u8 **ptr_io, const u8 *last)
1828{
1da177e4 1829
00ac37f5
DG
1830 ata_msense_push(ptr_io, last, def_rw_recovery_mpage,
1831 sizeof(def_rw_recovery_mpage));
1832 return sizeof(def_rw_recovery_mpage);
1da177e4
LT
1833}
1834
48bdc8ec
JA
1835/*
1836 * We can turn this into a real blacklist if it's needed, for now just
1837 * blacklist any Maxtor BANC1G10 revision firmware
1838 */
1839static int ata_dev_supports_fua(u16 *id)
1840{
1841 unsigned char model[41], fw[9];
1842
c3c013a2
JG
1843 if (!libata_fua)
1844 return 0;
48bdc8ec
JA
1845 if (!ata_id_has_fua(id))
1846 return 0;
1847
6a62a04d
TH
1848 ata_id_c_string(id, model, ATA_ID_PROD_OFS, sizeof(model));
1849 ata_id_c_string(id, fw, ATA_ID_FW_REV_OFS, sizeof(fw));
48bdc8ec 1850
2e02671d 1851 if (strcmp(model, "Maxtor"))
48bdc8ec 1852 return 1;
2e02671d 1853 if (strcmp(fw, "BANC1G10"))
48bdc8ec
JA
1854 return 1;
1855
1856 return 0; /* blacklisted */
1857}
1858
1da177e4
LT
1859/**
1860 * ata_scsiop_mode_sense - Simulate MODE SENSE 6, 10 commands
1861 * @args: device IDENTIFY data / SCSI command of interest.
1862 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1863 * @buflen: Response buffer length.
1864 *
00ac37f5
DG
1865 * Simulate MODE SENSE commands. Assume this is invoked for direct
1866 * access devices (e.g. disks) only. There should be no block
1867 * descriptor for other device types.
1da177e4
LT
1868 *
1869 * LOCKING:
1870 * spin_lock_irqsave(host_set lock)
1871 */
1872
1873unsigned int ata_scsiop_mode_sense(struct ata_scsi_args *args, u8 *rbuf,
1874 unsigned int buflen)
1875{
9a3dccc4 1876 struct ata_device *dev = args->dev;
1da177e4 1877 u8 *scsicmd = args->cmd->cmnd, *p, *last;
00ac37f5
DG
1878 const u8 sat_blk_desc[] = {
1879 0, 0, 0, 0, /* number of blocks: sat unspecified */
1880 0,
1881 0, 0x2, 0x0 /* block length: 512 bytes */
1882 };
1883 u8 pg, spg;
1884 unsigned int ebd, page_control, six_byte, output_len, alloc_len, minlen;
9a3dccc4 1885 u8 dpofua;
1da177e4
LT
1886
1887 VPRINTK("ENTER\n");
1888
1889 six_byte = (scsicmd[0] == MODE_SENSE);
00ac37f5
DG
1890 ebd = !(scsicmd[1] & 0x8); /* dbd bit inverted == edb */
1891 /*
1892 * LLBA bit in msense(10) ignored (compliant)
1da177e4 1893 */
00ac37f5 1894
1da177e4 1895 page_control = scsicmd[2] >> 6;
ae006510
DG
1896 switch (page_control) {
1897 case 0: /* current */
1898 break; /* supported */
1899 case 3: /* saved */
1900 goto saving_not_supp;
1901 case 1: /* changeable */
1902 case 2: /* defaults */
1903 default:
1904 goto invalid_fld;
1905 }
1da177e4 1906
00ac37f5
DG
1907 if (six_byte) {
1908 output_len = 4 + (ebd ? 8 : 0);
1909 alloc_len = scsicmd[4];
1910 } else {
1911 output_len = 8 + (ebd ? 8 : 0);
1912 alloc_len = (scsicmd[7] << 8) + scsicmd[8];
1913 }
1914 minlen = (alloc_len < buflen) ? alloc_len : buflen;
1da177e4
LT
1915
1916 p = rbuf + output_len;
00ac37f5 1917 last = rbuf + minlen - 1;
1da177e4 1918
00ac37f5
DG
1919 pg = scsicmd[2] & 0x3f;
1920 spg = scsicmd[3];
1921 /*
1922 * No mode subpages supported (yet) but asking for _all_
1923 * subpages may be valid
1924 */
1925 if (spg && (spg != ALL_SUB_MPAGES))
1926 goto invalid_fld;
1927
1928 switch(pg) {
1929 case RW_RECOVERY_MPAGE:
1da177e4
LT
1930 output_len += ata_msense_rw_recovery(&p, last);
1931 break;
1932
00ac37f5 1933 case CACHE_MPAGE:
1da177e4
LT
1934 output_len += ata_msense_caching(args->id, &p, last);
1935 break;
1936
00ac37f5 1937 case CONTROL_MPAGE: {
1da177e4
LT
1938 output_len += ata_msense_ctl_mode(&p, last);
1939 break;
1940 }
1941
00ac37f5 1942 case ALL_MPAGES:
1da177e4
LT
1943 output_len += ata_msense_rw_recovery(&p, last);
1944 output_len += ata_msense_caching(args->id, &p, last);
1945 output_len += ata_msense_ctl_mode(&p, last);
1946 break;
1947
1948 default: /* invalid page code */
ae006510 1949 goto invalid_fld;
1da177e4
LT
1950 }
1951
00ac37f5
DG
1952 if (minlen < 1)
1953 return 0;
9a3dccc4
TH
1954
1955 dpofua = 0;
48bdc8ec 1956 if (ata_dev_supports_fua(args->id) && dev->flags & ATA_DFLAG_LBA48 &&
9a3dccc4
TH
1957 (!(dev->flags & ATA_DFLAG_PIO) || dev->multi_count))
1958 dpofua = 1 << 4;
1959
1da177e4
LT
1960 if (six_byte) {
1961 output_len--;
1962 rbuf[0] = output_len;
9a3dccc4
TH
1963 if (minlen > 2)
1964 rbuf[2] |= dpofua;
00ac37f5
DG
1965 if (ebd) {
1966 if (minlen > 3)
1967 rbuf[3] = sizeof(sat_blk_desc);
1968 if (minlen > 11)
1969 memcpy(rbuf + 4, sat_blk_desc,
1970 sizeof(sat_blk_desc));
1971 }
1da177e4
LT
1972 } else {
1973 output_len -= 2;
1974 rbuf[0] = output_len >> 8;
00ac37f5
DG
1975 if (minlen > 1)
1976 rbuf[1] = output_len;
9a3dccc4
TH
1977 if (minlen > 3)
1978 rbuf[3] |= dpofua;
00ac37f5
DG
1979 if (ebd) {
1980 if (minlen > 7)
1981 rbuf[7] = sizeof(sat_blk_desc);
1982 if (minlen > 15)
1983 memcpy(rbuf + 8, sat_blk_desc,
1984 sizeof(sat_blk_desc));
1985 }
1da177e4 1986 }
1da177e4 1987 return 0;
ae006510
DG
1988
1989invalid_fld:
1990 ata_scsi_set_sense(args->cmd, ILLEGAL_REQUEST, 0x24, 0x0);
1991 /* "Invalid field in cbd" */
1992 return 1;
1993
1994saving_not_supp:
1995 ata_scsi_set_sense(args->cmd, ILLEGAL_REQUEST, 0x39, 0x0);
1996 /* "Saving parameters not supported" */
1997 return 1;
1da177e4
LT
1998}
1999
2000/**
2001 * ata_scsiop_read_cap - Simulate READ CAPACITY[ 16] commands
2002 * @args: device IDENTIFY data / SCSI command of interest.
2003 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2004 * @buflen: Response buffer length.
2005 *
2006 * Simulate READ CAPACITY commands.
2007 *
2008 * LOCKING:
2009 * spin_lock_irqsave(host_set lock)
2010 */
2011
2012unsigned int ata_scsiop_read_cap(struct ata_scsi_args *args, u8 *rbuf,
2013 unsigned int buflen)
2014{
2015 u64 n_sectors;
2016 u32 tmp;
2017
2018 VPRINTK("ENTER\n");
2019
8bf62ece
AL
2020 if (ata_id_has_lba(args->id)) {
2021 if (ata_id_has_lba48(args->id))
2022 n_sectors = ata_id_u64(args->id, 100);
2023 else
2024 n_sectors = ata_id_u32(args->id, 60);
2025 } else {
2026 /* CHS default translation */
2027 n_sectors = args->id[1] * args->id[3] * args->id[6];
2028
2029 if (ata_id_current_chs_valid(args->id))
2030 /* CHS current translation */
2031 n_sectors = ata_id_u32(args->id, 57);
2032 }
2033
1da177e4
LT
2034 n_sectors--; /* ATA TotalUserSectors - 1 */
2035
1da177e4 2036 if (args->cmd->cmnd[0] == READ_CAPACITY) {
0c144d0d
PP
2037 if( n_sectors >= 0xffffffffULL )
2038 tmp = 0xffffffff ; /* Return max count on overflow */
2039 else
2040 tmp = n_sectors ;
2041
1da177e4
LT
2042 /* sector count, 32-bit */
2043 rbuf[0] = tmp >> (8 * 3);
2044 rbuf[1] = tmp >> (8 * 2);
2045 rbuf[2] = tmp >> (8 * 1);
2046 rbuf[3] = tmp;
2047
2048 /* sector size */
2049 tmp = ATA_SECT_SIZE;
2050 rbuf[6] = tmp >> 8;
2051 rbuf[7] = tmp;
2052
2053 } else {
2054 /* sector count, 64-bit */
0c144d0d
PP
2055 tmp = n_sectors >> (8 * 4);
2056 rbuf[2] = tmp >> (8 * 3);
2057 rbuf[3] = tmp >> (8 * 2);
2058 rbuf[4] = tmp >> (8 * 1);
2059 rbuf[5] = tmp;
2060 tmp = n_sectors;
1da177e4
LT
2061 rbuf[6] = tmp >> (8 * 3);
2062 rbuf[7] = tmp >> (8 * 2);
2063 rbuf[8] = tmp >> (8 * 1);
2064 rbuf[9] = tmp;
2065
2066 /* sector size */
2067 tmp = ATA_SECT_SIZE;
2068 rbuf[12] = tmp >> 8;
2069 rbuf[13] = tmp;
2070 }
2071
2072 return 0;
2073}
2074
2075/**
2076 * ata_scsiop_report_luns - Simulate REPORT LUNS command
2077 * @args: device IDENTIFY data / SCSI command of interest.
2078 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2079 * @buflen: Response buffer length.
2080 *
2081 * Simulate REPORT LUNS command.
2082 *
2083 * LOCKING:
2084 * spin_lock_irqsave(host_set lock)
2085 */
2086
2087unsigned int ata_scsiop_report_luns(struct ata_scsi_args *args, u8 *rbuf,
2088 unsigned int buflen)
2089{
2090 VPRINTK("ENTER\n");
2091 rbuf[3] = 8; /* just one lun, LUN 0, size 8 bytes */
2092
2093 return 0;
2094}
2095
845c5834
DG
2096/**
2097 * ata_scsi_set_sense - Set SCSI sense data and status
2098 * @cmd: SCSI request to be handled
2099 * @sk: SCSI-defined sense key
2100 * @asc: SCSI-defined additional sense code
2101 * @ascq: SCSI-defined additional sense code qualifier
2102 *
2103 * Helper function that builds a valid fixed format, current
2104 * response code and the given sense key (sk), additional sense
2105 * code (asc) and additional sense code qualifier (ascq) with
2106 * a SCSI command status of %SAM_STAT_CHECK_CONDITION and
2107 * DRIVER_SENSE set in the upper bits of scsi_cmnd::result .
2108 *
2109 * LOCKING:
2110 * Not required
2111 */
2112
2113void ata_scsi_set_sense(struct scsi_cmnd *cmd, u8 sk, u8 asc, u8 ascq)
2114{
2115 cmd->result = (DRIVER_SENSE << 24) | SAM_STAT_CHECK_CONDITION;
2116
2117 cmd->sense_buffer[0] = 0x70; /* fixed format, current */
2118 cmd->sense_buffer[2] = sk;
2119 cmd->sense_buffer[7] = 18 - 8; /* additional sense length */
2120 cmd->sense_buffer[12] = asc;
2121 cmd->sense_buffer[13] = ascq;
2122}
2123
1da177e4
LT
2124/**
2125 * ata_scsi_badcmd - End a SCSI request with an error
2126 * @cmd: SCSI request to be handled
2127 * @done: SCSI command completion function
2128 * @asc: SCSI-defined additional sense code
2129 * @ascq: SCSI-defined additional sense code qualifier
2130 *
2131 * Helper function that completes a SCSI command with
2132 * %SAM_STAT_CHECK_CONDITION, with a sense key %ILLEGAL_REQUEST
2133 * and the specified additional sense codes.
2134 *
2135 * LOCKING:
2136 * spin_lock_irqsave(host_set lock)
2137 */
2138
2139void ata_scsi_badcmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *), u8 asc, u8 ascq)
2140{
2141 DPRINTK("ENTER\n");
ae006510 2142 ata_scsi_set_sense(cmd, ILLEGAL_REQUEST, asc, ascq);
1da177e4
LT
2143
2144 done(cmd);
2145}
2146
77853bf2 2147static void atapi_sense_complete(struct ata_queued_cmd *qc)
a939c963 2148{
a22e2eb0 2149 if (qc->err_mask && ((qc->err_mask & AC_ERR_DEV) == 0))
c6e6e666
JG
2150 /* FIXME: not quite right; we don't want the
2151 * translation of taskfile registers into
2152 * a sense descriptors, since that's only
2153 * correct for ATA, not ATAPI
2154 */
2155 ata_gen_ata_desc_sense(qc);
a939c963 2156
c6e6e666 2157 qc->scsidone(qc->scsicmd);
77853bf2 2158 ata_qc_free(qc);
c6e6e666 2159}
a939c963 2160
c6e6e666
JG
2161/* is it pointless to prefer PIO for "safety reasons"? */
2162static inline int ata_pio_use_silly(struct ata_port *ap)
2163{
2164 return (ap->flags & ATA_FLAG_PIO_DMA);
2165}
2166
2167static void atapi_request_sense(struct ata_queued_cmd *qc)
2168{
2169 struct ata_port *ap = qc->ap;
2170 struct scsi_cmnd *cmd = qc->scsicmd;
2171
2172 DPRINTK("ATAPI request sense\n");
a939c963
JG
2173
2174 /* FIXME: is this needed? */
2175 memset(cmd->sense_buffer, 0, sizeof(cmd->sense_buffer));
2176
c6e6e666
JG
2177 ap->ops->tf_read(ap, &qc->tf);
2178
2179 /* fill these in, for the case where they are -not- overwritten */
2180 cmd->sense_buffer[0] = 0x70;
2181 cmd->sense_buffer[2] = qc->tf.feature >> 4;
2182
2183 ata_qc_reinit(qc);
2184
a939c963
JG
2185 ata_sg_init_one(qc, cmd->sense_buffer, sizeof(cmd->sense_buffer));
2186 qc->dma_dir = DMA_FROM_DEVICE;
2187
6e7846e9 2188 memset(&qc->cdb, 0, qc->dev->cdb_len);
a939c963
JG
2189 qc->cdb[0] = REQUEST_SENSE;
2190 qc->cdb[4] = SCSI_SENSE_BUFFERSIZE;
2191
2192 qc->tf.flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
2193 qc->tf.command = ATA_CMD_PACKET;
2194
c6e6e666
JG
2195 if (ata_pio_use_silly(ap)) {
2196 qc->tf.protocol = ATA_PROT_ATAPI_DMA;
2197 qc->tf.feature |= ATAPI_PKT_DMA;
2198 } else {
2199 qc->tf.protocol = ATA_PROT_ATAPI;
2200 qc->tf.lbam = (8 * 1024) & 0xff;
2201 qc->tf.lbah = (8 * 1024) >> 8;
2202 }
a939c963
JG
2203 qc->nbytes = SCSI_SENSE_BUFFERSIZE;
2204
c6e6e666 2205 qc->complete_fn = atapi_sense_complete;
a939c963 2206
9a3d9eb0
TH
2207 qc->err_mask = ata_qc_issue(qc);
2208 if (qc->err_mask)
a22e2eb0 2209 ata_qc_complete(qc);
a939c963
JG
2210
2211 DPRINTK("EXIT\n");
2212}
2213
77853bf2 2214static void atapi_qc_complete(struct ata_queued_cmd *qc)
1da177e4
LT
2215{
2216 struct scsi_cmnd *cmd = qc->scsicmd;
a22e2eb0 2217 unsigned int err_mask = qc->err_mask;
1da177e4 2218
a7dac447 2219 VPRINTK("ENTER, err_mask 0x%X\n", err_mask);
e12669e7 2220
a7dac447 2221 if (unlikely(err_mask & AC_ERR_DEV)) {
1da177e4 2222 cmd->result = SAM_STAT_CHECK_CONDITION;
c6e6e666 2223 atapi_request_sense(qc);
77853bf2 2224 return;
e12669e7
JG
2225 }
2226
a7dac447
JG
2227 else if (unlikely(err_mask))
2228 /* FIXME: not quite right; we don't want the
2229 * translation of taskfile registers into
2230 * a sense descriptors, since that's only
2231 * correct for ATA, not ATAPI
2232 */
2233 ata_gen_ata_desc_sense(qc);
2234
e12669e7 2235 else {
1da177e4
LT
2236 u8 *scsicmd = cmd->cmnd;
2237
fd71da46 2238 if ((scsicmd[0] == INQUIRY) && ((scsicmd[1] & 0x03) == 0)) {
1da177e4
LT
2239 u8 *buf = NULL;
2240 unsigned int buflen;
2241
2242 buflen = ata_scsi_rbuf_get(cmd, &buf);
a15dbeb4
JG
2243
2244 /* ATAPI devices typically report zero for their SCSI version,
2245 * and sometimes deviate from the spec WRT response data
2246 * format. If SCSI version is reported as zero like normal,
2247 * then we make the following fixups: 1) Fake MMC-5 version,
2248 * to indicate to the Linux scsi midlayer this is a modern
2249 * device. 2) Ensure response data format / ATAPI information
2250 * are always correct.
a15dbeb4
JG
2251 */
2252 if (buf[2] == 0) {
2253 buf[2] = 0x5;
2254 buf[3] = 0x32;
2255 }
2256
1da177e4
LT
2257 ata_scsi_rbuf_put(cmd, buf);
2258 }
a15dbeb4 2259
1da177e4
LT
2260 cmd->result = SAM_STAT_GOOD;
2261 }
2262
2263 qc->scsidone(cmd);
77853bf2 2264 ata_qc_free(qc);
1da177e4
LT
2265}
2266/**
2267 * atapi_xlat - Initialize PACKET taskfile
2268 * @qc: command structure to be initialized
2269 * @scsicmd: SCSI CDB associated with this PACKET command
2270 *
2271 * LOCKING:
2272 * spin_lock_irqsave(host_set lock)
2273 *
2274 * RETURNS:
2275 * Zero on success, non-zero on failure.
2276 */
2277
057ace5e 2278static unsigned int atapi_xlat(struct ata_queued_cmd *qc, const u8 *scsicmd)
1da177e4
LT
2279{
2280 struct scsi_cmnd *cmd = qc->scsicmd;
2281 struct ata_device *dev = qc->dev;
2282 int using_pio = (dev->flags & ATA_DFLAG_PIO);
be7db055 2283 int nodata = (cmd->sc_data_direction == DMA_NONE);
1da177e4
LT
2284
2285 if (!using_pio)
2286 /* Check whether ATAPI DMA is safe */
2287 if (ata_check_atapi_dma(qc))
2288 using_pio = 1;
2289
6e7846e9 2290 memcpy(&qc->cdb, scsicmd, dev->cdb_len);
1da177e4
LT
2291
2292 qc->complete_fn = atapi_qc_complete;
2293
2294 qc->tf.flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
be7db055 2295 if (cmd->sc_data_direction == DMA_TO_DEVICE) {
1da177e4
LT
2296 qc->tf.flags |= ATA_TFLAG_WRITE;
2297 DPRINTK("direction: write\n");
2298 }
2299
2300 qc->tf.command = ATA_CMD_PACKET;
2301
2302 /* no data, or PIO data xfer */
2303 if (using_pio || nodata) {
2304 if (nodata)
2305 qc->tf.protocol = ATA_PROT_ATAPI_NODATA;
2306 else
2307 qc->tf.protocol = ATA_PROT_ATAPI;
2308 qc->tf.lbam = (8 * 1024) & 0xff;
2309 qc->tf.lbah = (8 * 1024) >> 8;
2310 }
2311
2312 /* DMA data xfer */
2313 else {
2314 qc->tf.protocol = ATA_PROT_ATAPI_DMA;
2315 qc->tf.feature |= ATAPI_PKT_DMA;
2316
2317#ifdef ATAPI_ENABLE_DMADIR
2318 /* some SATA bridges need us to indicate data xfer direction */
be7db055 2319 if (cmd->sc_data_direction != DMA_TO_DEVICE)
1da177e4
LT
2320 qc->tf.feature |= ATAPI_DMADIR;
2321#endif
2322 }
2323
2324 qc->nbytes = cmd->bufflen;
2325
2326 return 0;
2327}
2328
2329/**
2330 * ata_scsi_find_dev - lookup ata_device from scsi_cmnd
2331 * @ap: ATA port to which the device is attached
2332 * @scsidev: SCSI device from which we derive the ATA device
2333 *
2334 * Given various information provided in struct scsi_cmnd,
2335 * map that onto an ATA bus, and using that mapping
2336 * determine which ata_device is associated with the
2337 * SCSI command to be sent.
2338 *
2339 * LOCKING:
2340 * spin_lock_irqsave(host_set lock)
2341 *
2342 * RETURNS:
2343 * Associated ATA device, or %NULL if not found.
2344 */
2345
2346static struct ata_device *
057ace5e 2347ata_scsi_find_dev(struct ata_port *ap, const struct scsi_device *scsidev)
1da177e4
LT
2348{
2349 struct ata_device *dev;
2350
2351 /* skip commands not addressed to targets we simulate */
2352 if (likely(scsidev->id < ATA_MAX_DEVICES))
2353 dev = &ap->device[scsidev->id];
2354 else
2355 return NULL;
2356
2357 if (unlikely((scsidev->channel != 0) ||
2358 (scsidev->lun != 0)))
2359 return NULL;
2360
2361 if (unlikely(!ata_dev_present(dev)))
2362 return NULL;
2363
50630195
JG
2364 if (!atapi_enabled || (ap->flags & ATA_FLAG_NO_ATAPI)) {
2365 if (unlikely(dev->class == ATA_DEV_ATAPI)) {
2366 printk(KERN_WARNING "ata%u(%u): WARNING: ATAPI is %s, device ignored.\n",
2367 ap->id, dev->devno, atapi_enabled ? "not supported with this driver" : "disabled");
1623c81e 2368 return NULL;
50630195 2369 }
1623c81e 2370 }
1da177e4
LT
2371
2372 return dev;
2373}
2374
b095518e
JG
2375/*
2376 * ata_scsi_map_proto - Map pass-thru protocol value to taskfile value.
2377 * @byte1: Byte 1 from pass-thru CDB.
2378 *
2379 * RETURNS:
2380 * ATA_PROT_UNKNOWN if mapping failed/unimplemented, protocol otherwise.
2381 */
2382static u8
2383ata_scsi_map_proto(u8 byte1)
2384{
2385 switch((byte1 & 0x1e) >> 1) {
2386 case 3: /* Non-data */
2387 return ATA_PROT_NODATA;
2388
2389 case 6: /* DMA */
2390 return ATA_PROT_DMA;
2391
2392 case 4: /* PIO Data-in */
2393 case 5: /* PIO Data-out */
b095518e
JG
2394 return ATA_PROT_PIO;
2395
2396 case 10: /* Device Reset */
2397 case 0: /* Hard Reset */
2398 case 1: /* SRST */
2399 case 2: /* Bus Idle */
2400 case 7: /* Packet */
2401 case 8: /* DMA Queued */
2402 case 9: /* Device Diagnostic */
2403 case 11: /* UDMA Data-in */
2404 case 12: /* UDMA Data-Out */
2405 case 13: /* FPDMA */
2406 default: /* Reserved */
2407 break;
2408 }
2409
2410 return ATA_PROT_UNKNOWN;
2411}
2412
2413/**
2414 * ata_scsi_pass_thru - convert ATA pass-thru CDB to taskfile
2415 * @qc: command structure to be initialized
8e8b77dd 2416 * @scsicmd: SCSI command to convert
b095518e
JG
2417 *
2418 * Handles either 12 or 16-byte versions of the CDB.
2419 *
2420 * RETURNS:
2421 * Zero on success, non-zero on failure.
2422 */
2423static unsigned int
00ac37f5 2424ata_scsi_pass_thru(struct ata_queued_cmd *qc, const u8 *scsicmd)
b095518e
JG
2425{
2426 struct ata_taskfile *tf = &(qc->tf);
2427 struct scsi_cmnd *cmd = qc->scsicmd;
2428
2429 if ((tf->protocol = ata_scsi_map_proto(scsicmd[1])) == ATA_PROT_UNKNOWN)
9a405257 2430 goto invalid_fld;
b095518e 2431
f59b0cf8
AL
2432 if (scsicmd[1] & 0xe0)
2433 /* PIO multi not supported yet */
2434 goto invalid_fld;
2435
b095518e
JG
2436 /*
2437 * 12 and 16 byte CDBs use different offsets to
2438 * provide the various register values.
2439 */
2440 if (scsicmd[0] == ATA_16) {
2441 /*
2442 * 16-byte CDB - may contain extended commands.
2443 *
2444 * If that is the case, copy the upper byte register values.
2445 */
2446 if (scsicmd[1] & 0x01) {
2447 tf->hob_feature = scsicmd[3];
2448 tf->hob_nsect = scsicmd[5];
2449 tf->hob_lbal = scsicmd[7];
2450 tf->hob_lbam = scsicmd[9];
2451 tf->hob_lbah = scsicmd[11];
2452 tf->flags |= ATA_TFLAG_LBA48;
2453 } else
2454 tf->flags &= ~ATA_TFLAG_LBA48;
2455
2456 /*
2457 * Always copy low byte, device and command registers.
2458 */
2459 tf->feature = scsicmd[4];
2460 tf->nsect = scsicmd[6];
2461 tf->lbal = scsicmd[8];
2462 tf->lbam = scsicmd[10];
2463 tf->lbah = scsicmd[12];
2464 tf->device = scsicmd[13];
2465 tf->command = scsicmd[14];
2466 } else {
2467 /*
2468 * 12-byte CDB - incapable of extended commands.
2469 */
2470 tf->flags &= ~ATA_TFLAG_LBA48;
2471
2472 tf->feature = scsicmd[3];
2473 tf->nsect = scsicmd[4];
2474 tf->lbal = scsicmd[5];
2475 tf->lbam = scsicmd[6];
2476 tf->lbah = scsicmd[7];
2477 tf->device = scsicmd[8];
2478 tf->command = scsicmd[9];
2479 }
dcc2d1e7
ML
2480 /*
2481 * If slave is possible, enforce correct master/slave bit
2482 */
2483 if (qc->ap->flags & ATA_FLAG_SLAVE_POSS)
2484 tf->device = qc->dev->devno ?
2485 tf->device | ATA_DEV1 : tf->device & ~ATA_DEV1;
b095518e
JG
2486
2487 /*
2488 * Filter SET_FEATURES - XFER MODE command -- otherwise,
2489 * SET_FEATURES - XFER MODE must be preceded/succeeded
2490 * by an update to hardware-specific registers for each
2491 * controller (i.e. the reason for ->set_piomode(),
2492 * ->set_dmamode(), and ->post_set_mode() hooks).
2493 */
2494 if ((tf->command == ATA_CMD_SET_FEATURES)
2495 && (tf->feature == SETFEATURES_XFER))
9a405257 2496 goto invalid_fld;
b095518e
JG
2497
2498 /*
2499 * Set flags so that all registers will be written,
2500 * and pass on write indication (used for PIO/DMA
2501 * setup.)
2502 */
2503 tf->flags |= (ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE);
2504
0274aa25 2505 if (cmd->sc_data_direction == DMA_TO_DEVICE)
b095518e
JG
2506 tf->flags |= ATA_TFLAG_WRITE;
2507
2508 /*
2509 * Set transfer length.
2510 *
2511 * TODO: find out if we need to do more here to
2512 * cover scatter/gather case.
2513 */
2514 qc->nsect = cmd->bufflen / ATA_SECT_SIZE;
2515
2516 return 0;
9a405257
TH
2517
2518 invalid_fld:
2519 ata_scsi_set_sense(qc->scsicmd, ILLEGAL_REQUEST, 0x24, 0x00);
2520 /* "Invalid field in cdb" */
2521 return 1;
b095518e
JG
2522}
2523
1da177e4
LT
2524/**
2525 * ata_get_xlat_func - check if SCSI to ATA translation is possible
2526 * @dev: ATA device
2527 * @cmd: SCSI command opcode to consider
2528 *
2529 * Look up the SCSI command given, and determine whether the
2530 * SCSI command is to be translated or simulated.
2531 *
2532 * RETURNS:
2533 * Pointer to translation function if possible, %NULL if not.
2534 */
2535
2536static inline ata_xlat_func_t ata_get_xlat_func(struct ata_device *dev, u8 cmd)
2537{
2538 switch (cmd) {
2539 case READ_6:
2540 case READ_10:
2541 case READ_16:
2542
2543 case WRITE_6:
2544 case WRITE_10:
2545 case WRITE_16:
2546 return ata_scsi_rw_xlat;
2547
2548 case SYNCHRONIZE_CACHE:
2549 if (ata_try_flush_cache(dev))
2550 return ata_scsi_flush_xlat;
2551 break;
2552
2553 case VERIFY:
2554 case VERIFY_16:
2555 return ata_scsi_verify_xlat;
b095518e
JG
2556
2557 case ATA_12:
2558 case ATA_16:
2559 return ata_scsi_pass_thru;
da61396d 2560
972dcafb
DG
2561 case START_STOP:
2562 return ata_scsi_start_stop_xlat;
1da177e4
LT
2563 }
2564
2565 return NULL;
2566}
2567
2568/**
2569 * ata_scsi_dump_cdb - dump SCSI command contents to dmesg
2570 * @ap: ATA port to which the command was being sent
2571 * @cmd: SCSI command to dump
2572 *
2573 * Prints the contents of a SCSI command via printk().
2574 */
2575
2576static inline void ata_scsi_dump_cdb(struct ata_port *ap,
2577 struct scsi_cmnd *cmd)
2578{
2579#ifdef ATA_DEBUG
2580 struct scsi_device *scsidev = cmd->device;
2581 u8 *scsicmd = cmd->cmnd;
2582
2583 DPRINTK("CDB (%u:%d,%d,%d) %02x %02x %02x %02x %02x %02x %02x %02x %02x\n",
2584 ap->id,
2585 scsidev->channel, scsidev->id, scsidev->lun,
2586 scsicmd[0], scsicmd[1], scsicmd[2], scsicmd[3],
2587 scsicmd[4], scsicmd[5], scsicmd[6], scsicmd[7],
2588 scsicmd[8]);
2589#endif
2590}
2591
2592/**
2593 * ata_scsi_queuecmd - Issue SCSI cdb to libata-managed device
2594 * @cmd: SCSI command to be sent
2595 * @done: Completion function, called when command is complete
2596 *
2597 * In some cases, this function translates SCSI commands into
2598 * ATA taskfiles, and queues the taskfiles to be sent to
2599 * hardware. In other cases, this function simulates a
2600 * SCSI device by evaluating and responding to certain
2601 * SCSI commands. This creates the overall effect of
2602 * ATA and ATAPI devices appearing as SCSI devices.
2603 *
2604 * LOCKING:
2605 * Releases scsi-layer-held lock, and obtains host_set lock.
2606 *
2607 * RETURNS:
2608 * Zero.
2609 */
2610
2611int ata_scsi_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *))
2612{
2613 struct ata_port *ap;
2614 struct ata_device *dev;
2615 struct scsi_device *scsidev = cmd->device;
005a5a06 2616 struct Scsi_Host *shost = scsidev->host;
1da177e4 2617
005a5a06
JG
2618 ap = (struct ata_port *) &shost->hostdata[0];
2619
2620 spin_unlock(shost->host_lock);
2621 spin_lock(&ap->host_set->lock);
1da177e4
LT
2622
2623 ata_scsi_dump_cdb(ap, cmd);
2624
2625 dev = ata_scsi_find_dev(ap, scsidev);
2626 if (unlikely(!dev)) {
2627 cmd->result = (DID_BAD_TARGET << 16);
2628 done(cmd);
2629 goto out_unlock;
2630 }
2631
2632 if (dev->class == ATA_DEV_ATA) {
2633 ata_xlat_func_t xlat_func = ata_get_xlat_func(dev,
2634 cmd->cmnd[0]);
2635
2636 if (xlat_func)
2637 ata_scsi_translate(ap, dev, cmd, done, xlat_func);
2638 else
9a3dccc4 2639 ata_scsi_simulate(ap, dev, cmd, done);
1da177e4
LT
2640 } else
2641 ata_scsi_translate(ap, dev, cmd, done, atapi_xlat);
2642
2643out_unlock:
005a5a06
JG
2644 spin_unlock(&ap->host_set->lock);
2645 spin_lock(shost->host_lock);
1da177e4
LT
2646 return 0;
2647}
2648
2649/**
2650 * ata_scsi_simulate - simulate SCSI command on ATA device
c893a3ae
RD
2651 * @ap: port the device is connected to
2652 * @dev: the target device
1da177e4
LT
2653 * @cmd: SCSI command being sent to device.
2654 * @done: SCSI command completion function.
2655 *
2656 * Interprets and directly executes a select list of SCSI commands
2657 * that can be handled internally.
2658 *
2659 * LOCKING:
2660 * spin_lock_irqsave(host_set lock)
2661 */
2662
9a3dccc4 2663void ata_scsi_simulate(struct ata_port *ap, struct ata_device *dev,
1da177e4
LT
2664 struct scsi_cmnd *cmd,
2665 void (*done)(struct scsi_cmnd *))
2666{
2667 struct ata_scsi_args args;
057ace5e 2668 const u8 *scsicmd = cmd->cmnd;
1da177e4 2669
9a3dccc4
TH
2670 args.ap = ap;
2671 args.dev = dev;
2672 args.id = dev->id;
1da177e4
LT
2673 args.cmd = cmd;
2674 args.done = done;
2675
2676 switch(scsicmd[0]) {
2677 /* no-op's, complete with success */
2678 case SYNCHRONIZE_CACHE:
2679 case REZERO_UNIT:
2680 case SEEK_6:
2681 case SEEK_10:
2682 case TEST_UNIT_READY:
2683 case FORMAT_UNIT: /* FIXME: correct? */
2684 case SEND_DIAGNOSTIC: /* FIXME: correct? */
2685 ata_scsi_rbuf_fill(&args, ata_scsiop_noop);
2686 break;
2687
2688 case INQUIRY:
2689 if (scsicmd[1] & 2) /* is CmdDt set? */
ae006510 2690 ata_scsi_invalid_field(cmd, done);
1da177e4
LT
2691 else if ((scsicmd[1] & 1) == 0) /* is EVPD clear? */
2692 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_std);
2693 else if (scsicmd[2] == 0x00)
2694 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_00);
2695 else if (scsicmd[2] == 0x80)
2696 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_80);
2697 else if (scsicmd[2] == 0x83)
2698 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_83);
2699 else
ae006510 2700 ata_scsi_invalid_field(cmd, done);
1da177e4
LT
2701 break;
2702
2703 case MODE_SENSE:
2704 case MODE_SENSE_10:
2705 ata_scsi_rbuf_fill(&args, ata_scsiop_mode_sense);
2706 break;
2707
2708 case MODE_SELECT: /* unconditionally return */
2709 case MODE_SELECT_10: /* bad-field-in-cdb */
ae006510 2710 ata_scsi_invalid_field(cmd, done);
1da177e4
LT
2711 break;
2712
2713 case READ_CAPACITY:
2714 ata_scsi_rbuf_fill(&args, ata_scsiop_read_cap);
2715 break;
2716
2717 case SERVICE_ACTION_IN:
2718 if ((scsicmd[1] & 0x1f) == SAI_READ_CAPACITY_16)
2719 ata_scsi_rbuf_fill(&args, ata_scsiop_read_cap);
2720 else
ae006510 2721 ata_scsi_invalid_field(cmd, done);
1da177e4
LT
2722 break;
2723
2724 case REPORT_LUNS:
2725 ata_scsi_rbuf_fill(&args, ata_scsiop_report_luns);
2726 break;
2727
b095518e 2728 /* mandatory commands we haven't implemented yet */
1da177e4
LT
2729 case REQUEST_SENSE:
2730
2731 /* all other commands */
2732 default:
ae006510
DG
2733 ata_scsi_set_sense(cmd, ILLEGAL_REQUEST, 0x20, 0x0);
2734 /* "Invalid command operation code" */
2735 done(cmd);
1da177e4
LT
2736 break;
2737 }
2738}
2739
644dd0cc
JG
2740void ata_scsi_scan_host(struct ata_port *ap)
2741{
3f19ee8c 2742 struct ata_device *dev;
644dd0cc
JG
2743 unsigned int i;
2744
2745 if (ap->flags & ATA_FLAG_PORT_DISABLED)
2746 return;
2747
3f19ee8c
JG
2748 for (i = 0; i < ATA_MAX_DEVICES; i++) {
2749 dev = &ap->device[i];
2750
2751 if (ata_dev_present(dev))
2752 scsi_scan_target(&ap->host->shost_gendev, 0, i, 0, 0);
2753 }
644dd0cc
JG
2754}
2755