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