projects / deliverable / linux.git / blob
? search:


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