?  search:
summary | log | graphiclog1 | graphiclog2 | commit | commitdiff | tree | refs | edit | fork
blame | history | raw | HEAD
[PATCH] libata: fix ata_scsi_pass_thru error handling
[linux-2.6.22.y-op.git] / drivers / scsi / libata-scsi.c
blob379e87089764dd4f2f1a4ad70c7abcaab7f6aeea
1 /*
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 *
34 */
35
36 #include <linux/kernel.h>
37 #include <linux/blkdev.h>
38 #include <linux/spinlock.h>
39 #include <scsi/scsi.h>
40 #include <scsi/scsi_host.h>
41 #include <scsi/scsi_eh.h>
42 #include <scsi/scsi_device.h>
43 #include <scsi/scsi_request.h>
44 #include <linux/libata.h>
45 #include <linux/hdreg.h>
46 #include <asm/uaccess.h>
47
48 #include "libata.h"
49
50 #define SECTOR_SIZE 512
51
52 typedef unsigned int (*ata_xlat_func_t)(struct ata_queued_cmd *qc, const u8 *scsicmd);
53 static struct ata_device *
54 ata_scsi_find_dev(struct ata_port *ap, const struct scsi_device *scsidev);
55
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
66 static 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
77 static 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
86 static 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
95
96 static 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
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 */
122 int 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
133 /**
134 * ata_cmd_ioctl - Handler for HDIO_DRIVE_CMD ioctl
135 * @scsidev: Device to which we are issuing command
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
145 int 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;
151 struct scsi_sense_hdr sshdr;
152 enum dma_data_direction data_dir;
153
154 if (NULL == (void *)arg)
155 return -EINVAL;
156
157 if (copy_from_user(args, arg, sizeof(args)))
158 return -EFAULT;
159
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);
165 if (argbuf == NULL) {
166 rc = -ENOMEM;
167 goto error;
168 }
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 */
173 data_dir = DMA_FROM_DEVICE;
174 } else {
175 scsi_cmd[1] = (3 << 1); /* Non-data */
176 /* scsi_cmd[2] is already 0 -- no off.line, cc, or data xfer */
177 data_dir = DMA_NONE;
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... */
195 if (scsi_execute_req(scsidev, scsi_cmd, data_dir, argbuf, argsize,
196 &sshdr, (10*HZ), 5)) {
197 rc = -EIO;
198 goto error;
199 }
200
201 /* Need code to retrieve data from check condition? */
202
203 if ((argbuf)
204 && copy_to_user((void *)(arg + sizeof(args)), argbuf, argsize))
205 rc = -EFAULT;
206 error:
207 if (argbuf)
208 kfree(argbuf);
209
210 return rc;
211 }
212
213 /**
214 * ata_task_ioctl - Handler for HDIO_DRIVE_TASK ioctl
215 * @scsidev: Device to which we are issuing command
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 */
224 int 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];
229 struct scsi_sense_hdr sshdr;
230
231 if (NULL == (void *)arg)
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
248 /* Good values for timeout and retries? Values below
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))
252 rc = -EIO;
253
254 /* Need code to retrieve data from check condition? */
255 return rc;
256 }
257
258 int 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
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
297 default:
298 rc = -ENOTTY;
299 break;
300 }
301
302 out:
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 */
327 struct 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) {
340 qc->__sg = (struct scatterlist *) cmd->request_buffer;
341 qc->n_elem = cmd->use_sg;
342 } else {
343 qc->__sg = &qc->sgent;
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
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 */
366 void 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
399 /**
400 * ata_to_sense_error - convert ATA error to SCSI error
401 * @id: ATA device number
402 * @drv_stat: value contained in ATA status register
403 * @drv_err: value contained in ATA error register
404 * @sk: the sense key we'll fill out
405 * @asc: the additional sense code we'll fill out
406 * @ascq: the additional sense code qualifier we'll fill out
407 *
408 * Converts an ATA error into a SCSI error. Fill out pointers to
409 * SK, ASC, and ASCQ bytes for later use in fixed or descriptor
410 * format sense blocks.
411 *
412 * LOCKING:
413 * spin_lock_irqsave(host_set lock)
414 */
415 void ata_to_sense_error(unsigned id, u8 drv_stat, u8 drv_err, u8 *sk, u8 *asc,
416 u8 *ascq)
417 {
418 int i;
419
420 /* Based on the 3ware driver translation table */
421 static unsigned char sense_table[][4] = {
422 /* BBD|ECC|ID|MAR */
423 {0xd1, ABORTED_COMMAND, 0x00, 0x00}, // Device busy Aborted command
424 /* BBD|ECC|ID */
425 {0xd0, ABORTED_COMMAND, 0x00, 0x00}, // Device busy Aborted command
426 /* ECC|MC|MARK */
427 {0x61, HARDWARE_ERROR, 0x00, 0x00}, // Device fault Hardware error
428 /* ICRC|ABRT */ /* NB: ICRC & !ABRT is BBD */
429 {0x84, ABORTED_COMMAND, 0x47, 0x00}, // Data CRC error SCSI parity error
430 /* MC|ID|ABRT|TRK0|MARK */
431 {0x37, NOT_READY, 0x04, 0x00}, // Unit offline Not ready
432 /* MCR|MARK */
433 {0x09, NOT_READY, 0x04, 0x00}, // Unrecovered disk error Not ready
434 /* Bad address mark */
435 {0x01, MEDIUM_ERROR, 0x13, 0x00}, // Address mark not found Address mark not found for data field
436 /* TRK0 */
437 {0x02, HARDWARE_ERROR, 0x00, 0x00}, // Track 0 not found Hardware error
438 /* Abort & !ICRC */
439 {0x04, ABORTED_COMMAND, 0x00, 0x00}, // Aborted command Aborted command
440 /* Media change request */
441 {0x08, NOT_READY, 0x04, 0x00}, // Media change request FIXME: faking offline
442 /* SRV */
443 {0x10, ABORTED_COMMAND, 0x14, 0x00}, // ID not found Recorded entity not found
444 /* Media change */
445 {0x08, NOT_READY, 0x04, 0x00}, // Media change FIXME: faking offline
446 /* ECC */
447 {0x40, MEDIUM_ERROR, 0x11, 0x04}, // Uncorrectable ECC error Unrecovered read error
448 /* BBD - block marked bad */
449 {0x80, MEDIUM_ERROR, 0x11, 0x04}, // Block marked bad Medium error, unrecovered read error
450 {0xFF, 0xFF, 0xFF, 0xFF}, // END mark
451 };
452 static unsigned char stat_table[][4] = {
453 /* Must be first because BUSY means no other bits valid */
454 {0x80, ABORTED_COMMAND, 0x47, 0x00}, // Busy, fake parity for now
455 {0x20, HARDWARE_ERROR, 0x00, 0x00}, // Device fault
456 {0x08, ABORTED_COMMAND, 0x47, 0x00}, // Timed out in xfer, fake parity for now
457 {0x04, RECOVERED_ERROR, 0x11, 0x00}, // Recovered ECC error Medium error, recovered
458 {0xFF, 0xFF, 0xFF, 0xFF}, // END mark
459 };
460
461 /*
462 * Is this an error we can process/parse
463 */
464 if (drv_stat & ATA_BUSY) {
465 drv_err = 0; /* Ignore the err bits, they're invalid */
466 }
467
468 if (drv_err) {
469 /* Look for drv_err */
470 for (i = 0; sense_table[i][0] != 0xFF; i++) {
471 /* Look for best matches first */
472 if ((sense_table[i][0] & drv_err) ==
473 sense_table[i][0]) {
474 *sk = sense_table[i][1];
475 *asc = sense_table[i][2];
476 *ascq = sense_table[i][3];
477 goto translate_done;
478 }
479 }
480 /* No immediate match */
481 printk(KERN_WARNING "ata%u: no sense translation for "
482 "error 0x%02x\n", id, drv_err);
483 }
484
485 /* Fall back to interpreting status bits */
486 for (i = 0; stat_table[i][0] != 0xFF; i++) {
487 if (stat_table[i][0] & drv_stat) {
488 *sk = stat_table[i][1];
489 *asc = stat_table[i][2];
490 *ascq = stat_table[i][3];
491 goto translate_done;
492 }
493 }
494 /* No error? Undecoded? */
495 printk(KERN_WARNING "ata%u: no sense translation for status: 0x%02x\n",
496 id, drv_stat);
497
498 /* For our last chance pick, use medium read error because
499 * it's much more common than an ATA drive telling you a write
500 * has failed.
501 */
502 *sk = MEDIUM_ERROR;
503 *asc = 0x11; /* "unrecovered read error" */
504 *ascq = 0x04; /* "auto-reallocation failed" */
505
506 translate_done:
507 printk(KERN_ERR "ata%u: translated ATA stat/err 0x%02x/%02x to "
508 "SCSI SK/ASC/ASCQ 0x%x/%02x/%02x\n", id, drv_stat, drv_err,
509 *sk, *asc, *ascq);
510 return;
511 }
512
513 /*
514 * ata_gen_ata_desc_sense - Generate check condition sense block.
515 * @qc: Command that completed.
516 *
517 * This function is specific to the ATA descriptor format sense
518 * block specified for the ATA pass through commands. Regardless
519 * of whether the command errored or not, return a sense
520 * block. Copy all controller registers into the sense
521 * block. Clear sense key, ASC & ASCQ if there is no error.
522 *
523 * LOCKING:
524 * spin_lock_irqsave(host_set lock)
525 */
526 void ata_gen_ata_desc_sense(struct ata_queued_cmd *qc)
527 {
528 struct scsi_cmnd *cmd = qc->scsicmd;
529 struct ata_taskfile *tf = &qc->tf;
530 unsigned char *sb = cmd->sense_buffer;
531 unsigned char *desc = sb + 8;
532
533 memset(sb, 0, SCSI_SENSE_BUFFERSIZE);
534
535 cmd->result = (DRIVER_SENSE << 24) | SAM_STAT_CHECK_CONDITION;
536
537 /*
538 * Read the controller registers.
539 */
540 assert(NULL != qc->ap->ops->tf_read);
541 qc->ap->ops->tf_read(qc->ap, tf);
542
543 /*
544 * Use ata_to_sense_error() to map status register bits
545 * onto sense key, asc & ascq.
546 */
547 if (tf->command & (ATA_BUSY | ATA_DF | ATA_ERR | ATA_DRQ)) {
548 ata_to_sense_error(qc->ap->id, tf->command, tf->feature,
549 &sb[1], &sb[2], &sb[3]);
550 sb[1] &= 0x0f;
551 }
552
553 /*
554 * Sense data is current and format is descriptor.
555 */
556 sb[0] = 0x72;
557
558 desc[0] = 0x09;
559
560 /*
561 * Set length of additional sense data.
562 * Since we only populate descriptor 0, the total
563 * length is the same (fixed) length as descriptor 0.
564 */
565 desc[1] = sb[7] = 14;
566
567 /*
568 * Copy registers into sense buffer.
569 */
570 desc[2] = 0x00;
571 desc[3] = tf->feature; /* == error reg */
572 desc[5] = tf->nsect;
573 desc[7] = tf->lbal;
574 desc[9] = tf->lbam;
575 desc[11] = tf->lbah;
576 desc[12] = tf->device;
577 desc[13] = tf->command; /* == status reg */
578
579 /*
580 * Fill in Extend bit, and the high order bytes
581 * if applicable.
582 */
583 if (tf->flags & ATA_TFLAG_LBA48) {
584 desc[2] |= 0x01;
585 desc[4] = tf->hob_nsect;
586 desc[6] = tf->hob_lbal;
587 desc[8] = tf->hob_lbam;
588 desc[10] = tf->hob_lbah;
589 }
590 }
591
592 /**
593 * ata_gen_fixed_sense - generate a SCSI fixed sense block
594 * @qc: Command that we are erroring out
595 *
596 * Leverage ata_to_sense_error() to give us the codes. Fit our
597 * LBA in here if there's room.
598 *
599 * LOCKING:
600 * inherited from caller
601 */
602 void ata_gen_fixed_sense(struct ata_queued_cmd *qc)
603 {
604 struct scsi_cmnd *cmd = qc->scsicmd;
605 struct ata_taskfile *tf = &qc->tf;
606 unsigned char *sb = cmd->sense_buffer;
607
608 memset(sb, 0, SCSI_SENSE_BUFFERSIZE);
609
610 cmd->result = (DRIVER_SENSE << 24) | SAM_STAT_CHECK_CONDITION;
611
612 /*
613 * Read the controller registers.
614 */
615 assert(NULL != qc->ap->ops->tf_read);
616 qc->ap->ops->tf_read(qc->ap, tf);
617
618 /*
619 * Use ata_to_sense_error() to map status register bits
620 * onto sense key, asc & ascq.
621 */
622 if (tf->command & (ATA_BUSY | ATA_DF | ATA_ERR | ATA_DRQ)) {
623 ata_to_sense_error(qc->ap->id, tf->command, tf->feature,
624 &sb[2], &sb[12], &sb[13]);
625 sb[2] &= 0x0f;
626 }
627
628 sb[0] = 0x70;
629 sb[7] = 0x0a;
630
631 if (tf->flags & ATA_TFLAG_LBA48) {
632 /* TODO: find solution for LBA48 descriptors */
633 }
634
635 else if (tf->flags & ATA_TFLAG_LBA) {
636 /* A small (28b) LBA will fit in the 32b info field */
637 sb[0] |= 0x80; /* set valid bit */
638 sb[3] = tf->device & 0x0f;
639 sb[4] = tf->lbah;
640 sb[5] = tf->lbam;
641 sb[6] = tf->lbal;
642 }
643
644 else {
645 /* TODO: C/H/S */
646 }
647 }
648
649 /**
650 * ata_scsi_slave_config - Set SCSI device attributes
651 * @sdev: SCSI device to examine
652 *
653 * This is called before we actually start reading
654 * and writing to the device, to configure certain
655 * SCSI mid-layer behaviors.
656 *
657 * LOCKING:
658 * Defined by SCSI layer. We don't really care.
659 */
660
661 int ata_scsi_slave_config(struct scsi_device *sdev)
662 {
663 sdev->use_10_for_rw = 1;
664 sdev->use_10_for_ms = 1;
665
666 blk_queue_max_phys_segments(sdev->request_queue, LIBATA_MAX_PRD);
667
668 if (sdev->id < ATA_MAX_DEVICES) {
669 struct ata_port *ap;
670 struct ata_device *dev;
671
672 ap = (struct ata_port *) &sdev->host->hostdata[0];
673 dev = &ap->device[sdev->id];
674
675 /* TODO: 1024 is an arbitrary number, not the
676 * hardware maximum. This should be increased to
677 * 65534 when Jens Axboe's patch for dynamically
678 * determining max_sectors is merged.
679 */
680 if ((dev->flags & ATA_DFLAG_LBA48) &&
681 ((dev->flags & ATA_DFLAG_LOCK_SECTORS) == 0)) {
682 /*
683 * do not overwrite sdev->host->max_sectors, since
684 * other drives on this host may not support LBA48
685 */
686 blk_queue_max_sectors(sdev->request_queue, 2048);
687 }
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
700 return 0; /* scsi layer doesn't check return value, sigh */
701 }
702
703 /**
704 * ata_scsi_error - SCSI layer error handler callback
705 * @host: SCSI host on which error occurred
706 *
707 * Handles SCSI-layer-thrown error events.
708 *
709 * LOCKING:
710 * Inherited from SCSI layer (none, can sleep)
711 *
712 * RETURNS:
713 * Zero.
714 */
715
716 int ata_scsi_error(struct Scsi_Host *host)
717 {
718 struct ata_port *ap;
719
720 DPRINTK("ENTER\n");
721
722 ap = (struct ata_port *) &host->hostdata[0];
723 ap->ops->eng_timeout(ap);
724
725 /* TODO: this is per-command; when queueing is supported
726 * this code will either change or move to a more
727 * appropriate place
728 */
729 host->host_failed--;
730 INIT_LIST_HEAD(&host->eh_cmd_q);
731
732 DPRINTK("EXIT\n");
733 return 0;
734 }
735
736 /**
737 * ata_scsi_start_stop_xlat - Translate SCSI START STOP UNIT command
738 * @qc: Storage for translated ATA taskfile
739 * @scsicmd: SCSI command to translate
740 *
741 * Sets up an ATA taskfile to issue STANDBY (to stop) or READ VERIFY
742 * (to start). Perhaps these commands should be preceded by
743 * CHECK POWER MODE to see what power mode the device is already in.
744 * [See SAT revision 5 at www.t10.org]
745 *
746 * LOCKING:
747 * spin_lock_irqsave(host_set lock)
748 *
749 * RETURNS:
750 * Zero on success, non-zero on error.
751 */
752
753 static unsigned int ata_scsi_start_stop_xlat(struct ata_queued_cmd *qc,
754 const u8 *scsicmd)
755 {
756 struct ata_taskfile *tf = &qc->tf;
757
758 tf->flags |= ATA_TFLAG_DEVICE | ATA_TFLAG_ISADDR;
759 tf->protocol = ATA_PROT_NODATA;
760 if (scsicmd[1] & 0x1) {
761 ; /* ignore IMMED bit, violates sat-r05 */
762 }
763 if (scsicmd[4] & 0x2)
764 goto invalid_fld; /* LOEJ bit set not supported */
765 if (((scsicmd[4] >> 4) & 0xf) != 0)
766 goto invalid_fld; /* power conditions not supported */
767 if (scsicmd[4] & 0x1) {
768 tf->nsect = 1; /* 1 sector, lba=0 */
769
770 if (qc->dev->flags & ATA_DFLAG_LBA) {
771 qc->tf.flags |= ATA_TFLAG_LBA;
772
773 tf->lbah = 0x0;
774 tf->lbam = 0x0;
775 tf->lbal = 0x0;
776 tf->device |= ATA_LBA;
777 } else {
778 /* CHS */
779 tf->lbal = 0x1; /* sect */
780 tf->lbam = 0x0; /* cyl low */
781 tf->lbah = 0x0; /* cyl high */
782 }
783
784 tf->command = ATA_CMD_VERIFY; /* READ VERIFY */
785 } else {
786 tf->nsect = 0; /* time period value (0 implies now) */
787 tf->command = ATA_CMD_STANDBY;
788 /* Consider: ATA STANDBY IMMEDIATE command */
789 }
790 /*
791 * Standby and Idle condition timers could be implemented but that
792 * would require libata to implement the Power condition mode page
793 * and allow the user to change it. Changing mode pages requires
794 * MODE SELECT to be implemented.
795 */
796
797 return 0;
798
799 invalid_fld:
800 ata_scsi_set_sense(qc->scsicmd, ILLEGAL_REQUEST, 0x24, 0x0);
801 /* "Invalid field in cbd" */
802 return 1;
803 }
804
805
806 /**
807 * ata_scsi_flush_xlat - Translate SCSI SYNCHRONIZE CACHE command
808 * @qc: Storage for translated ATA taskfile
809 * @scsicmd: SCSI command to translate (ignored)
810 *
811 * Sets up an ATA taskfile to issue FLUSH CACHE or
812 * FLUSH CACHE EXT.
813 *
814 * LOCKING:
815 * spin_lock_irqsave(host_set lock)
816 *
817 * RETURNS:
818 * Zero on success, non-zero on error.
819 */
820
821 static unsigned int ata_scsi_flush_xlat(struct ata_queued_cmd *qc, const u8 *scsicmd)
822 {
823 struct ata_taskfile *tf = &qc->tf;
824
825 tf->flags |= ATA_TFLAG_DEVICE;
826 tf->protocol = ATA_PROT_NODATA;
827
828 if ((qc->dev->flags & ATA_DFLAG_LBA48) &&
829 (ata_id_has_flush_ext(qc->dev->id)))
830 tf->command = ATA_CMD_FLUSH_EXT;
831 else
832 tf->command = ATA_CMD_FLUSH;
833
834 return 0;
835 }
836
837 /**
838 * scsi_6_lba_len - Get LBA and transfer length
839 * @scsicmd: SCSI command to translate
840 *
841 * Calculate LBA and transfer length for 6-byte commands.
842 *
843 * RETURNS:
844 * @plba: the LBA
845 * @plen: the transfer length
846 */
847
848 static void scsi_6_lba_len(const u8 *scsicmd, u64 *plba, u32 *plen)
849 {
850 u64 lba = 0;
851 u32 len = 0;
852
853 VPRINTK("six-byte command\n");
854
855 lba |= ((u64)scsicmd[2]) << 8;
856 lba |= ((u64)scsicmd[3]);
857
858 len |= ((u32)scsicmd[4]);
859
860 *plba = lba;
861 *plen = len;
862 }
863
864 /**
865 * scsi_10_lba_len - Get LBA and transfer length
866 * @scsicmd: SCSI command to translate
867 *
868 * Calculate LBA and transfer length for 10-byte commands.
869 *
870 * RETURNS:
871 * @plba: the LBA
872 * @plen: the transfer length
873 */
874
875 static void scsi_10_lba_len(const u8 *scsicmd, u64 *plba, u32 *plen)
876 {
877 u64 lba = 0;
878 u32 len = 0;
879
880 VPRINTK("ten-byte command\n");
881
882 lba |= ((u64)scsicmd[2]) << 24;
883 lba |= ((u64)scsicmd[3]) << 16;
884 lba |= ((u64)scsicmd[4]) << 8;
885 lba |= ((u64)scsicmd[5]);
886
887 len |= ((u32)scsicmd[7]) << 8;
888 len |= ((u32)scsicmd[8]);
889
890 *plba = lba;
891 *plen = len;
892 }
893
894 /**
895 * scsi_16_lba_len - Get LBA and transfer length
896 * @scsicmd: SCSI command to translate
897 *
898 * Calculate LBA and transfer length for 16-byte commands.
899 *
900 * RETURNS:
901 * @plba: the LBA
902 * @plen: the transfer length
903 */
904
905 static void scsi_16_lba_len(const u8 *scsicmd, u64 *plba, u32 *plen)
906 {
907 u64 lba = 0;
908 u32 len = 0;
909
910 VPRINTK("sixteen-byte command\n");
911
912 lba |= ((u64)scsicmd[2]) << 56;
913 lba |= ((u64)scsicmd[3]) << 48;
914 lba |= ((u64)scsicmd[4]) << 40;
915 lba |= ((u64)scsicmd[5]) << 32;
916 lba |= ((u64)scsicmd[6]) << 24;
917 lba |= ((u64)scsicmd[7]) << 16;
918 lba |= ((u64)scsicmd[8]) << 8;
919 lba |= ((u64)scsicmd[9]);
920
921 len |= ((u32)scsicmd[10]) << 24;
922 len |= ((u32)scsicmd[11]) << 16;
923 len |= ((u32)scsicmd[12]) << 8;
924 len |= ((u32)scsicmd[13]);
925
926 *plba = lba;
927 *plen = len;
928 }
929
930 /**
931 * ata_scsi_verify_xlat - Translate SCSI VERIFY command into an ATA one
932 * @qc: Storage for translated ATA taskfile
933 * @scsicmd: SCSI command to translate
934 *
935 * Converts SCSI VERIFY command to an ATA READ VERIFY command.
936 *
937 * LOCKING:
938 * spin_lock_irqsave(host_set lock)
939 *
940 * RETURNS:
941 * Zero on success, non-zero on error.
942 */
943
944 static unsigned int ata_scsi_verify_xlat(struct ata_queued_cmd *qc, const u8 *scsicmd)
945 {
946 struct ata_taskfile *tf = &qc->tf;
947 struct ata_device *dev = qc->dev;
948 u64 dev_sectors = qc->dev->n_sectors;
949 u64 block;
950 u32 n_block;
951
952 tf->flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
953 tf->protocol = ATA_PROT_NODATA;
954
955 if (scsicmd[0] == VERIFY)
956 scsi_10_lba_len(scsicmd, &block, &n_block);
957 else if (scsicmd[0] == VERIFY_16)
958 scsi_16_lba_len(scsicmd, &block, &n_block);
959 else
960 goto invalid_fld;
961
962 if (!n_block)
963 goto nothing_to_do;
964 if (block >= dev_sectors)
965 goto out_of_range;
966 if ((block + n_block) > dev_sectors)
967 goto out_of_range;
968
969 if (dev->flags & ATA_DFLAG_LBA) {
970 tf->flags |= ATA_TFLAG_LBA;
971
972 if (dev->flags & ATA_DFLAG_LBA48) {
973 if (n_block > (64 * 1024))
974 goto invalid_fld;
975
976 /* use LBA48 */
977 tf->flags |= ATA_TFLAG_LBA48;
978 tf->command = ATA_CMD_VERIFY_EXT;
979
980 tf->hob_nsect = (n_block >> 8) & 0xff;
981
982 tf->hob_lbah = (block >> 40) & 0xff;
983 tf->hob_lbam = (block >> 32) & 0xff;
984 tf->hob_lbal = (block >> 24) & 0xff;
985 } else {
986 if (n_block > 256)
987 goto invalid_fld;
988
989 /* use LBA28 */
990 tf->command = ATA_CMD_VERIFY;
991
992 tf->device |= (block >> 24) & 0xf;
993 }
994
995 tf->nsect = n_block & 0xff;
996
997 tf->lbah = (block >> 16) & 0xff;
998 tf->lbam = (block >> 8) & 0xff;
999 tf->lbal = block & 0xff;
1000
1001 tf->device |= ATA_LBA;
1002 } else {
1003 /* CHS */
1004 u32 sect, head, cyl, track;
1005
1006 if (n_block > 256)
1007 goto invalid_fld;
1008
1009 /* Convert LBA to CHS */
1010 track = (u32)block / dev->sectors;
1011 cyl = track / dev->heads;
1012 head = track % dev->heads;
1013 sect = (u32)block % dev->sectors + 1;
1014
1015 DPRINTK("block %u track %u cyl %u head %u sect %u\n",
1016 (u32)block, track, cyl, head, sect);
1017
1018 /* Check whether the converted CHS can fit.
1019 Cylinder: 0-65535
1020 Head: 0-15
1021 Sector: 1-255*/
1022 if ((cyl >> 16) || (head >> 4) || (sect >> 8) || (!sect))
1023 goto out_of_range;
1024
1025 tf->command = ATA_CMD_VERIFY;
1026 tf->nsect = n_block & 0xff; /* Sector count 0 means 256 sectors */
1027 tf->lbal = sect;
1028 tf->lbam = cyl;
1029 tf->lbah = cyl >> 8;
1030 tf->device |= head;
1031 }
1032
1033 return 0;
1034
1035 invalid_fld:
1036 ata_scsi_set_sense(qc->scsicmd, ILLEGAL_REQUEST, 0x24, 0x0);
1037 /* "Invalid field in cbd" */
1038 return 1;
1039
1040 out_of_range:
1041 ata_scsi_set_sense(qc->scsicmd, ILLEGAL_REQUEST, 0x21, 0x0);
1042 /* "Logical Block Address out of range" */
1043 return 1;
1044
1045 nothing_to_do:
1046 qc->scsicmd->result = SAM_STAT_GOOD;
1047 return 1;
1048 }
1049
1050 /**
1051 * ata_scsi_rw_xlat - Translate SCSI r/w command into an ATA one
1052 * @qc: Storage for translated ATA taskfile
1053 * @scsicmd: SCSI command to translate
1054 *
1055 * Converts any of six SCSI read/write commands into the
1056 * ATA counterpart, including starting sector (LBA),
1057 * sector count, and taking into account the device's LBA48
1058 * support.
1059 *
1060 * Commands %READ_6, %READ_10, %READ_16, %WRITE_6, %WRITE_10, and
1061 * %WRITE_16 are currently supported.
1062 *
1063 * LOCKING:
1064 * spin_lock_irqsave(host_set lock)
1065 *
1066 * RETURNS:
1067 * Zero on success, non-zero on error.
1068 */
1069
1070 static unsigned int ata_scsi_rw_xlat(struct ata_queued_cmd *qc, const u8 *scsicmd)
1071 {
1072 struct ata_taskfile *tf = &qc->tf;
1073 struct ata_device *dev = qc->dev;
1074 u64 block;
1075 u32 n_block;
1076
1077 tf->flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
1078
1079 if (scsicmd[0] == WRITE_10 || scsicmd[0] == WRITE_6 ||
1080 scsicmd[0] == WRITE_16)
1081 tf->flags |= ATA_TFLAG_WRITE;
1082
1083 /* Calculate the SCSI LBA and transfer length. */
1084 switch (scsicmd[0]) {
1085 case READ_10:
1086 case WRITE_10:
1087 scsi_10_lba_len(scsicmd, &block, &n_block);
1088 break;
1089 case READ_6:
1090 case WRITE_6:
1091 scsi_6_lba_len(scsicmd, &block, &n_block);
1092
1093 /* for 6-byte r/w commands, transfer length 0
1094 * means 256 blocks of data, not 0 block.
1095 */
1096 if (!n_block)
1097 n_block = 256;
1098 break;
1099 case READ_16:
1100 case WRITE_16:
1101 scsi_16_lba_len(scsicmd, &block, &n_block);
1102 break;
1103 default:
1104 DPRINTK("no-byte command\n");
1105 goto invalid_fld;
1106 }
1107
1108 /* Check and compose ATA command */
1109 if (!n_block)
1110 /* For 10-byte and 16-byte SCSI R/W commands, transfer
1111 * length 0 means transfer 0 block of data.
1112 * However, for ATA R/W commands, sector count 0 means
1113 * 256 or 65536 sectors, not 0 sectors as in SCSI.
1114 *
1115 * WARNING: one or two older ATA drives treat 0 as 0...
1116 */
1117 goto nothing_to_do;
1118
1119 if (dev->flags & ATA_DFLAG_LBA) {
1120 tf->flags |= ATA_TFLAG_LBA;
1121
1122 if (dev->flags & ATA_DFLAG_LBA48) {
1123 /* The request -may- be too large for LBA48. */
1124 if ((block >> 48) || (n_block > 65536))
1125 goto out_of_range;
1126
1127 /* use LBA48 */
1128 tf->flags |= ATA_TFLAG_LBA48;
1129
1130 tf->hob_nsect = (n_block >> 8) & 0xff;
1131
1132 tf->hob_lbah = (block >> 40) & 0xff;
1133 tf->hob_lbam = (block >> 32) & 0xff;
1134 tf->hob_lbal = (block >> 24) & 0xff;
1135 } else {
1136 /* use LBA28 */
1137
1138 /* The request -may- be too large for LBA28. */
1139 if ((block >> 28) || (n_block > 256))
1140 goto out_of_range;
1141
1142 tf->device |= (block >> 24) & 0xf;
1143 }
1144
1145 ata_rwcmd_protocol(qc);
1146
1147 qc->nsect = n_block;
1148 tf->nsect = n_block & 0xff;
1149
1150 tf->lbah = (block >> 16) & 0xff;
1151 tf->lbam = (block >> 8) & 0xff;
1152 tf->lbal = block & 0xff;
1153
1154 tf->device |= ATA_LBA;
1155 } else {
1156 /* CHS */
1157 u32 sect, head, cyl, track;
1158
1159 /* The request -may- be too large for CHS addressing. */
1160 if ((block >> 28) || (n_block > 256))
1161 goto out_of_range;
1162
1163 ata_rwcmd_protocol(qc);
1164
1165 /* Convert LBA to CHS */
1166 track = (u32)block / dev->sectors;
1167 cyl = track / dev->heads;
1168 head = track % dev->heads;
1169 sect = (u32)block % dev->sectors + 1;
1170
1171 DPRINTK("block %u track %u cyl %u head %u sect %u\n",
1172 (u32)block, track, cyl, head, sect);
1173
1174 /* Check whether the converted CHS can fit.
1175 Cylinder: 0-65535
1176 Head: 0-15
1177 Sector: 1-255*/
1178 if ((cyl >> 16) || (head >> 4) || (sect >> 8) || (!sect))
1179 goto out_of_range;
1180
1181 qc->nsect = n_block;
1182 tf->nsect = n_block & 0xff; /* Sector count 0 means 256 sectors */
1183 tf->lbal = sect;
1184 tf->lbam = cyl;
1185 tf->lbah = cyl >> 8;
1186 tf->device |= head;
1187 }
1188
1189 return 0;
1190
1191 invalid_fld:
1192 ata_scsi_set_sense(qc->scsicmd, ILLEGAL_REQUEST, 0x24, 0x0);
1193 /* "Invalid field in cbd" */
1194 return 1;
1195
1196 out_of_range:
1197 ata_scsi_set_sense(qc->scsicmd, ILLEGAL_REQUEST, 0x21, 0x0);
1198 /* "Logical Block Address out of range" */
1199 return 1;
1200
1201 nothing_to_do:
1202 qc->scsicmd->result = SAM_STAT_GOOD;
1203 return 1;
1204 }
1205
1206 static int ata_scsi_qc_complete(struct ata_queued_cmd *qc,
1207 unsigned int err_mask)
1208 {
1209 struct scsi_cmnd *cmd = qc->scsicmd;
1210 u8 *cdb = cmd->cmnd;
1211 int need_sense = (err_mask != 0);
1212
1213 /* For ATA pass thru (SAT) commands, generate a sense block if
1214 * user mandated it or if there's an error. Note that if we
1215 * generate because the user forced us to, a check condition
1216 * is generated and the ATA register values are returned
1217 * whether the command completed successfully or not. If there
1218 * was no error, SK, ASC and ASCQ will all be zero.
1219 */
1220 if (((cdb[0] == ATA_16) || (cdb[0] == ATA_12)) &&
1221 ((cdb[2] & 0x20) || need_sense)) {
1222 ata_gen_ata_desc_sense(qc);
1223 } else {
1224 if (!need_sense) {
1225 cmd->result = SAM_STAT_GOOD;
1226 } else {
1227 /* TODO: decide which descriptor format to use
1228 * for 48b LBA devices and call that here
1229 * instead of the fixed desc, which is only
1230 * good for smaller LBA (and maybe CHS?)
1231 * devices.
1232 */
1233 ata_gen_fixed_sense(qc);
1234 }
1235 }
1236
1237 if (need_sense) {
1238 /* The ata_gen_..._sense routines fill in tf */
1239 ata_dump_status(qc->ap->id, &qc->tf);
1240 }
1241
1242 qc->scsidone(cmd);
1243
1244 return 0;
1245 }
1246
1247 /**
1248 * ata_scsi_translate - Translate then issue SCSI command to ATA device
1249 * @ap: ATA port to which the command is addressed
1250 * @dev: ATA device to which the command is addressed
1251 * @cmd: SCSI command to execute
1252 * @done: SCSI command completion function
1253 * @xlat_func: Actor which translates @cmd to an ATA taskfile
1254 *
1255 * Our ->queuecommand() function has decided that the SCSI
1256 * command issued can be directly translated into an ATA
1257 * command, rather than handled internally.
1258 *
1259 * This function sets up an ata_queued_cmd structure for the
1260 * SCSI command, and sends that ata_queued_cmd to the hardware.
1261 *
1262 * The xlat_func argument (actor) returns 0 if ready to execute
1263 * ATA command, else 1 to finish translation. If 1 is returned
1264 * then cmd->result (and possibly cmd->sense_buffer) are assumed
1265 * to be set reflecting an error condition or clean (early)
1266 * termination.
1267 *
1268 * LOCKING:
1269 * spin_lock_irqsave(host_set lock)
1270 */
1271
1272 static void ata_scsi_translate(struct ata_port *ap, struct ata_device *dev,
1273 struct scsi_cmnd *cmd,
1274 void (*done)(struct scsi_cmnd *),
1275 ata_xlat_func_t xlat_func)
1276 {
1277 struct ata_queued_cmd *qc;
1278 u8 *scsicmd = cmd->cmnd;
1279
1280 VPRINTK("ENTER\n");
1281
1282 qc = ata_scsi_qc_new(ap, dev, cmd, done);
1283 if (!qc)
1284 goto err_mem;
1285
1286 /* data is present; dma-map it */
1287 if (cmd->sc_data_direction == DMA_FROM_DEVICE ||
1288 cmd->sc_data_direction == DMA_TO_DEVICE) {
1289 if (unlikely(cmd->request_bufflen < 1)) {
1290 printk(KERN_WARNING "ata%u(%u): WARNING: zero len r/w req\n",
1291 ap->id, dev->devno);
1292 goto err_did;
1293 }
1294
1295 if (cmd->use_sg)
1296 ata_sg_init(qc, cmd->request_buffer, cmd->use_sg);
1297 else
1298 ata_sg_init_one(qc, cmd->request_buffer,
1299 cmd->request_bufflen);
1300
1301 qc->dma_dir = cmd->sc_data_direction;
1302 }
1303
1304 qc->complete_fn = ata_scsi_qc_complete;
1305
1306 if (xlat_func(qc, scsicmd))
1307 goto early_finish;
1308
1309 /* select device, send command to hardware */
1310 if (ata_qc_issue(qc))
1311 goto err_did;
1312
1313 VPRINTK("EXIT\n");
1314 return;
1315
1316 early_finish:
1317 ata_qc_free(qc);
1318 done(cmd);
1319 DPRINTK("EXIT - early finish (good or error)\n");
1320 return;
1321
1322 err_did:
1323 ata_qc_free(qc);
1324 err_mem:
1325 cmd->result = (DID_ERROR << 16);
1326 done(cmd);
1327 DPRINTK("EXIT - internal\n");
1328 return;
1329 }
1330
1331 /**
1332 * ata_scsi_rbuf_get - Map response buffer.
1333 * @cmd: SCSI command containing buffer to be mapped.
1334 * @buf_out: Pointer to mapped area.
1335 *
1336 * Maps buffer contained within SCSI command @cmd.
1337 *
1338 * LOCKING:
1339 * spin_lock_irqsave(host_set lock)
1340 *
1341 * RETURNS:
1342 * Length of response buffer.
1343 */
1344
1345 static unsigned int ata_scsi_rbuf_get(struct scsi_cmnd *cmd, u8 **buf_out)
1346 {
1347 u8 *buf;
1348 unsigned int buflen;
1349
1350 if (cmd->use_sg) {
1351 struct scatterlist *sg;
1352
1353 sg = (struct scatterlist *) cmd->request_buffer;
1354 buf = kmap_atomic(sg->page, KM_USER0) + sg->offset;
1355 buflen = sg->length;
1356 } else {
1357 buf = cmd->request_buffer;
1358 buflen = cmd->request_bufflen;
1359 }
1360
1361 *buf_out = buf;
1362 return buflen;
1363 }
1364
1365 /**
1366 * ata_scsi_rbuf_put - Unmap response buffer.
1367 * @cmd: SCSI command containing buffer to be unmapped.
1368 * @buf: buffer to unmap
1369 *
1370 * Unmaps response buffer contained within @cmd.
1371 *
1372 * LOCKING:
1373 * spin_lock_irqsave(host_set lock)
1374 */
1375
1376 static inline void ata_scsi_rbuf_put(struct scsi_cmnd *cmd, u8 *buf)
1377 {
1378 if (cmd->use_sg) {
1379 struct scatterlist *sg;
1380
1381 sg = (struct scatterlist *) cmd->request_buffer;
1382 kunmap_atomic(buf - sg->offset, KM_USER0);
1383 }
1384 }
1385
1386 /**
1387 * ata_scsi_rbuf_fill - wrapper for SCSI command simulators
1388 * @args: device IDENTIFY data / SCSI command of interest.
1389 * @actor: Callback hook for desired SCSI command simulator
1390 *
1391 * Takes care of the hard work of simulating a SCSI command...
1392 * Mapping the response buffer, calling the command's handler,
1393 * and handling the handler's return value. This return value
1394 * indicates whether the handler wishes the SCSI command to be
1395 * completed successfully (0), or not (in which case cmd->result
1396 * and sense buffer are assumed to be set).
1397 *
1398 * LOCKING:
1399 * spin_lock_irqsave(host_set lock)
1400 */
1401
1402 void ata_scsi_rbuf_fill(struct ata_scsi_args *args,
1403 unsigned int (*actor) (struct ata_scsi_args *args,
1404 u8 *rbuf, unsigned int buflen))
1405 {
1406 u8 *rbuf;
1407 unsigned int buflen, rc;
1408 struct scsi_cmnd *cmd = args->cmd;
1409
1410 buflen = ata_scsi_rbuf_get(cmd, &rbuf);
1411 memset(rbuf, 0, buflen);
1412 rc = actor(args, rbuf, buflen);
1413 ata_scsi_rbuf_put(cmd, rbuf);
1414
1415 if (rc == 0)
1416 cmd->result = SAM_STAT_GOOD;
1417 args->done(cmd);
1418 }
1419
1420 /**
1421 * ata_scsiop_inq_std - Simulate INQUIRY command
1422 * @args: device IDENTIFY data / SCSI command of interest.
1423 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1424 * @buflen: Response buffer length.
1425 *
1426 * Returns standard device identification data associated
1427 * with non-EVPD INQUIRY command output.
1428 *
1429 * LOCKING:
1430 * spin_lock_irqsave(host_set lock)
1431 */
1432
1433 unsigned int ata_scsiop_inq_std(struct ata_scsi_args *args, u8 *rbuf,
1434 unsigned int buflen)
1435 {
1436 u8 hdr[] = {
1437 TYPE_DISK,
1438 0,
1439 0x5, /* claim SPC-3 version compatibility */
1440 2,
1441 95 - 4
1442 };
1443
1444 /* set scsi removeable (RMB) bit per ata bit */
1445 if (ata_id_removeable(args->id))
1446 hdr[1] |= (1 << 7);
1447
1448 VPRINTK("ENTER\n");
1449
1450 memcpy(rbuf, hdr, sizeof(hdr));
1451
1452 if (buflen > 35) {
1453 memcpy(&rbuf[8], "ATA ", 8);
1454 ata_dev_id_string(args->id, &rbuf[16], ATA_ID_PROD_OFS, 16);
1455 ata_dev_id_string(args->id, &rbuf[32], ATA_ID_FW_REV_OFS, 4);
1456 if (rbuf[32] == 0 || rbuf[32] == ' ')
1457 memcpy(&rbuf[32], "n/a ", 4);
1458 }
1459
1460 if (buflen > 63) {
1461 const u8 versions[] = {
1462 0x60, /* SAM-3 (no version claimed) */
1463
1464 0x03,
1465 0x20, /* SBC-2 (no version claimed) */
1466
1467 0x02,
1468 0x60 /* SPC-3 (no version claimed) */
1469 };
1470
1471 memcpy(rbuf + 59, versions, sizeof(versions));
1472 }
1473
1474 return 0;
1475 }
1476
1477 /**
1478 * ata_scsiop_inq_00 - Simulate INQUIRY EVPD page 0, list of pages
1479 * @args: device IDENTIFY data / SCSI command of interest.
1480 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1481 * @buflen: Response buffer length.
1482 *
1483 * Returns list of inquiry EVPD pages available.
1484 *
1485 * LOCKING:
1486 * spin_lock_irqsave(host_set lock)
1487 */
1488
1489 unsigned int ata_scsiop_inq_00(struct ata_scsi_args *args, u8 *rbuf,
1490 unsigned int buflen)
1491 {
1492 const u8 pages[] = {
1493 0x00, /* page 0x00, this page */
1494 0x80, /* page 0x80, unit serial no page */
1495 0x83 /* page 0x83, device ident page */
1496 };
1497 rbuf[3] = sizeof(pages); /* number of supported EVPD pages */
1498
1499 if (buflen > 6)
1500 memcpy(rbuf + 4, pages, sizeof(pages));
1501
1502 return 0;
1503 }
1504
1505 /**
1506 * ata_scsiop_inq_80 - Simulate INQUIRY EVPD page 80, device serial number
1507 * @args: device IDENTIFY data / SCSI command of interest.
1508 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1509 * @buflen: Response buffer length.
1510 *
1511 * Returns ATA device serial number.
1512 *
1513 * LOCKING:
1514 * spin_lock_irqsave(host_set lock)
1515 */
1516
1517 unsigned int ata_scsiop_inq_80(struct ata_scsi_args *args, u8 *rbuf,
1518 unsigned int buflen)
1519 {
1520 const u8 hdr[] = {
1521 0,
1522 0x80, /* this page code */
1523 0,
1524 ATA_SERNO_LEN, /* page len */
1525 };
1526 memcpy(rbuf, hdr, sizeof(hdr));
1527
1528 if (buflen > (ATA_SERNO_LEN + 4 - 1))
1529 ata_dev_id_string(args->id, (unsigned char *) &rbuf[4],
1530 ATA_ID_SERNO_OFS, ATA_SERNO_LEN);
1531
1532 return 0;
1533 }
1534
1535 static const char *inq_83_str = "Linux ATA-SCSI simulator";
1536
1537 /**
1538 * ata_scsiop_inq_83 - Simulate INQUIRY EVPD page 83, device identity
1539 * @args: device IDENTIFY data / SCSI command of interest.
1540 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1541 * @buflen: Response buffer length.
1542 *
1543 * Returns device identification. Currently hardcoded to
1544 * return "Linux ATA-SCSI simulator".
1545 *
1546 * LOCKING:
1547 * spin_lock_irqsave(host_set lock)
1548 */
1549
1550 unsigned int ata_scsiop_inq_83(struct ata_scsi_args *args, u8 *rbuf,
1551 unsigned int buflen)
1552 {
1553 rbuf[1] = 0x83; /* this page code */
1554 rbuf[3] = 4 + strlen(inq_83_str); /* page len */
1555
1556 /* our one and only identification descriptor (vendor-specific) */
1557 if (buflen > (strlen(inq_83_str) + 4 + 4 - 1)) {
1558 rbuf[4 + 0] = 2; /* code set: ASCII */
1559 rbuf[4 + 3] = strlen(inq_83_str);
1560 memcpy(rbuf + 4 + 4, inq_83_str, strlen(inq_83_str));
1561 }
1562
1563 return 0;
1564 }
1565
1566 /**
1567 * ata_scsiop_noop - Command handler that simply returns success.
1568 * @args: device IDENTIFY data / SCSI command of interest.
1569 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1570 * @buflen: Response buffer length.
1571 *
1572 * No operation. Simply returns success to caller, to indicate
1573 * that the caller should successfully complete this SCSI command.
1574 *
1575 * LOCKING:
1576 * spin_lock_irqsave(host_set lock)
1577 */
1578
1579 unsigned int ata_scsiop_noop(struct ata_scsi_args *args, u8 *rbuf,
1580 unsigned int buflen)
1581 {
1582 VPRINTK("ENTER\n");
1583 return 0;
1584 }
1585
1586 /**
1587 * ata_msense_push - Push data onto MODE SENSE data output buffer
1588 * @ptr_io: (input/output) Location to store more output data
1589 * @last: End of output data buffer
1590 * @buf: Pointer to BLOB being added to output buffer
1591 * @buflen: Length of BLOB
1592 *
1593 * Store MODE SENSE data on an output buffer.
1594 *
1595 * LOCKING:
1596 * None.
1597 */
1598
1599 static void ata_msense_push(u8 **ptr_io, const u8 *last,
1600 const u8 *buf, unsigned int buflen)
1601 {
1602 u8 *ptr = *ptr_io;
1603
1604 if ((ptr + buflen - 1) > last)
1605 return;
1606
1607 memcpy(ptr, buf, buflen);
1608
1609 ptr += buflen;
1610
1611 *ptr_io = ptr;
1612 }
1613
1614 /**
1615 * ata_msense_caching - Simulate MODE SENSE caching info page
1616 * @id: device IDENTIFY data
1617 * @ptr_io: (input/output) Location to store more output data
1618 * @last: End of output data buffer
1619 *
1620 * Generate a caching info page, which conditionally indicates
1621 * write caching to the SCSI layer, depending on device
1622 * capabilities.
1623 *
1624 * LOCKING:
1625 * None.
1626 */
1627
1628 static unsigned int ata_msense_caching(u16 *id, u8 **ptr_io,
1629 const u8 *last)
1630 {
1631 u8 page[CACHE_MPAGE_LEN];
1632
1633 memcpy(page, def_cache_mpage, sizeof(page));
1634 if (ata_id_wcache_enabled(id))
1635 page[2] |= (1 << 2); /* write cache enable */
1636 if (!ata_id_rahead_enabled(id))
1637 page[12] |= (1 << 5); /* disable read ahead */
1638
1639 ata_msense_push(ptr_io, last, page, sizeof(page));
1640 return sizeof(page);
1641 }
1642
1643 /**
1644 * ata_msense_ctl_mode - Simulate MODE SENSE control mode page
1645 * @dev: Device associated with this MODE SENSE command
1646 * @ptr_io: (input/output) Location to store more output data
1647 * @last: End of output data buffer
1648 *
1649 * Generate a generic MODE SENSE control mode page.
1650 *
1651 * LOCKING:
1652 * None.
1653 */
1654
1655 static unsigned int ata_msense_ctl_mode(u8 **ptr_io, const u8 *last)
1656 {
1657 ata_msense_push(ptr_io, last, def_control_mpage,
1658 sizeof(def_control_mpage));
1659 return sizeof(def_control_mpage);
1660 }
1661
1662 /**
1663 * ata_msense_rw_recovery - Simulate MODE SENSE r/w error recovery page
1664 * @dev: Device associated with this MODE SENSE command
1665 * @ptr_io: (input/output) Location to store more output data
1666 * @last: End of output data buffer
1667 *
1668 * Generate a generic MODE SENSE r/w error recovery page.
1669 *
1670 * LOCKING:
1671 * None.
1672 */
1673
1674 static unsigned int ata_msense_rw_recovery(u8 **ptr_io, const u8 *last)
1675 {
1676
1677 ata_msense_push(ptr_io, last, def_rw_recovery_mpage,
1678 sizeof(def_rw_recovery_mpage));
1679 return sizeof(def_rw_recovery_mpage);
1680 }
1681
1682 /**
1683 * ata_scsiop_mode_sense - Simulate MODE SENSE 6, 10 commands
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 * Simulate MODE SENSE commands. Assume this is invoked for direct
1689 * access devices (e.g. disks) only. There should be no block
1690 * descriptor for other device types.
1691 *
1692 * LOCKING:
1693 * spin_lock_irqsave(host_set lock)
1694 */
1695
1696 unsigned int ata_scsiop_mode_sense(struct ata_scsi_args *args, u8 *rbuf,
1697 unsigned int buflen)
1698 {
1699 u8 *scsicmd = args->cmd->cmnd, *p, *last;
1700 const u8 sat_blk_desc[] = {
1701 0, 0, 0, 0, /* number of blocks: sat unspecified */
1702 0,
1703 0, 0x2, 0x0 /* block length: 512 bytes */
1704 };
1705 u8 pg, spg;
1706 unsigned int ebd, page_control, six_byte, output_len, alloc_len, minlen;
1707
1708 VPRINTK("ENTER\n");
1709
1710 six_byte = (scsicmd[0] == MODE_SENSE);
1711 ebd = !(scsicmd[1] & 0x8); /* dbd bit inverted == edb */
1712 /*
1713 * LLBA bit in msense(10) ignored (compliant)
1714 */
1715
1716 page_control = scsicmd[2] >> 6;
1717 switch (page_control) {
1718 case 0: /* current */
1719 break; /* supported */
1720 case 3: /* saved */
1721 goto saving_not_supp;
1722 case 1: /* changeable */
1723 case 2: /* defaults */
1724 default:
1725 goto invalid_fld;
1726 }
1727
1728 if (six_byte) {
1729 output_len = 4 + (ebd ? 8 : 0);
1730 alloc_len = scsicmd[4];
1731 } else {
1732 output_len = 8 + (ebd ? 8 : 0);
1733 alloc_len = (scsicmd[7] << 8) + scsicmd[8];
1734 }
1735 minlen = (alloc_len < buflen) ? alloc_len : buflen;
1736
1737 p = rbuf + output_len;
1738 last = rbuf + minlen - 1;
1739
1740 pg = scsicmd[2] & 0x3f;
1741 spg = scsicmd[3];
1742 /*
1743 * No mode subpages supported (yet) but asking for _all_
1744 * subpages may be valid
1745 */
1746 if (spg && (spg != ALL_SUB_MPAGES))
1747 goto invalid_fld;
1748
1749 switch(pg) {
1750 case RW_RECOVERY_MPAGE:
1751 output_len += ata_msense_rw_recovery(&p, last);
1752 break;
1753
1754 case CACHE_MPAGE:
1755 output_len += ata_msense_caching(args->id, &p, last);
1756 break;
1757
1758 case CONTROL_MPAGE: {
1759 output_len += ata_msense_ctl_mode(&p, last);
1760 break;
1761 }
1762
1763 case ALL_MPAGES:
1764 output_len += ata_msense_rw_recovery(&p, last);
1765 output_len += ata_msense_caching(args->id, &p, last);
1766 output_len += ata_msense_ctl_mode(&p, last);
1767 break;
1768
1769 default: /* invalid page code */
1770 goto invalid_fld;
1771 }
1772
1773 if (minlen < 1)
1774 return 0;
1775 if (six_byte) {
1776 output_len--;
1777 rbuf[0] = output_len;
1778 if (ebd) {
1779 if (minlen > 3)
1780 rbuf[3] = sizeof(sat_blk_desc);
1781 if (minlen > 11)
1782 memcpy(rbuf + 4, sat_blk_desc,
1783 sizeof(sat_blk_desc));
1784 }
1785 } else {
1786 output_len -= 2;
1787 rbuf[0] = output_len >> 8;
1788 if (minlen > 1)
1789 rbuf[1] = output_len;
1790 if (ebd) {
1791 if (minlen > 7)
1792 rbuf[7] = sizeof(sat_blk_desc);
1793 if (minlen > 15)
1794 memcpy(rbuf + 8, sat_blk_desc,
1795 sizeof(sat_blk_desc));
1796 }
1797 }
1798 return 0;
1799
1800 invalid_fld:
1801 ata_scsi_set_sense(args->cmd, ILLEGAL_REQUEST, 0x24, 0x0);
1802 /* "Invalid field in cbd" */
1803 return 1;
1804
1805 saving_not_supp:
1806 ata_scsi_set_sense(args->cmd, ILLEGAL_REQUEST, 0x39, 0x0);
1807 /* "Saving parameters not supported" */
1808 return 1;
1809 }
1810
1811 /**
1812 * ata_scsiop_read_cap - Simulate READ CAPACITY[ 16] commands
1813 * @args: device IDENTIFY data / SCSI command of interest.
1814 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1815 * @buflen: Response buffer length.
1816 *
1817 * Simulate READ CAPACITY commands.
1818 *
1819 * LOCKING:
1820 * spin_lock_irqsave(host_set lock)
1821 */
1822
1823 unsigned int ata_scsiop_read_cap(struct ata_scsi_args *args, u8 *rbuf,
1824 unsigned int buflen)
1825 {
1826 u64 n_sectors;
1827 u32 tmp;
1828
1829 VPRINTK("ENTER\n");
1830
1831 if (ata_id_has_lba(args->id)) {
1832 if (ata_id_has_lba48(args->id))
1833 n_sectors = ata_id_u64(args->id, 100);
1834 else
1835 n_sectors = ata_id_u32(args->id, 60);
1836 } else {
1837 /* CHS default translation */
1838 n_sectors = args->id[1] * args->id[3] * args->id[6];
1839
1840 if (ata_id_current_chs_valid(args->id))
1841 /* CHS current translation */
1842 n_sectors = ata_id_u32(args->id, 57);
1843 }
1844
1845 n_sectors--; /* ATA TotalUserSectors - 1 */
1846
1847 if (args->cmd->cmnd[0] == READ_CAPACITY) {
1848 if( n_sectors >= 0xffffffffULL )
1849 tmp = 0xffffffff ; /* Return max count on overflow */
1850 else
1851 tmp = n_sectors ;
1852
1853 /* sector count, 32-bit */
1854 rbuf[0] = tmp >> (8 * 3);
1855 rbuf[1] = tmp >> (8 * 2);
1856 rbuf[2] = tmp >> (8 * 1);
1857 rbuf[3] = tmp;
1858
1859 /* sector size */
1860 tmp = ATA_SECT_SIZE;
1861 rbuf[6] = tmp >> 8;
1862 rbuf[7] = tmp;
1863
1864 } else {
1865 /* sector count, 64-bit */
1866 tmp = n_sectors >> (8 * 4);
1867 rbuf[2] = tmp >> (8 * 3);
1868 rbuf[3] = tmp >> (8 * 2);
1869 rbuf[4] = tmp >> (8 * 1);
1870 rbuf[5] = tmp;
1871 tmp = n_sectors;
1872 rbuf[6] = tmp >> (8 * 3);
1873 rbuf[7] = tmp >> (8 * 2);
1874 rbuf[8] = tmp >> (8 * 1);
1875 rbuf[9] = tmp;
1876
1877 /* sector size */
1878 tmp = ATA_SECT_SIZE;
1879 rbuf[12] = tmp >> 8;
1880 rbuf[13] = tmp;
1881 }
1882
1883 return 0;
1884 }
1885
1886 /**
1887 * ata_scsiop_report_luns - Simulate REPORT LUNS command
1888 * @args: device IDENTIFY data / SCSI command of interest.
1889 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1890 * @buflen: Response buffer length.
1891 *
1892 * Simulate REPORT LUNS command.
1893 *
1894 * LOCKING:
1895 * spin_lock_irqsave(host_set lock)
1896 */
1897
1898 unsigned int ata_scsiop_report_luns(struct ata_scsi_args *args, u8 *rbuf,
1899 unsigned int buflen)
1900 {
1901 VPRINTK("ENTER\n");
1902 rbuf[3] = 8; /* just one lun, LUN 0, size 8 bytes */
1903
1904 return 0;
1905 }
1906
1907 /**
1908 * ata_scsi_set_sense - Set SCSI sense data and status
1909 * @cmd: SCSI request to be handled
1910 * @sk: SCSI-defined sense key
1911 * @asc: SCSI-defined additional sense code
1912 * @ascq: SCSI-defined additional sense code qualifier
1913 *
1914 * Helper function that builds a valid fixed format, current
1915 * response code and the given sense key (sk), additional sense
1916 * code (asc) and additional sense code qualifier (ascq) with
1917 * a SCSI command status of %SAM_STAT_CHECK_CONDITION and
1918 * DRIVER_SENSE set in the upper bits of scsi_cmnd::result .
1919 *
1920 * LOCKING:
1921 * Not required
1922 */
1923
1924 void ata_scsi_set_sense(struct scsi_cmnd *cmd, u8 sk, u8 asc, u8 ascq)
1925 {
1926 cmd->result = (DRIVER_SENSE << 24) | SAM_STAT_CHECK_CONDITION;
1927
1928 cmd->sense_buffer[0] = 0x70; /* fixed format, current */
1929 cmd->sense_buffer[2] = sk;
1930 cmd->sense_buffer[7] = 18 - 8; /* additional sense length */
1931 cmd->sense_buffer[12] = asc;
1932 cmd->sense_buffer[13] = ascq;
1933 }
1934
1935 /**
1936 * ata_scsi_badcmd - End a SCSI request with an error
1937 * @cmd: SCSI request to be handled
1938 * @done: SCSI command completion function
1939 * @asc: SCSI-defined additional sense code
1940 * @ascq: SCSI-defined additional sense code qualifier
1941 *
1942 * Helper function that completes a SCSI command with
1943 * %SAM_STAT_CHECK_CONDITION, with a sense key %ILLEGAL_REQUEST
1944 * and the specified additional sense codes.
1945 *
1946 * LOCKING:
1947 * spin_lock_irqsave(host_set lock)
1948 */
1949
1950 void ata_scsi_badcmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *), u8 asc, u8 ascq)
1951 {
1952 DPRINTK("ENTER\n");
1953 ata_scsi_set_sense(cmd, ILLEGAL_REQUEST, asc, ascq);
1954
1955 done(cmd);
1956 }
1957
1958 static int atapi_sense_complete(struct ata_queued_cmd *qc,unsigned int err_mask)
1959 {
1960 if (err_mask && ((err_mask & AC_ERR_DEV) == 0))
1961 /* FIXME: not quite right; we don't want the
1962 * translation of taskfile registers into
1963 * a sense descriptors, since that's only
1964 * correct for ATA, not ATAPI
1965 */
1966 ata_gen_ata_desc_sense(qc);
1967
1968 qc->scsidone(qc->scsicmd);
1969 return 0;
1970 }
1971
1972 /* is it pointless to prefer PIO for "safety reasons"? */
1973 static inline int ata_pio_use_silly(struct ata_port *ap)
1974 {
1975 return (ap->flags & ATA_FLAG_PIO_DMA);
1976 }
1977
1978 static void atapi_request_sense(struct ata_queued_cmd *qc)
1979 {
1980 struct ata_port *ap = qc->ap;
1981 struct scsi_cmnd *cmd = qc->scsicmd;
1982
1983 DPRINTK("ATAPI request sense\n");
1984
1985 /* FIXME: is this needed? */
1986 memset(cmd->sense_buffer, 0, sizeof(cmd->sense_buffer));
1987
1988 ap->ops->tf_read(ap, &qc->tf);
1989
1990 /* fill these in, for the case where they are -not- overwritten */
1991 cmd->sense_buffer[0] = 0x70;
1992 cmd->sense_buffer[2] = qc->tf.feature >> 4;
1993
1994 ata_qc_reinit(qc);
1995
1996 ata_sg_init_one(qc, cmd->sense_buffer, sizeof(cmd->sense_buffer));
1997 qc->dma_dir = DMA_FROM_DEVICE;
1998
1999 memset(&qc->cdb, 0, ap->cdb_len);
2000 qc->cdb[0] = REQUEST_SENSE;
2001 qc->cdb[4] = SCSI_SENSE_BUFFERSIZE;
2002
2003 qc->tf.flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
2004 qc->tf.command = ATA_CMD_PACKET;
2005
2006 if (ata_pio_use_silly(ap)) {
2007 qc->tf.protocol = ATA_PROT_ATAPI_DMA;
2008 qc->tf.feature |= ATAPI_PKT_DMA;
2009 } else {
2010 qc->tf.protocol = ATA_PROT_ATAPI;
2011 qc->tf.lbam = (8 * 1024) & 0xff;
2012 qc->tf.lbah = (8 * 1024) >> 8;
2013 }
2014 qc->nbytes = SCSI_SENSE_BUFFERSIZE;
2015
2016 qc->complete_fn = atapi_sense_complete;
2017
2018 if (ata_qc_issue(qc))
2019 ata_qc_complete(qc, AC_ERR_OTHER);
2020
2021 DPRINTK("EXIT\n");
2022 }
2023
2024 static int atapi_qc_complete(struct ata_queued_cmd *qc, unsigned int err_mask)
2025 {
2026 struct scsi_cmnd *cmd = qc->scsicmd;
2027
2028 VPRINTK("ENTER, err_mask 0x%X\n", err_mask);
2029
2030 if (unlikely(err_mask & AC_ERR_DEV)) {
2031 cmd->result = SAM_STAT_CHECK_CONDITION;
2032 atapi_request_sense(qc);
2033 return 1;
2034 }
2035
2036 else if (unlikely(err_mask))
2037 /* FIXME: not quite right; we don't want the
2038 * translation of taskfile registers into
2039 * a sense descriptors, since that's only
2040 * correct for ATA, not ATAPI
2041 */
2042 ata_gen_ata_desc_sense(qc);
2043
2044 else {
2045 u8 *scsicmd = cmd->cmnd;
2046
2047 if (scsicmd[0] == INQUIRY) {
2048 u8 *buf = NULL;
2049 unsigned int buflen;
2050
2051 buflen = ata_scsi_rbuf_get(cmd, &buf);
2052
2053 /* ATAPI devices typically report zero for their SCSI version,
2054 * and sometimes deviate from the spec WRT response data
2055 * format. If SCSI version is reported as zero like normal,
2056 * then we make the following fixups: 1) Fake MMC-5 version,
2057 * to indicate to the Linux scsi midlayer this is a modern
2058 * device. 2) Ensure response data format / ATAPI information
2059 * are always correct.
2060 */
2061 /* FIXME: do we ever override EVPD pages and the like, with
2062 * this code?
2063 */
2064 if (buf[2] == 0) {
2065 buf[2] = 0x5;
2066 buf[3] = 0x32;
2067 }
2068
2069 ata_scsi_rbuf_put(cmd, buf);
2070 }
2071
2072 cmd->result = SAM_STAT_GOOD;
2073 }
2074
2075 qc->scsidone(cmd);
2076 return 0;
2077 }
2078 /**
2079 * atapi_xlat - Initialize PACKET taskfile
2080 * @qc: command structure to be initialized
2081 * @scsicmd: SCSI CDB associated with this PACKET command
2082 *
2083 * LOCKING:
2084 * spin_lock_irqsave(host_set lock)
2085 *
2086 * RETURNS:
2087 * Zero on success, non-zero on failure.
2088 */
2089
2090 static unsigned int atapi_xlat(struct ata_queued_cmd *qc, const u8 *scsicmd)
2091 {
2092 struct scsi_cmnd *cmd = qc->scsicmd;
2093 struct ata_device *dev = qc->dev;
2094 int using_pio = (dev->flags & ATA_DFLAG_PIO);
2095 int nodata = (cmd->sc_data_direction == DMA_NONE);
2096
2097 if (!using_pio)
2098 /* Check whether ATAPI DMA is safe */
2099 if (ata_check_atapi_dma(qc))
2100 using_pio = 1;
2101
2102 memcpy(&qc->cdb, scsicmd, qc->ap->cdb_len);
2103
2104 qc->complete_fn = atapi_qc_complete;
2105
2106 qc->tf.flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
2107 if (cmd->sc_data_direction == DMA_TO_DEVICE) {
2108 qc->tf.flags |= ATA_TFLAG_WRITE;
2109 DPRINTK("direction: write\n");
2110 }
2111
2112 qc->tf.command = ATA_CMD_PACKET;
2113
2114 /* no data, or PIO data xfer */
2115 if (using_pio || nodata) {
2116 if (nodata)
2117 qc->tf.protocol = ATA_PROT_ATAPI_NODATA;
2118 else
2119 qc->tf.protocol = ATA_PROT_ATAPI;
2120 qc->tf.lbam = (8 * 1024) & 0xff;
2121 qc->tf.lbah = (8 * 1024) >> 8;
2122 }
2123
2124 /* DMA data xfer */
2125 else {
2126 qc->tf.protocol = ATA_PROT_ATAPI_DMA;
2127 qc->tf.feature |= ATAPI_PKT_DMA;
2128
2129 #ifdef ATAPI_ENABLE_DMADIR
2130 /* some SATA bridges need us to indicate data xfer direction */
2131 if (cmd->sc_data_direction != DMA_TO_DEVICE)
2132 qc->tf.feature |= ATAPI_DMADIR;
2133 #endif
2134 }
2135
2136 qc->nbytes = cmd->bufflen;
2137
2138 return 0;
2139 }
2140
2141 /**
2142 * ata_scsi_find_dev - lookup ata_device from scsi_cmnd
2143 * @ap: ATA port to which the device is attached
2144 * @scsidev: SCSI device from which we derive the ATA device
2145 *
2146 * Given various information provided in struct scsi_cmnd,
2147 * map that onto an ATA bus, and using that mapping
2148 * determine which ata_device is associated with the
2149 * SCSI command to be sent.
2150 *
2151 * LOCKING:
2152 * spin_lock_irqsave(host_set lock)
2153 *
2154 * RETURNS:
2155 * Associated ATA device, or %NULL if not found.
2156 */
2157
2158 static struct ata_device *
2159 ata_scsi_find_dev(struct ata_port *ap, const struct scsi_device *scsidev)
2160 {
2161 struct ata_device *dev;
2162
2163 /* skip commands not addressed to targets we simulate */
2164 if (likely(scsidev->id < ATA_MAX_DEVICES))
2165 dev = &ap->device[scsidev->id];
2166 else
2167 return NULL;
2168
2169 if (unlikely((scsidev->channel != 0) ||
2170 (scsidev->lun != 0)))
2171 return NULL;
2172
2173 if (unlikely(!ata_dev_present(dev)))
2174 return NULL;
2175
2176 if (!atapi_enabled) {
2177 if (unlikely(dev->class == ATA_DEV_ATAPI))
2178 return NULL;
2179 }
2180
2181 return dev;
2182 }
2183
2184 /*
2185 * ata_scsi_map_proto - Map pass-thru protocol value to taskfile value.
2186 * @byte1: Byte 1 from pass-thru CDB.
2187 *
2188 * RETURNS:
2189 * ATA_PROT_UNKNOWN if mapping failed/unimplemented, protocol otherwise.
2190 */
2191 static u8
2192 ata_scsi_map_proto(u8 byte1)
2193 {
2194 switch((byte1 & 0x1e) >> 1) {
2195 case 3: /* Non-data */
2196 return ATA_PROT_NODATA;
2197
2198 case 6: /* DMA */
2199 return ATA_PROT_DMA;
2200
2201 case 4: /* PIO Data-in */
2202 case 5: /* PIO Data-out */
2203 if (byte1 & 0xe0) {
2204 return ATA_PROT_PIO_MULT;
2205 }
2206 return ATA_PROT_PIO;
2207
2208 case 10: /* Device Reset */
2209 case 0: /* Hard Reset */
2210 case 1: /* SRST */
2211 case 2: /* Bus Idle */
2212 case 7: /* Packet */
2213 case 8: /* DMA Queued */
2214 case 9: /* Device Diagnostic */
2215 case 11: /* UDMA Data-in */
2216 case 12: /* UDMA Data-Out */
2217 case 13: /* FPDMA */
2218 default: /* Reserved */
2219 break;
2220 }
2221
2222 return ATA_PROT_UNKNOWN;
2223 }
2224
2225 /**
2226 * ata_scsi_pass_thru - convert ATA pass-thru CDB to taskfile
2227 * @qc: command structure to be initialized
2228 * @scsicmd: SCSI command to convert
2229 *
2230 * Handles either 12 or 16-byte versions of the CDB.
2231 *
2232 * RETURNS:
2233 * Zero on success, non-zero on failure.
2234 */
2235 static unsigned int
2236 ata_scsi_pass_thru(struct ata_queued_cmd *qc, const u8 *scsicmd)
2237 {
2238 struct ata_taskfile *tf = &(qc->tf);
2239 struct scsi_cmnd *cmd = qc->scsicmd;
2240
2241 if ((tf->protocol = ata_scsi_map_proto(scsicmd[1])) == ATA_PROT_UNKNOWN)
2242 goto invalid_fld;
2243
2244 /*
2245 * 12 and 16 byte CDBs use different offsets to
2246 * provide the various register values.
2247 */
2248 if (scsicmd[0] == ATA_16) {
2249 /*
2250 * 16-byte CDB - may contain extended commands.
2251 *
2252 * If that is the case, copy the upper byte register values.
2253 */
2254 if (scsicmd[1] & 0x01) {
2255 tf->hob_feature = scsicmd[3];
2256 tf->hob_nsect = scsicmd[5];
2257 tf->hob_lbal = scsicmd[7];
2258 tf->hob_lbam = scsicmd[9];
2259 tf->hob_lbah = scsicmd[11];
2260 tf->flags |= ATA_TFLAG_LBA48;
2261 } else
2262 tf->flags &= ~ATA_TFLAG_LBA48;
2263
2264 /*
2265 * Always copy low byte, device and command registers.
2266 */
2267 tf->feature = scsicmd[4];
2268 tf->nsect = scsicmd[6];
2269 tf->lbal = scsicmd[8];
2270 tf->lbam = scsicmd[10];
2271 tf->lbah = scsicmd[12];
2272 tf->device = scsicmd[13];
2273 tf->command = scsicmd[14];
2274 } else {
2275 /*
2276 * 12-byte CDB - incapable of extended commands.
2277 */
2278 tf->flags &= ~ATA_TFLAG_LBA48;
2279
2280 tf->feature = scsicmd[3];
2281 tf->nsect = scsicmd[4];
2282 tf->lbal = scsicmd[5];
2283 tf->lbam = scsicmd[6];
2284 tf->lbah = scsicmd[7];
2285 tf->device = scsicmd[8];
2286 tf->command = scsicmd[9];
2287 }
2288 /*
2289 * If slave is possible, enforce correct master/slave bit
2290 */
2291 if (qc->ap->flags & ATA_FLAG_SLAVE_POSS)
2292 tf->device = qc->dev->devno ?
2293 tf->device | ATA_DEV1 : tf->device & ~ATA_DEV1;
2294
2295 /*
2296 * Filter SET_FEATURES - XFER MODE command -- otherwise,
2297 * SET_FEATURES - XFER MODE must be preceded/succeeded
2298 * by an update to hardware-specific registers for each
2299 * controller (i.e. the reason for ->set_piomode(),
2300 * ->set_dmamode(), and ->post_set_mode() hooks).
2301 */
2302 if ((tf->command == ATA_CMD_SET_FEATURES)
2303 && (tf->feature == SETFEATURES_XFER))
2304 goto invalid_fld;
2305
2306 /*
2307 * Set flags so that all registers will be written,
2308 * and pass on write indication (used for PIO/DMA
2309 * setup.)
2310 */
2311 tf->flags |= (ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE);
2312
2313 if (cmd->sc_data_direction == DMA_TO_DEVICE)
2314 tf->flags |= ATA_TFLAG_WRITE;
2315
2316 /*
2317 * Set transfer length.
2318 *
2319 * TODO: find out if we need to do more here to
2320 * cover scatter/gather case.
2321 */
2322 qc->nsect = cmd->bufflen / ATA_SECT_SIZE;
2323
2324 return 0;
2325
2326 invalid_fld:
2327 ata_scsi_set_sense(qc->scsicmd, ILLEGAL_REQUEST, 0x24, 0x00);
2328 /* "Invalid field in cdb" */
2329 return 1;
2330 }
2331
2332 /**
2333 * ata_get_xlat_func - check if SCSI to ATA translation is possible
2334 * @dev: ATA device
2335 * @cmd: SCSI command opcode to consider
2336 *
2337 * Look up the SCSI command given, and determine whether the
2338 * SCSI command is to be translated or simulated.
2339 *
2340 * RETURNS:
2341 * Pointer to translation function if possible, %NULL if not.
2342 */
2343
2344 static inline ata_xlat_func_t ata_get_xlat_func(struct ata_device *dev, u8 cmd)
2345 {
2346 switch (cmd) {
2347 case READ_6:
2348 case READ_10:
2349 case READ_16:
2350
2351 case WRITE_6:
2352 case WRITE_10:
2353 case WRITE_16:
2354 return ata_scsi_rw_xlat;
2355
2356 case SYNCHRONIZE_CACHE:
2357 if (ata_try_flush_cache(dev))
2358 return ata_scsi_flush_xlat;
2359 break;
2360
2361 case VERIFY:
2362 case VERIFY_16:
2363 return ata_scsi_verify_xlat;
2364
2365 case ATA_12:
2366 case ATA_16:
2367 return ata_scsi_pass_thru;
2368
2369 case START_STOP:
2370 return ata_scsi_start_stop_xlat;
2371 }
2372
2373 return NULL;
2374 }
2375
2376 /**
2377 * ata_scsi_dump_cdb - dump SCSI command contents to dmesg
2378 * @ap: ATA port to which the command was being sent
2379 * @cmd: SCSI command to dump
2380 *
2381 * Prints the contents of a SCSI command via printk().
2382 */
2383
2384 static inline void ata_scsi_dump_cdb(struct ata_port *ap,
2385 struct scsi_cmnd *cmd)
2386 {
2387 #ifdef ATA_DEBUG
2388 struct scsi_device *scsidev = cmd->device;
2389 u8 *scsicmd = cmd->cmnd;
2390
2391 DPRINTK("CDB (%u:%d,%d,%d) %02x %02x %02x %02x %02x %02x %02x %02x %02x\n",
2392 ap->id,
2393 scsidev->channel, scsidev->id, scsidev->lun,
2394 scsicmd[0], scsicmd[1], scsicmd[2], scsicmd[3],
2395 scsicmd[4], scsicmd[5], scsicmd[6], scsicmd[7],
2396 scsicmd[8]);
2397 #endif
2398 }
2399
2400 /**
2401 * ata_scsi_queuecmd - Issue SCSI cdb to libata-managed device
2402 * @cmd: SCSI command to be sent
2403 * @done: Completion function, called when command is complete
2404 *
2405 * In some cases, this function translates SCSI commands into
2406 * ATA taskfiles, and queues the taskfiles to be sent to
2407 * hardware. In other cases, this function simulates a
2408 * SCSI device by evaluating and responding to certain
2409 * SCSI commands. This creates the overall effect of
2410 * ATA and ATAPI devices appearing as SCSI devices.
2411 *
2412 * LOCKING:
2413 * Releases scsi-layer-held lock, and obtains host_set lock.
2414 *
2415 * RETURNS:
2416 * Zero.
2417 */
2418
2419 int ata_scsi_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *))
2420 {
2421 struct ata_port *ap;
2422 struct ata_device *dev;
2423 struct scsi_device *scsidev = cmd->device;
2424 struct Scsi_Host *shost = scsidev->host;
2425
2426 ap = (struct ata_port *) &shost->hostdata[0];
2427
2428 spin_unlock(shost->host_lock);
2429 spin_lock(&ap->host_set->lock);
2430
2431 ata_scsi_dump_cdb(ap, cmd);
2432
2433 dev = ata_scsi_find_dev(ap, scsidev);
2434 if (unlikely(!dev)) {
2435 cmd->result = (DID_BAD_TARGET << 16);
2436 done(cmd);
2437 goto out_unlock;
2438 }
2439
2440 if (dev->class == ATA_DEV_ATA) {
2441 ata_xlat_func_t xlat_func = ata_get_xlat_func(dev,
2442 cmd->cmnd[0]);
2443
2444 if (xlat_func)
2445 ata_scsi_translate(ap, dev, cmd, done, xlat_func);
2446 else
2447 ata_scsi_simulate(dev->id, cmd, done);
2448 } else
2449 ata_scsi_translate(ap, dev, cmd, done, atapi_xlat);
2450
2451 out_unlock:
2452 spin_unlock(&ap->host_set->lock);
2453 spin_lock(shost->host_lock);
2454 return 0;
2455 }
2456
2457 /**
2458 * ata_scsi_simulate - simulate SCSI command on ATA device
2459 * @id: current IDENTIFY data for target device.
2460 * @cmd: SCSI command being sent to device.
2461 * @done: SCSI command completion function.
2462 *
2463 * Interprets and directly executes a select list of SCSI commands
2464 * that can be handled internally.
2465 *
2466 * LOCKING:
2467 * spin_lock_irqsave(host_set lock)
2468 */
2469
2470 void ata_scsi_simulate(u16 *id,
2471 struct scsi_cmnd *cmd,
2472 void (*done)(struct scsi_cmnd *))
2473 {
2474 struct ata_scsi_args args;
2475 const u8 *scsicmd = cmd->cmnd;
2476
2477 args.id = id;
2478 args.cmd = cmd;
2479 args.done = done;
2480
2481 switch(scsicmd[0]) {
2482 /* no-op's, complete with success */
2483 case SYNCHRONIZE_CACHE:
2484 case REZERO_UNIT:
2485 case SEEK_6:
2486 case SEEK_10:
2487 case TEST_UNIT_READY:
2488 case FORMAT_UNIT: /* FIXME: correct? */
2489 case SEND_DIAGNOSTIC: /* FIXME: correct? */
2490 ata_scsi_rbuf_fill(&args, ata_scsiop_noop);
2491 break;
2492
2493 case INQUIRY:
2494 if (scsicmd[1] & 2) /* is CmdDt set? */
2495 ata_scsi_invalid_field(cmd, done);
2496 else if ((scsicmd[1] & 1) == 0) /* is EVPD clear? */
2497 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_std);
2498 else if (scsicmd[2] == 0x00)
2499 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_00);
2500 else if (scsicmd[2] == 0x80)
2501 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_80);
2502 else if (scsicmd[2] == 0x83)
2503 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_83);
2504 else
2505 ata_scsi_invalid_field(cmd, done);
2506 break;
2507
2508 case MODE_SENSE:
2509 case MODE_SENSE_10:
2510 ata_scsi_rbuf_fill(&args, ata_scsiop_mode_sense);
2511 break;
2512
2513 case MODE_SELECT: /* unconditionally return */
2514 case MODE_SELECT_10: /* bad-field-in-cdb */
2515 ata_scsi_invalid_field(cmd, done);
2516 break;
2517
2518 case READ_CAPACITY:
2519 ata_scsi_rbuf_fill(&args, ata_scsiop_read_cap);
2520 break;
2521
2522 case SERVICE_ACTION_IN:
2523 if ((scsicmd[1] & 0x1f) == SAI_READ_CAPACITY_16)
2524 ata_scsi_rbuf_fill(&args, ata_scsiop_read_cap);
2525 else
2526 ata_scsi_invalid_field(cmd, done);
2527 break;
2528
2529 case REPORT_LUNS:
2530 ata_scsi_rbuf_fill(&args, ata_scsiop_report_luns);
2531 break;
2532
2533 /* mandatory commands we haven't implemented yet */
2534 case REQUEST_SENSE:
2535
2536 /* all other commands */
2537 default:
2538 ata_scsi_set_sense(cmd, ILLEGAL_REQUEST, 0x20, 0x0);
2539 /* "Invalid command operation code" */
2540 done(cmd);
2541 break;
2542 }
2543 }
2544
2545 void ata_scsi_scan_host(struct ata_port *ap)
2546 {
2547 struct ata_device *dev;
2548 unsigned int i;
2549
2550 if (ap->flags & ATA_FLAG_PORT_DISABLED)
2551 return;
2552
2553 for (i = 0; i < ATA_MAX_DEVICES; i++) {
2554 dev = &ap->device[i];
2555
2556 if (ata_dev_present(dev))
2557 scsi_scan_target(&ap->host->shost_gendev, 0, i, 0, 0);
2558 }
2559 }
2560
linux v2.6.22.y-op