]> git.proxmox.com Git - mirror_ubuntu-artful-kernel.git/blob - drivers/ata/libata-scsi.c
block: restore the meaning of rq->data_len to the true data length
[mirror_ubuntu-artful-kernel.git] / drivers / ata / 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_cmnd.h>
42 #include <scsi/scsi_eh.h>
43 #include <scsi/scsi_device.h>
44 #include <scsi/scsi_tcq.h>
45 #include <scsi/scsi_transport.h>
46 #include <linux/libata.h>
47 #include <linux/hdreg.h>
48 #include <linux/uaccess.h>
49
50 #include "libata.h"
51
52 #define SECTOR_SIZE 512
53
54 typedef unsigned int (*ata_xlat_func_t)(struct ata_queued_cmd *qc);
55
56 static struct ata_device *__ata_scsi_find_dev(struct ata_port *ap,
57 const struct scsi_device *scsidev);
58 static struct ata_device *ata_scsi_find_dev(struct ata_port *ap,
59 const struct scsi_device *scsidev);
60 static int ata_scsi_user_scan(struct Scsi_Host *shost, unsigned int channel,
61 unsigned int id, unsigned int lun);
62
63
64 #define RW_RECOVERY_MPAGE 0x1
65 #define RW_RECOVERY_MPAGE_LEN 12
66 #define CACHE_MPAGE 0x8
67 #define CACHE_MPAGE_LEN 20
68 #define CONTROL_MPAGE 0xa
69 #define CONTROL_MPAGE_LEN 12
70 #define ALL_MPAGES 0x3f
71 #define ALL_SUB_MPAGES 0xff
72
73
74 static const u8 def_rw_recovery_mpage[RW_RECOVERY_MPAGE_LEN] = {
75 RW_RECOVERY_MPAGE,
76 RW_RECOVERY_MPAGE_LEN - 2,
77 (1 << 7), /* AWRE */
78 0, /* read retry count */
79 0, 0, 0, 0,
80 0, /* write retry count */
81 0, 0, 0
82 };
83
84 static const u8 def_cache_mpage[CACHE_MPAGE_LEN] = {
85 CACHE_MPAGE,
86 CACHE_MPAGE_LEN - 2,
87 0, /* contains WCE, needs to be 0 for logic */
88 0, 0, 0, 0, 0, 0, 0, 0, 0,
89 0, /* contains DRA, needs to be 0 for logic */
90 0, 0, 0, 0, 0, 0, 0
91 };
92
93 static const u8 def_control_mpage[CONTROL_MPAGE_LEN] = {
94 CONTROL_MPAGE,
95 CONTROL_MPAGE_LEN - 2,
96 2, /* DSENSE=0, GLTSD=1 */
97 0, /* [QAM+QERR may be 1, see 05-359r1] */
98 0, 0, 0, 0, 0xff, 0xff,
99 0, 30 /* extended self test time, see 05-359r1 */
100 };
101
102 /*
103 * libata transport template. libata doesn't do real transport stuff.
104 * It just needs the eh_timed_out hook.
105 */
106 static struct scsi_transport_template ata_scsi_transport_template = {
107 .eh_strategy_handler = ata_scsi_error,
108 .eh_timed_out = ata_scsi_timed_out,
109 .user_scan = ata_scsi_user_scan,
110 };
111
112
113 static const struct {
114 enum link_pm value;
115 const char *name;
116 } link_pm_policy[] = {
117 { NOT_AVAILABLE, "max_performance" },
118 { MIN_POWER, "min_power" },
119 { MAX_PERFORMANCE, "max_performance" },
120 { MEDIUM_POWER, "medium_power" },
121 };
122
123 static const char *ata_scsi_lpm_get(enum link_pm policy)
124 {
125 int i;
126
127 for (i = 0; i < ARRAY_SIZE(link_pm_policy); i++)
128 if (link_pm_policy[i].value == policy)
129 return link_pm_policy[i].name;
130
131 return NULL;
132 }
133
134 static ssize_t ata_scsi_lpm_put(struct class_device *class_dev,
135 const char *buf, size_t count)
136 {
137 struct Scsi_Host *shost = class_to_shost(class_dev);
138 struct ata_port *ap = ata_shost_to_port(shost);
139 enum link_pm policy = 0;
140 int i;
141
142 /*
143 * we are skipping array location 0 on purpose - this
144 * is because a value of NOT_AVAILABLE is displayed
145 * to the user as max_performance, but when the user
146 * writes "max_performance", they actually want the
147 * value to match MAX_PERFORMANCE.
148 */
149 for (i = 1; i < ARRAY_SIZE(link_pm_policy); i++) {
150 const int len = strlen(link_pm_policy[i].name);
151 if (strncmp(link_pm_policy[i].name, buf, len) == 0 &&
152 buf[len] == '\n') {
153 policy = link_pm_policy[i].value;
154 break;
155 }
156 }
157 if (!policy)
158 return -EINVAL;
159
160 ata_lpm_schedule(ap, policy);
161 return count;
162 }
163
164 static ssize_t
165 ata_scsi_lpm_show(struct class_device *class_dev, char *buf)
166 {
167 struct Scsi_Host *shost = class_to_shost(class_dev);
168 struct ata_port *ap = ata_shost_to_port(shost);
169 const char *policy =
170 ata_scsi_lpm_get(ap->pm_policy);
171
172 if (!policy)
173 return -EINVAL;
174
175 return snprintf(buf, 23, "%s\n", policy);
176 }
177 CLASS_DEVICE_ATTR(link_power_management_policy, S_IRUGO | S_IWUSR,
178 ata_scsi_lpm_show, ata_scsi_lpm_put);
179 EXPORT_SYMBOL_GPL(class_device_attr_link_power_management_policy);
180
181 static void ata_scsi_invalid_field(struct scsi_cmnd *cmd,
182 void (*done)(struct scsi_cmnd *))
183 {
184 ata_scsi_set_sense(cmd, ILLEGAL_REQUEST, 0x24, 0x0);
185 /* "Invalid field in cbd" */
186 done(cmd);
187 }
188
189 /**
190 * ata_std_bios_param - generic bios head/sector/cylinder calculator used by sd.
191 * @sdev: SCSI device for which BIOS geometry is to be determined
192 * @bdev: block device associated with @sdev
193 * @capacity: capacity of SCSI device
194 * @geom: location to which geometry will be output
195 *
196 * Generic bios head/sector/cylinder calculator
197 * used by sd. Most BIOSes nowadays expect a XXX/255/16 (CHS)
198 * mapping. Some situations may arise where the disk is not
199 * bootable if this is not used.
200 *
201 * LOCKING:
202 * Defined by the SCSI layer. We don't really care.
203 *
204 * RETURNS:
205 * Zero.
206 */
207 int ata_std_bios_param(struct scsi_device *sdev, struct block_device *bdev,
208 sector_t capacity, int geom[])
209 {
210 geom[0] = 255;
211 geom[1] = 63;
212 sector_div(capacity, 255*63);
213 geom[2] = capacity;
214
215 return 0;
216 }
217
218 /**
219 * ata_get_identity - Handler for HDIO_GET_IDENTITY ioctl
220 * @sdev: SCSI device to get identify data for
221 * @arg: User buffer area for identify data
222 *
223 * LOCKING:
224 * Defined by the SCSI layer. We don't really care.
225 *
226 * RETURNS:
227 * Zero on success, negative errno on error.
228 */
229 static int ata_get_identity(struct scsi_device *sdev, void __user *arg)
230 {
231 struct ata_port *ap = ata_shost_to_port(sdev->host);
232 struct ata_device *dev = ata_scsi_find_dev(ap, sdev);
233 u16 __user *dst = arg;
234 char buf[40];
235
236 if (!dev)
237 return -ENOMSG;
238
239 if (copy_to_user(dst, dev->id, ATA_ID_WORDS * sizeof(u16)))
240 return -EFAULT;
241
242 ata_id_string(dev->id, buf, ATA_ID_PROD, ATA_ID_PROD_LEN);
243 if (copy_to_user(dst + ATA_ID_PROD, buf, ATA_ID_PROD_LEN))
244 return -EFAULT;
245
246 ata_id_string(dev->id, buf, ATA_ID_FW_REV, ATA_ID_FW_REV_LEN);
247 if (copy_to_user(dst + ATA_ID_FW_REV, buf, ATA_ID_FW_REV_LEN))
248 return -EFAULT;
249
250 ata_id_string(dev->id, buf, ATA_ID_SERNO, ATA_ID_SERNO_LEN);
251 if (copy_to_user(dst + ATA_ID_SERNO, buf, ATA_ID_SERNO_LEN))
252 return -EFAULT;
253
254 return 0;
255 }
256
257 /**
258 * ata_cmd_ioctl - Handler for HDIO_DRIVE_CMD ioctl
259 * @scsidev: Device to which we are issuing command
260 * @arg: User provided data for issuing command
261 *
262 * LOCKING:
263 * Defined by the SCSI layer. We don't really care.
264 *
265 * RETURNS:
266 * Zero on success, negative errno on error.
267 */
268 int ata_cmd_ioctl(struct scsi_device *scsidev, void __user *arg)
269 {
270 int rc = 0;
271 u8 scsi_cmd[MAX_COMMAND_SIZE];
272 u8 args[4], *argbuf = NULL, *sensebuf = NULL;
273 int argsize = 0;
274 enum dma_data_direction data_dir;
275 int cmd_result;
276
277 if (arg == NULL)
278 return -EINVAL;
279
280 if (copy_from_user(args, arg, sizeof(args)))
281 return -EFAULT;
282
283 sensebuf = kzalloc(SCSI_SENSE_BUFFERSIZE, GFP_NOIO);
284 if (!sensebuf)
285 return -ENOMEM;
286
287 memset(scsi_cmd, 0, sizeof(scsi_cmd));
288
289 if (args[3]) {
290 argsize = SECTOR_SIZE * args[3];
291 argbuf = kmalloc(argsize, GFP_KERNEL);
292 if (argbuf == NULL) {
293 rc = -ENOMEM;
294 goto error;
295 }
296
297 scsi_cmd[1] = (4 << 1); /* PIO Data-in */
298 scsi_cmd[2] = 0x0e; /* no off.line or cc, read from dev,
299 block count in sector count field */
300 data_dir = DMA_FROM_DEVICE;
301 } else {
302 scsi_cmd[1] = (3 << 1); /* Non-data */
303 scsi_cmd[2] = 0x20; /* cc but no off.line or data xfer */
304 data_dir = DMA_NONE;
305 }
306
307 scsi_cmd[0] = ATA_16;
308
309 scsi_cmd[4] = args[2];
310 if (args[0] == WIN_SMART) { /* hack -- ide driver does this too... */
311 scsi_cmd[6] = args[3];
312 scsi_cmd[8] = args[1];
313 scsi_cmd[10] = 0x4f;
314 scsi_cmd[12] = 0xc2;
315 } else {
316 scsi_cmd[6] = args[1];
317 }
318 scsi_cmd[14] = args[0];
319
320 /* Good values for timeout and retries? Values below
321 from scsi_ioctl_send_command() for default case... */
322 cmd_result = scsi_execute(scsidev, scsi_cmd, data_dir, argbuf, argsize,
323 sensebuf, (10*HZ), 5, 0);
324
325 if (driver_byte(cmd_result) == DRIVER_SENSE) {/* sense data available */
326 u8 *desc = sensebuf + 8;
327 cmd_result &= ~(0xFF<<24); /* DRIVER_SENSE is not an error */
328
329 /* If we set cc then ATA pass-through will cause a
330 * check condition even if no error. Filter that. */
331 if (cmd_result & SAM_STAT_CHECK_CONDITION) {
332 struct scsi_sense_hdr sshdr;
333 scsi_normalize_sense(sensebuf, SCSI_SENSE_BUFFERSIZE,
334 &sshdr);
335 if (sshdr.sense_key == 0 &&
336 sshdr.asc == 0 && sshdr.ascq == 0)
337 cmd_result &= ~SAM_STAT_CHECK_CONDITION;
338 }
339
340 /* Send userspace a few ATA registers (same as drivers/ide) */
341 if (sensebuf[0] == 0x72 && /* format is "descriptor" */
342 desc[0] == 0x09) { /* code is "ATA Descriptor" */
343 args[0] = desc[13]; /* status */
344 args[1] = desc[3]; /* error */
345 args[2] = desc[5]; /* sector count (0:7) */
346 if (copy_to_user(arg, args, sizeof(args)))
347 rc = -EFAULT;
348 }
349 }
350
351
352 if (cmd_result) {
353 rc = -EIO;
354 goto error;
355 }
356
357 if ((argbuf)
358 && copy_to_user(arg + sizeof(args), argbuf, argsize))
359 rc = -EFAULT;
360 error:
361 kfree(sensebuf);
362 kfree(argbuf);
363 return rc;
364 }
365
366 /**
367 * ata_task_ioctl - Handler for HDIO_DRIVE_TASK ioctl
368 * @scsidev: Device to which we are issuing command
369 * @arg: User provided data for issuing command
370 *
371 * LOCKING:
372 * Defined by the SCSI layer. We don't really care.
373 *
374 * RETURNS:
375 * Zero on success, negative errno on error.
376 */
377 int ata_task_ioctl(struct scsi_device *scsidev, void __user *arg)
378 {
379 int rc = 0;
380 u8 scsi_cmd[MAX_COMMAND_SIZE];
381 u8 args[7], *sensebuf = NULL;
382 int cmd_result;
383
384 if (arg == NULL)
385 return -EINVAL;
386
387 if (copy_from_user(args, arg, sizeof(args)))
388 return -EFAULT;
389
390 sensebuf = kzalloc(SCSI_SENSE_BUFFERSIZE, GFP_NOIO);
391 if (!sensebuf)
392 return -ENOMEM;
393
394 memset(scsi_cmd, 0, sizeof(scsi_cmd));
395 scsi_cmd[0] = ATA_16;
396 scsi_cmd[1] = (3 << 1); /* Non-data */
397 scsi_cmd[2] = 0x20; /* cc but no off.line or data xfer */
398 scsi_cmd[4] = args[1];
399 scsi_cmd[6] = args[2];
400 scsi_cmd[8] = args[3];
401 scsi_cmd[10] = args[4];
402 scsi_cmd[12] = args[5];
403 scsi_cmd[13] = args[6] & 0x4f;
404 scsi_cmd[14] = args[0];
405
406 /* Good values for timeout and retries? Values below
407 from scsi_ioctl_send_command() for default case... */
408 cmd_result = scsi_execute(scsidev, scsi_cmd, DMA_NONE, NULL, 0,
409 sensebuf, (10*HZ), 5, 0);
410
411 if (driver_byte(cmd_result) == DRIVER_SENSE) {/* sense data available */
412 u8 *desc = sensebuf + 8;
413 cmd_result &= ~(0xFF<<24); /* DRIVER_SENSE is not an error */
414
415 /* If we set cc then ATA pass-through will cause a
416 * check condition even if no error. Filter that. */
417 if (cmd_result & SAM_STAT_CHECK_CONDITION) {
418 struct scsi_sense_hdr sshdr;
419 scsi_normalize_sense(sensebuf, SCSI_SENSE_BUFFERSIZE,
420 &sshdr);
421 if (sshdr.sense_key == 0 &&
422 sshdr.asc == 0 && sshdr.ascq == 0)
423 cmd_result &= ~SAM_STAT_CHECK_CONDITION;
424 }
425
426 /* Send userspace ATA registers */
427 if (sensebuf[0] == 0x72 && /* format is "descriptor" */
428 desc[0] == 0x09) {/* code is "ATA Descriptor" */
429 args[0] = desc[13]; /* status */
430 args[1] = desc[3]; /* error */
431 args[2] = desc[5]; /* sector count (0:7) */
432 args[3] = desc[7]; /* lbal */
433 args[4] = desc[9]; /* lbam */
434 args[5] = desc[11]; /* lbah */
435 args[6] = desc[12]; /* select */
436 if (copy_to_user(arg, args, sizeof(args)))
437 rc = -EFAULT;
438 }
439 }
440
441 if (cmd_result) {
442 rc = -EIO;
443 goto error;
444 }
445
446 error:
447 kfree(sensebuf);
448 return rc;
449 }
450
451 int ata_scsi_ioctl(struct scsi_device *scsidev, int cmd, void __user *arg)
452 {
453 int val = -EINVAL, rc = -EINVAL;
454
455 switch (cmd) {
456 case ATA_IOC_GET_IO32:
457 val = 0;
458 if (copy_to_user(arg, &val, 1))
459 return -EFAULT;
460 return 0;
461
462 case ATA_IOC_SET_IO32:
463 val = (unsigned long) arg;
464 if (val != 0)
465 return -EINVAL;
466 return 0;
467
468 case HDIO_GET_IDENTITY:
469 return ata_get_identity(scsidev, arg);
470
471 case HDIO_DRIVE_CMD:
472 if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
473 return -EACCES;
474 return ata_cmd_ioctl(scsidev, arg);
475
476 case HDIO_DRIVE_TASK:
477 if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
478 return -EACCES;
479 return ata_task_ioctl(scsidev, arg);
480
481 default:
482 rc = -ENOTTY;
483 break;
484 }
485
486 return rc;
487 }
488
489 /**
490 * ata_scsi_qc_new - acquire new ata_queued_cmd reference
491 * @dev: ATA device to which the new command is attached
492 * @cmd: SCSI command that originated this ATA command
493 * @done: SCSI command completion function
494 *
495 * Obtain a reference to an unused ata_queued_cmd structure,
496 * which is the basic libata structure representing a single
497 * ATA command sent to the hardware.
498 *
499 * If a command was available, fill in the SCSI-specific
500 * portions of the structure with information on the
501 * current command.
502 *
503 * LOCKING:
504 * spin_lock_irqsave(host lock)
505 *
506 * RETURNS:
507 * Command allocated, or %NULL if none available.
508 */
509 static struct ata_queued_cmd *ata_scsi_qc_new(struct ata_device *dev,
510 struct scsi_cmnd *cmd,
511 void (*done)(struct scsi_cmnd *))
512 {
513 struct ata_queued_cmd *qc;
514
515 qc = ata_qc_new_init(dev);
516 if (qc) {
517 qc->scsicmd = cmd;
518 qc->scsidone = done;
519
520 qc->sg = scsi_sglist(cmd);
521 qc->n_elem = scsi_sg_count(cmd);
522 } else {
523 cmd->result = (DID_OK << 16) | (QUEUE_FULL << 1);
524 done(cmd);
525 }
526
527 return qc;
528 }
529
530 /**
531 * ata_dump_status - user friendly display of error info
532 * @id: id of the port in question
533 * @tf: ptr to filled out taskfile
534 *
535 * Decode and dump the ATA error/status registers for the user so
536 * that they have some idea what really happened at the non
537 * make-believe layer.
538 *
539 * LOCKING:
540 * inherited from caller
541 */
542 static void ata_dump_status(unsigned id, struct ata_taskfile *tf)
543 {
544 u8 stat = tf->command, err = tf->feature;
545
546 printk(KERN_WARNING "ata%u: status=0x%02x { ", id, stat);
547 if (stat & ATA_BUSY) {
548 printk("Busy }\n"); /* Data is not valid in this case */
549 } else {
550 if (stat & 0x40) printk("DriveReady ");
551 if (stat & 0x20) printk("DeviceFault ");
552 if (stat & 0x10) printk("SeekComplete ");
553 if (stat & 0x08) printk("DataRequest ");
554 if (stat & 0x04) printk("CorrectedError ");
555 if (stat & 0x02) printk("Index ");
556 if (stat & 0x01) printk("Error ");
557 printk("}\n");
558
559 if (err) {
560 printk(KERN_WARNING "ata%u: error=0x%02x { ", id, err);
561 if (err & 0x04) printk("DriveStatusError ");
562 if (err & 0x80) {
563 if (err & 0x04) printk("BadCRC ");
564 else printk("Sector ");
565 }
566 if (err & 0x40) printk("UncorrectableError ");
567 if (err & 0x10) printk("SectorIdNotFound ");
568 if (err & 0x02) printk("TrackZeroNotFound ");
569 if (err & 0x01) printk("AddrMarkNotFound ");
570 printk("}\n");
571 }
572 }
573 }
574
575 /**
576 * ata_to_sense_error - convert ATA error to SCSI error
577 * @id: ATA device number
578 * @drv_stat: value contained in ATA status register
579 * @drv_err: value contained in ATA error register
580 * @sk: the sense key we'll fill out
581 * @asc: the additional sense code we'll fill out
582 * @ascq: the additional sense code qualifier we'll fill out
583 * @verbose: be verbose
584 *
585 * Converts an ATA error into a SCSI error. Fill out pointers to
586 * SK, ASC, and ASCQ bytes for later use in fixed or descriptor
587 * format sense blocks.
588 *
589 * LOCKING:
590 * spin_lock_irqsave(host lock)
591 */
592 static void ata_to_sense_error(unsigned id, u8 drv_stat, u8 drv_err, u8 *sk,
593 u8 *asc, u8 *ascq, int verbose)
594 {
595 int i;
596
597 /* Based on the 3ware driver translation table */
598 static const unsigned char sense_table[][4] = {
599 /* BBD|ECC|ID|MAR */
600 {0xd1, ABORTED_COMMAND, 0x00, 0x00}, // Device busy Aborted command
601 /* BBD|ECC|ID */
602 {0xd0, ABORTED_COMMAND, 0x00, 0x00}, // Device busy Aborted command
603 /* ECC|MC|MARK */
604 {0x61, HARDWARE_ERROR, 0x00, 0x00}, // Device fault Hardware error
605 /* ICRC|ABRT */ /* NB: ICRC & !ABRT is BBD */
606 {0x84, ABORTED_COMMAND, 0x47, 0x00}, // Data CRC error SCSI parity error
607 /* MC|ID|ABRT|TRK0|MARK */
608 {0x37, NOT_READY, 0x04, 0x00}, // Unit offline Not ready
609 /* MCR|MARK */
610 {0x09, NOT_READY, 0x04, 0x00}, // Unrecovered disk error Not ready
611 /* Bad address mark */
612 {0x01, MEDIUM_ERROR, 0x13, 0x00}, // Address mark not found Address mark not found for data field
613 /* TRK0 */
614 {0x02, HARDWARE_ERROR, 0x00, 0x00}, // Track 0 not found Hardware error
615 /* Abort & !ICRC */
616 {0x04, ABORTED_COMMAND, 0x00, 0x00}, // Aborted command Aborted command
617 /* Media change request */
618 {0x08, NOT_READY, 0x04, 0x00}, // Media change request FIXME: faking offline
619 /* SRV */
620 {0x10, ABORTED_COMMAND, 0x14, 0x00}, // ID not found Recorded entity not found
621 /* Media change */
622 {0x08, NOT_READY, 0x04, 0x00}, // Media change FIXME: faking offline
623 /* ECC */
624 {0x40, MEDIUM_ERROR, 0x11, 0x04}, // Uncorrectable ECC error Unrecovered read error
625 /* BBD - block marked bad */
626 {0x80, MEDIUM_ERROR, 0x11, 0x04}, // Block marked bad Medium error, unrecovered read error
627 {0xFF, 0xFF, 0xFF, 0xFF}, // END mark
628 };
629 static const unsigned char stat_table[][4] = {
630 /* Must be first because BUSY means no other bits valid */
631 {0x80, ABORTED_COMMAND, 0x47, 0x00}, // Busy, fake parity for now
632 {0x20, HARDWARE_ERROR, 0x00, 0x00}, // Device fault
633 {0x08, ABORTED_COMMAND, 0x47, 0x00}, // Timed out in xfer, fake parity for now
634 {0x04, RECOVERED_ERROR, 0x11, 0x00}, // Recovered ECC error Medium error, recovered
635 {0xFF, 0xFF, 0xFF, 0xFF}, // END mark
636 };
637
638 /*
639 * Is this an error we can process/parse
640 */
641 if (drv_stat & ATA_BUSY) {
642 drv_err = 0; /* Ignore the err bits, they're invalid */
643 }
644
645 if (drv_err) {
646 /* Look for drv_err */
647 for (i = 0; sense_table[i][0] != 0xFF; i++) {
648 /* Look for best matches first */
649 if ((sense_table[i][0] & drv_err) ==
650 sense_table[i][0]) {
651 *sk = sense_table[i][1];
652 *asc = sense_table[i][2];
653 *ascq = sense_table[i][3];
654 goto translate_done;
655 }
656 }
657 /* No immediate match */
658 if (verbose)
659 printk(KERN_WARNING "ata%u: no sense translation for "
660 "error 0x%02x\n", id, drv_err);
661 }
662
663 /* Fall back to interpreting status bits */
664 for (i = 0; stat_table[i][0] != 0xFF; i++) {
665 if (stat_table[i][0] & drv_stat) {
666 *sk = stat_table[i][1];
667 *asc = stat_table[i][2];
668 *ascq = stat_table[i][3];
669 goto translate_done;
670 }
671 }
672 /* No error? Undecoded? */
673 if (verbose)
674 printk(KERN_WARNING "ata%u: no sense translation for "
675 "status: 0x%02x\n", id, drv_stat);
676
677 /* We need a sensible error return here, which is tricky, and one
678 that won't cause people to do things like return a disk wrongly */
679 *sk = ABORTED_COMMAND;
680 *asc = 0x00;
681 *ascq = 0x00;
682
683 translate_done:
684 if (verbose)
685 printk(KERN_ERR "ata%u: translated ATA stat/err 0x%02x/%02x "
686 "to SCSI SK/ASC/ASCQ 0x%x/%02x/%02x\n",
687 id, drv_stat, drv_err, *sk, *asc, *ascq);
688 return;
689 }
690
691 /*
692 * ata_gen_passthru_sense - Generate check condition sense block.
693 * @qc: Command that completed.
694 *
695 * This function is specific to the ATA descriptor format sense
696 * block specified for the ATA pass through commands. Regardless
697 * of whether the command errored or not, return a sense
698 * block. Copy all controller registers into the sense
699 * block. Clear sense key, ASC & ASCQ if there is no error.
700 *
701 * LOCKING:
702 * None.
703 */
704 static void ata_gen_passthru_sense(struct ata_queued_cmd *qc)
705 {
706 struct scsi_cmnd *cmd = qc->scsicmd;
707 struct ata_taskfile *tf = &qc->result_tf;
708 unsigned char *sb = cmd->sense_buffer;
709 unsigned char *desc = sb + 8;
710 int verbose = qc->ap->ops->error_handler == NULL;
711
712 memset(sb, 0, SCSI_SENSE_BUFFERSIZE);
713
714 cmd->result = (DRIVER_SENSE << 24) | SAM_STAT_CHECK_CONDITION;
715
716 /*
717 * Use ata_to_sense_error() to map status register bits
718 * onto sense key, asc & ascq.
719 */
720 if (qc->err_mask ||
721 tf->command & (ATA_BUSY | ATA_DF | ATA_ERR | ATA_DRQ)) {
722 ata_to_sense_error(qc->ap->print_id, tf->command, tf->feature,
723 &sb[1], &sb[2], &sb[3], verbose);
724 sb[1] &= 0x0f;
725 }
726
727 /*
728 * Sense data is current and format is descriptor.
729 */
730 sb[0] = 0x72;
731
732 desc[0] = 0x09;
733
734 /* set length of additional sense data */
735 sb[7] = 14;
736 desc[1] = 12;
737
738 /*
739 * Copy registers into sense buffer.
740 */
741 desc[2] = 0x00;
742 desc[3] = tf->feature; /* == error reg */
743 desc[5] = tf->nsect;
744 desc[7] = tf->lbal;
745 desc[9] = tf->lbam;
746 desc[11] = tf->lbah;
747 desc[12] = tf->device;
748 desc[13] = tf->command; /* == status reg */
749
750 /*
751 * Fill in Extend bit, and the high order bytes
752 * if applicable.
753 */
754 if (tf->flags & ATA_TFLAG_LBA48) {
755 desc[2] |= 0x01;
756 desc[4] = tf->hob_nsect;
757 desc[6] = tf->hob_lbal;
758 desc[8] = tf->hob_lbam;
759 desc[10] = tf->hob_lbah;
760 }
761 }
762
763 /**
764 * ata_gen_ata_sense - generate a SCSI fixed sense block
765 * @qc: Command that we are erroring out
766 *
767 * Generate sense block for a failed ATA command @qc. Descriptor
768 * format is used to accomodate LBA48 block address.
769 *
770 * LOCKING:
771 * None.
772 */
773 static void ata_gen_ata_sense(struct ata_queued_cmd *qc)
774 {
775 struct ata_device *dev = qc->dev;
776 struct scsi_cmnd *cmd = qc->scsicmd;
777 struct ata_taskfile *tf = &qc->result_tf;
778 unsigned char *sb = cmd->sense_buffer;
779 unsigned char *desc = sb + 8;
780 int verbose = qc->ap->ops->error_handler == NULL;
781 u64 block;
782
783 memset(sb, 0, SCSI_SENSE_BUFFERSIZE);
784
785 cmd->result = (DRIVER_SENSE << 24) | SAM_STAT_CHECK_CONDITION;
786
787 /* sense data is current and format is descriptor */
788 sb[0] = 0x72;
789
790 /* Use ata_to_sense_error() to map status register bits
791 * onto sense key, asc & ascq.
792 */
793 if (qc->err_mask ||
794 tf->command & (ATA_BUSY | ATA_DF | ATA_ERR | ATA_DRQ)) {
795 ata_to_sense_error(qc->ap->print_id, tf->command, tf->feature,
796 &sb[1], &sb[2], &sb[3], verbose);
797 sb[1] &= 0x0f;
798 }
799
800 block = ata_tf_read_block(&qc->result_tf, dev);
801
802 /* information sense data descriptor */
803 sb[7] = 12;
804 desc[0] = 0x00;
805 desc[1] = 10;
806
807 desc[2] |= 0x80; /* valid */
808 desc[6] = block >> 40;
809 desc[7] = block >> 32;
810 desc[8] = block >> 24;
811 desc[9] = block >> 16;
812 desc[10] = block >> 8;
813 desc[11] = block;
814 }
815
816 static void ata_scsi_sdev_config(struct scsi_device *sdev)
817 {
818 sdev->use_10_for_rw = 1;
819 sdev->use_10_for_ms = 1;
820
821 /* Schedule policy is determined by ->qc_defer() callback and
822 * it needs to see every deferred qc. Set dev_blocked to 1 to
823 * prevent SCSI midlayer from automatically deferring
824 * requests.
825 */
826 sdev->max_device_blocked = 1;
827 }
828
829 /**
830 * atapi_drain_needed - Check whether data transfer may overflow
831 * @rq: request to be checked
832 *
833 * ATAPI commands which transfer variable length data to host
834 * might overflow due to application error or hardare bug. This
835 * function checks whether overflow should be drained and ignored
836 * for @request.
837 *
838 * LOCKING:
839 * None.
840 *
841 * RETURNS:
842 * 1 if ; otherwise, 0.
843 */
844 static int atapi_drain_needed(struct request *rq)
845 {
846 if (likely(!blk_pc_request(rq)))
847 return 0;
848
849 if (!rq->data_len || (rq->cmd_flags & REQ_RW))
850 return 0;
851
852 return atapi_cmd_type(rq->cmd[0]) == ATAPI_MISC;
853 }
854
855 static int ata_scsi_dev_config(struct scsi_device *sdev,
856 struct ata_device *dev)
857 {
858 /* configure max sectors */
859 blk_queue_max_sectors(sdev->request_queue, dev->max_sectors);
860
861 if (dev->class == ATA_DEV_ATAPI) {
862 struct request_queue *q = sdev->request_queue;
863 void *buf;
864
865 /* set the min alignment */
866 blk_queue_update_dma_alignment(sdev->request_queue,
867 ATA_DMA_PAD_SZ - 1);
868
869 /* configure draining */
870 buf = kmalloc(ATAPI_MAX_DRAIN, q->bounce_gfp | GFP_KERNEL);
871 if (!buf) {
872 ata_dev_printk(dev, KERN_ERR,
873 "drain buffer allocation failed\n");
874 return -ENOMEM;
875 }
876
877 blk_queue_dma_drain(q, atapi_drain_needed, buf, ATAPI_MAX_DRAIN);
878 } else {
879 /* ATA devices must be sector aligned */
880 blk_queue_update_dma_alignment(sdev->request_queue,
881 ATA_SECT_SIZE - 1);
882 sdev->manage_start_stop = 1;
883 }
884
885 if (dev->flags & ATA_DFLAG_AN)
886 set_bit(SDEV_EVT_MEDIA_CHANGE, sdev->supported_events);
887
888 if (dev->flags & ATA_DFLAG_NCQ) {
889 int depth;
890
891 depth = min(sdev->host->can_queue, ata_id_queue_depth(dev->id));
892 depth = min(ATA_MAX_QUEUE - 1, depth);
893 scsi_adjust_queue_depth(sdev, MSG_SIMPLE_TAG, depth);
894 }
895
896 return 0;
897 }
898
899 /**
900 * ata_scsi_slave_config - Set SCSI device attributes
901 * @sdev: SCSI device to examine
902 *
903 * This is called before we actually start reading
904 * and writing to the device, to configure certain
905 * SCSI mid-layer behaviors.
906 *
907 * LOCKING:
908 * Defined by SCSI layer. We don't really care.
909 */
910
911 int ata_scsi_slave_config(struct scsi_device *sdev)
912 {
913 struct ata_port *ap = ata_shost_to_port(sdev->host);
914 struct ata_device *dev = __ata_scsi_find_dev(ap, sdev);
915 int rc = 0;
916
917 ata_scsi_sdev_config(sdev);
918
919 if (dev)
920 rc = ata_scsi_dev_config(sdev, dev);
921
922 return rc;
923 }
924
925 /**
926 * ata_scsi_slave_destroy - SCSI device is about to be destroyed
927 * @sdev: SCSI device to be destroyed
928 *
929 * @sdev is about to be destroyed for hot/warm unplugging. If
930 * this unplugging was initiated by libata as indicated by NULL
931 * dev->sdev, this function doesn't have to do anything.
932 * Otherwise, SCSI layer initiated warm-unplug is in progress.
933 * Clear dev->sdev, schedule the device for ATA detach and invoke
934 * EH.
935 *
936 * LOCKING:
937 * Defined by SCSI layer. We don't really care.
938 */
939 void ata_scsi_slave_destroy(struct scsi_device *sdev)
940 {
941 struct ata_port *ap = ata_shost_to_port(sdev->host);
942 struct request_queue *q = sdev->request_queue;
943 unsigned long flags;
944 struct ata_device *dev;
945
946 if (!ap->ops->error_handler)
947 return;
948
949 spin_lock_irqsave(ap->lock, flags);
950 dev = __ata_scsi_find_dev(ap, sdev);
951 if (dev && dev->sdev) {
952 /* SCSI device already in CANCEL state, no need to offline it */
953 dev->sdev = NULL;
954 dev->flags |= ATA_DFLAG_DETACH;
955 ata_port_schedule_eh(ap);
956 }
957 spin_unlock_irqrestore(ap->lock, flags);
958
959 kfree(q->dma_drain_buffer);
960 q->dma_drain_buffer = NULL;
961 q->dma_drain_size = 0;
962 }
963
964 /**
965 * ata_scsi_change_queue_depth - SCSI callback for queue depth config
966 * @sdev: SCSI device to configure queue depth for
967 * @queue_depth: new queue depth
968 *
969 * This is libata standard hostt->change_queue_depth callback.
970 * SCSI will call into this callback when user tries to set queue
971 * depth via sysfs.
972 *
973 * LOCKING:
974 * SCSI layer (we don't care)
975 *
976 * RETURNS:
977 * Newly configured queue depth.
978 */
979 int ata_scsi_change_queue_depth(struct scsi_device *sdev, int queue_depth)
980 {
981 struct ata_port *ap = ata_shost_to_port(sdev->host);
982 struct ata_device *dev;
983 unsigned long flags;
984
985 if (queue_depth < 1 || queue_depth == sdev->queue_depth)
986 return sdev->queue_depth;
987
988 dev = ata_scsi_find_dev(ap, sdev);
989 if (!dev || !ata_dev_enabled(dev))
990 return sdev->queue_depth;
991
992 /* NCQ enabled? */
993 spin_lock_irqsave(ap->lock, flags);
994 dev->flags &= ~ATA_DFLAG_NCQ_OFF;
995 if (queue_depth == 1 || !ata_ncq_enabled(dev)) {
996 dev->flags |= ATA_DFLAG_NCQ_OFF;
997 queue_depth = 1;
998 }
999 spin_unlock_irqrestore(ap->lock, flags);
1000
1001 /* limit and apply queue depth */
1002 queue_depth = min(queue_depth, sdev->host->can_queue);
1003 queue_depth = min(queue_depth, ata_id_queue_depth(dev->id));
1004 queue_depth = min(queue_depth, ATA_MAX_QUEUE - 1);
1005
1006 if (sdev->queue_depth == queue_depth)
1007 return -EINVAL;
1008
1009 scsi_adjust_queue_depth(sdev, MSG_SIMPLE_TAG, queue_depth);
1010 return queue_depth;
1011 }
1012
1013 /* XXX: for spindown warning */
1014 static void ata_delayed_done_timerfn(unsigned long arg)
1015 {
1016 struct scsi_cmnd *scmd = (void *)arg;
1017
1018 scmd->scsi_done(scmd);
1019 }
1020
1021 /* XXX: for spindown warning */
1022 static void ata_delayed_done(struct scsi_cmnd *scmd)
1023 {
1024 static struct timer_list timer;
1025
1026 setup_timer(&timer, ata_delayed_done_timerfn, (unsigned long)scmd);
1027 mod_timer(&timer, jiffies + 5 * HZ);
1028 }
1029
1030 /**
1031 * ata_scsi_start_stop_xlat - Translate SCSI START STOP UNIT command
1032 * @qc: Storage for translated ATA taskfile
1033 *
1034 * Sets up an ATA taskfile to issue STANDBY (to stop) or READ VERIFY
1035 * (to start). Perhaps these commands should be preceded by
1036 * CHECK POWER MODE to see what power mode the device is already in.
1037 * [See SAT revision 5 at www.t10.org]
1038 *
1039 * LOCKING:
1040 * spin_lock_irqsave(host lock)
1041 *
1042 * RETURNS:
1043 * Zero on success, non-zero on error.
1044 */
1045 static unsigned int ata_scsi_start_stop_xlat(struct ata_queued_cmd *qc)
1046 {
1047 struct scsi_cmnd *scmd = qc->scsicmd;
1048 struct ata_taskfile *tf = &qc->tf;
1049 const u8 *cdb = scmd->cmnd;
1050
1051 if (scmd->cmd_len < 5)
1052 goto invalid_fld;
1053
1054 tf->flags |= ATA_TFLAG_DEVICE | ATA_TFLAG_ISADDR;
1055 tf->protocol = ATA_PROT_NODATA;
1056 if (cdb[1] & 0x1) {
1057 ; /* ignore IMMED bit, violates sat-r05 */
1058 }
1059 if (cdb[4] & 0x2)
1060 goto invalid_fld; /* LOEJ bit set not supported */
1061 if (((cdb[4] >> 4) & 0xf) != 0)
1062 goto invalid_fld; /* power conditions not supported */
1063
1064 if (qc->dev->horkage & ATA_HORKAGE_SKIP_PM) {
1065 /* the device lacks PM support, finish without doing anything */
1066 scmd->result = SAM_STAT_GOOD;
1067 return 1;
1068 }
1069
1070 if (cdb[4] & 0x1) {
1071 tf->nsect = 1; /* 1 sector, lba=0 */
1072
1073 if (qc->dev->flags & ATA_DFLAG_LBA) {
1074 tf->flags |= ATA_TFLAG_LBA;
1075
1076 tf->lbah = 0x0;
1077 tf->lbam = 0x0;
1078 tf->lbal = 0x0;
1079 tf->device |= ATA_LBA;
1080 } else {
1081 /* CHS */
1082 tf->lbal = 0x1; /* sect */
1083 tf->lbam = 0x0; /* cyl low */
1084 tf->lbah = 0x0; /* cyl high */
1085 }
1086
1087 tf->command = ATA_CMD_VERIFY; /* READ VERIFY */
1088 } else {
1089 /* XXX: This is for backward compatibility, will be
1090 * removed. Read Documentation/feature-removal-schedule.txt
1091 * for more info.
1092 */
1093 if ((qc->dev->flags & ATA_DFLAG_SPUNDOWN) &&
1094 (system_state == SYSTEM_HALT ||
1095 system_state == SYSTEM_POWER_OFF)) {
1096 static unsigned long warned;
1097
1098 if (!test_and_set_bit(0, &warned)) {
1099 ata_dev_printk(qc->dev, KERN_WARNING,
1100 "DISK MIGHT NOT BE SPUN DOWN PROPERLY. "
1101 "UPDATE SHUTDOWN UTILITY\n");
1102 ata_dev_printk(qc->dev, KERN_WARNING,
1103 "For more info, visit "
1104 "http://linux-ata.org/shutdown.html\n");
1105
1106 /* ->scsi_done is not used, use it for
1107 * delayed completion.
1108 */
1109 scmd->scsi_done = qc->scsidone;
1110 qc->scsidone = ata_delayed_done;
1111 }
1112 scmd->result = SAM_STAT_GOOD;
1113 return 1;
1114 }
1115
1116 /* Issue ATA STANDBY IMMEDIATE command */
1117 tf->command = ATA_CMD_STANDBYNOW1;
1118 }
1119
1120 /*
1121 * Standby and Idle condition timers could be implemented but that
1122 * would require libata to implement the Power condition mode page
1123 * and allow the user to change it. Changing mode pages requires
1124 * MODE SELECT to be implemented.
1125 */
1126
1127 return 0;
1128
1129 invalid_fld:
1130 ata_scsi_set_sense(scmd, ILLEGAL_REQUEST, 0x24, 0x0);
1131 /* "Invalid field in cbd" */
1132 return 1;
1133 }
1134
1135
1136 /**
1137 * ata_scsi_flush_xlat - Translate SCSI SYNCHRONIZE CACHE command
1138 * @qc: Storage for translated ATA taskfile
1139 *
1140 * Sets up an ATA taskfile to issue FLUSH CACHE or
1141 * FLUSH CACHE EXT.
1142 *
1143 * LOCKING:
1144 * spin_lock_irqsave(host lock)
1145 *
1146 * RETURNS:
1147 * Zero on success, non-zero on error.
1148 */
1149 static unsigned int ata_scsi_flush_xlat(struct ata_queued_cmd *qc)
1150 {
1151 struct ata_taskfile *tf = &qc->tf;
1152
1153 tf->flags |= ATA_TFLAG_DEVICE;
1154 tf->protocol = ATA_PROT_NODATA;
1155
1156 if (qc->dev->flags & ATA_DFLAG_FLUSH_EXT)
1157 tf->command = ATA_CMD_FLUSH_EXT;
1158 else
1159 tf->command = ATA_CMD_FLUSH;
1160
1161 /* flush is critical for IO integrity, consider it an IO command */
1162 qc->flags |= ATA_QCFLAG_IO;
1163
1164 return 0;
1165 }
1166
1167 /**
1168 * scsi_6_lba_len - Get LBA and transfer length
1169 * @cdb: SCSI command to translate
1170 *
1171 * Calculate LBA and transfer length for 6-byte commands.
1172 *
1173 * RETURNS:
1174 * @plba: the LBA
1175 * @plen: the transfer length
1176 */
1177 static void scsi_6_lba_len(const u8 *cdb, u64 *plba, u32 *plen)
1178 {
1179 u64 lba = 0;
1180 u32 len;
1181
1182 VPRINTK("six-byte command\n");
1183
1184 lba |= ((u64)(cdb[1] & 0x1f)) << 16;
1185 lba |= ((u64)cdb[2]) << 8;
1186 lba |= ((u64)cdb[3]);
1187
1188 len = cdb[4];
1189
1190 *plba = lba;
1191 *plen = len;
1192 }
1193
1194 /**
1195 * scsi_10_lba_len - Get LBA and transfer length
1196 * @cdb: SCSI command to translate
1197 *
1198 * Calculate LBA and transfer length for 10-byte commands.
1199 *
1200 * RETURNS:
1201 * @plba: the LBA
1202 * @plen: the transfer length
1203 */
1204 static void scsi_10_lba_len(const u8 *cdb, u64 *plba, u32 *plen)
1205 {
1206 u64 lba = 0;
1207 u32 len = 0;
1208
1209 VPRINTK("ten-byte command\n");
1210
1211 lba |= ((u64)cdb[2]) << 24;
1212 lba |= ((u64)cdb[3]) << 16;
1213 lba |= ((u64)cdb[4]) << 8;
1214 lba |= ((u64)cdb[5]);
1215
1216 len |= ((u32)cdb[7]) << 8;
1217 len |= ((u32)cdb[8]);
1218
1219 *plba = lba;
1220 *plen = len;
1221 }
1222
1223 /**
1224 * scsi_16_lba_len - Get LBA and transfer length
1225 * @cdb: SCSI command to translate
1226 *
1227 * Calculate LBA and transfer length for 16-byte commands.
1228 *
1229 * RETURNS:
1230 * @plba: the LBA
1231 * @plen: the transfer length
1232 */
1233 static void scsi_16_lba_len(const u8 *cdb, u64 *plba, u32 *plen)
1234 {
1235 u64 lba = 0;
1236 u32 len = 0;
1237
1238 VPRINTK("sixteen-byte command\n");
1239
1240 lba |= ((u64)cdb[2]) << 56;
1241 lba |= ((u64)cdb[3]) << 48;
1242 lba |= ((u64)cdb[4]) << 40;
1243 lba |= ((u64)cdb[5]) << 32;
1244 lba |= ((u64)cdb[6]) << 24;
1245 lba |= ((u64)cdb[7]) << 16;
1246 lba |= ((u64)cdb[8]) << 8;
1247 lba |= ((u64)cdb[9]);
1248
1249 len |= ((u32)cdb[10]) << 24;
1250 len |= ((u32)cdb[11]) << 16;
1251 len |= ((u32)cdb[12]) << 8;
1252 len |= ((u32)cdb[13]);
1253
1254 *plba = lba;
1255 *plen = len;
1256 }
1257
1258 /**
1259 * ata_scsi_verify_xlat - Translate SCSI VERIFY command into an ATA one
1260 * @qc: Storage for translated ATA taskfile
1261 *
1262 * Converts SCSI VERIFY command to an ATA READ VERIFY command.
1263 *
1264 * LOCKING:
1265 * spin_lock_irqsave(host lock)
1266 *
1267 * RETURNS:
1268 * Zero on success, non-zero on error.
1269 */
1270 static unsigned int ata_scsi_verify_xlat(struct ata_queued_cmd *qc)
1271 {
1272 struct scsi_cmnd *scmd = qc->scsicmd;
1273 struct ata_taskfile *tf = &qc->tf;
1274 struct ata_device *dev = qc->dev;
1275 u64 dev_sectors = qc->dev->n_sectors;
1276 const u8 *cdb = scmd->cmnd;
1277 u64 block;
1278 u32 n_block;
1279
1280 tf->flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
1281 tf->protocol = ATA_PROT_NODATA;
1282
1283 if (cdb[0] == VERIFY) {
1284 if (scmd->cmd_len < 10)
1285 goto invalid_fld;
1286 scsi_10_lba_len(cdb, &block, &n_block);
1287 } else if (cdb[0] == VERIFY_16) {
1288 if (scmd->cmd_len < 16)
1289 goto invalid_fld;
1290 scsi_16_lba_len(cdb, &block, &n_block);
1291 } else
1292 goto invalid_fld;
1293
1294 if (!n_block)
1295 goto nothing_to_do;
1296 if (block >= dev_sectors)
1297 goto out_of_range;
1298 if ((block + n_block) > dev_sectors)
1299 goto out_of_range;
1300
1301 if (dev->flags & ATA_DFLAG_LBA) {
1302 tf->flags |= ATA_TFLAG_LBA;
1303
1304 if (lba_28_ok(block, n_block)) {
1305 /* use LBA28 */
1306 tf->command = ATA_CMD_VERIFY;
1307 tf->device |= (block >> 24) & 0xf;
1308 } else if (lba_48_ok(block, n_block)) {
1309 if (!(dev->flags & ATA_DFLAG_LBA48))
1310 goto out_of_range;
1311
1312 /* use LBA48 */
1313 tf->flags |= ATA_TFLAG_LBA48;
1314 tf->command = ATA_CMD_VERIFY_EXT;
1315
1316 tf->hob_nsect = (n_block >> 8) & 0xff;
1317
1318 tf->hob_lbah = (block >> 40) & 0xff;
1319 tf->hob_lbam = (block >> 32) & 0xff;
1320 tf->hob_lbal = (block >> 24) & 0xff;
1321 } else
1322 /* request too large even for LBA48 */
1323 goto out_of_range;
1324
1325 tf->nsect = n_block & 0xff;
1326
1327 tf->lbah = (block >> 16) & 0xff;
1328 tf->lbam = (block >> 8) & 0xff;
1329 tf->lbal = block & 0xff;
1330
1331 tf->device |= ATA_LBA;
1332 } else {
1333 /* CHS */
1334 u32 sect, head, cyl, track;
1335
1336 if (!lba_28_ok(block, n_block))
1337 goto out_of_range;
1338
1339 /* Convert LBA to CHS */
1340 track = (u32)block / dev->sectors;
1341 cyl = track / dev->heads;
1342 head = track % dev->heads;
1343 sect = (u32)block % dev->sectors + 1;
1344
1345 DPRINTK("block %u track %u cyl %u head %u sect %u\n",
1346 (u32)block, track, cyl, head, sect);
1347
1348 /* Check whether the converted CHS can fit.
1349 Cylinder: 0-65535
1350 Head: 0-15
1351 Sector: 1-255*/
1352 if ((cyl >> 16) || (head >> 4) || (sect >> 8) || (!sect))
1353 goto out_of_range;
1354
1355 tf->command = ATA_CMD_VERIFY;
1356 tf->nsect = n_block & 0xff; /* Sector count 0 means 256 sectors */
1357 tf->lbal = sect;
1358 tf->lbam = cyl;
1359 tf->lbah = cyl >> 8;
1360 tf->device |= head;
1361 }
1362
1363 return 0;
1364
1365 invalid_fld:
1366 ata_scsi_set_sense(scmd, ILLEGAL_REQUEST, 0x24, 0x0);
1367 /* "Invalid field in cbd" */
1368 return 1;
1369
1370 out_of_range:
1371 ata_scsi_set_sense(scmd, ILLEGAL_REQUEST, 0x21, 0x0);
1372 /* "Logical Block Address out of range" */
1373 return 1;
1374
1375 nothing_to_do:
1376 scmd->result = SAM_STAT_GOOD;
1377 return 1;
1378 }
1379
1380 /**
1381 * ata_scsi_rw_xlat - Translate SCSI r/w command into an ATA one
1382 * @qc: Storage for translated ATA taskfile
1383 *
1384 * Converts any of six SCSI read/write commands into the
1385 * ATA counterpart, including starting sector (LBA),
1386 * sector count, and taking into account the device's LBA48
1387 * support.
1388 *
1389 * Commands %READ_6, %READ_10, %READ_16, %WRITE_6, %WRITE_10, and
1390 * %WRITE_16 are currently supported.
1391 *
1392 * LOCKING:
1393 * spin_lock_irqsave(host lock)
1394 *
1395 * RETURNS:
1396 * Zero on success, non-zero on error.
1397 */
1398 static unsigned int ata_scsi_rw_xlat(struct ata_queued_cmd *qc)
1399 {
1400 struct scsi_cmnd *scmd = qc->scsicmd;
1401 const u8 *cdb = scmd->cmnd;
1402 unsigned int tf_flags = 0;
1403 u64 block;
1404 u32 n_block;
1405 int rc;
1406
1407 if (cdb[0] == WRITE_10 || cdb[0] == WRITE_6 || cdb[0] == WRITE_16)
1408 tf_flags |= ATA_TFLAG_WRITE;
1409
1410 /* Calculate the SCSI LBA, transfer length and FUA. */
1411 switch (cdb[0]) {
1412 case READ_10:
1413 case WRITE_10:
1414 if (unlikely(scmd->cmd_len < 10))
1415 goto invalid_fld;
1416 scsi_10_lba_len(cdb, &block, &n_block);
1417 if (unlikely(cdb[1] & (1 << 3)))
1418 tf_flags |= ATA_TFLAG_FUA;
1419 break;
1420 case READ_6:
1421 case WRITE_6:
1422 if (unlikely(scmd->cmd_len < 6))
1423 goto invalid_fld;
1424 scsi_6_lba_len(cdb, &block, &n_block);
1425
1426 /* for 6-byte r/w commands, transfer length 0
1427 * means 256 blocks of data, not 0 block.
1428 */
1429 if (!n_block)
1430 n_block = 256;
1431 break;
1432 case READ_16:
1433 case WRITE_16:
1434 if (unlikely(scmd->cmd_len < 16))
1435 goto invalid_fld;
1436 scsi_16_lba_len(cdb, &block, &n_block);
1437 if (unlikely(cdb[1] & (1 << 3)))
1438 tf_flags |= ATA_TFLAG_FUA;
1439 break;
1440 default:
1441 DPRINTK("no-byte command\n");
1442 goto invalid_fld;
1443 }
1444
1445 /* Check and compose ATA command */
1446 if (!n_block)
1447 /* For 10-byte and 16-byte SCSI R/W commands, transfer
1448 * length 0 means transfer 0 block of data.
1449 * However, for ATA R/W commands, sector count 0 means
1450 * 256 or 65536 sectors, not 0 sectors as in SCSI.
1451 *
1452 * WARNING: one or two older ATA drives treat 0 as 0...
1453 */
1454 goto nothing_to_do;
1455
1456 qc->flags |= ATA_QCFLAG_IO;
1457 qc->nbytes = n_block * ATA_SECT_SIZE;
1458
1459 rc = ata_build_rw_tf(&qc->tf, qc->dev, block, n_block, tf_flags,
1460 qc->tag);
1461 if (likely(rc == 0))
1462 return 0;
1463
1464 if (rc == -ERANGE)
1465 goto out_of_range;
1466 /* treat all other errors as -EINVAL, fall through */
1467 invalid_fld:
1468 ata_scsi_set_sense(scmd, ILLEGAL_REQUEST, 0x24, 0x0);
1469 /* "Invalid field in cbd" */
1470 return 1;
1471
1472 out_of_range:
1473 ata_scsi_set_sense(scmd, ILLEGAL_REQUEST, 0x21, 0x0);
1474 /* "Logical Block Address out of range" */
1475 return 1;
1476
1477 nothing_to_do:
1478 scmd->result = SAM_STAT_GOOD;
1479 return 1;
1480 }
1481
1482 static void ata_scsi_qc_complete(struct ata_queued_cmd *qc)
1483 {
1484 struct ata_port *ap = qc->ap;
1485 struct scsi_cmnd *cmd = qc->scsicmd;
1486 u8 *cdb = cmd->cmnd;
1487 int need_sense = (qc->err_mask != 0);
1488
1489 /* For ATA pass thru (SAT) commands, generate a sense block if
1490 * user mandated it or if there's an error. Note that if we
1491 * generate because the user forced us to, a check condition
1492 * is generated and the ATA register values are returned
1493 * whether the command completed successfully or not. If there
1494 * was no error, SK, ASC and ASCQ will all be zero.
1495 */
1496 if (((cdb[0] == ATA_16) || (cdb[0] == ATA_12)) &&
1497 ((cdb[2] & 0x20) || need_sense)) {
1498 ata_gen_passthru_sense(qc);
1499 } else {
1500 if (!need_sense) {
1501 cmd->result = SAM_STAT_GOOD;
1502 } else {
1503 /* TODO: decide which descriptor format to use
1504 * for 48b LBA devices and call that here
1505 * instead of the fixed desc, which is only
1506 * good for smaller LBA (and maybe CHS?)
1507 * devices.
1508 */
1509 ata_gen_ata_sense(qc);
1510 }
1511 }
1512
1513 /* XXX: track spindown state for spindown skipping and warning */
1514 if (unlikely(qc->tf.command == ATA_CMD_STANDBY ||
1515 qc->tf.command == ATA_CMD_STANDBYNOW1))
1516 qc->dev->flags |= ATA_DFLAG_SPUNDOWN;
1517 else if (likely(system_state != SYSTEM_HALT &&
1518 system_state != SYSTEM_POWER_OFF))
1519 qc->dev->flags &= ~ATA_DFLAG_SPUNDOWN;
1520
1521 if (need_sense && !ap->ops->error_handler)
1522 ata_dump_status(ap->print_id, &qc->result_tf);
1523
1524 qc->scsidone(cmd);
1525
1526 ata_qc_free(qc);
1527 }
1528
1529 /**
1530 * ata_scsi_translate - Translate then issue SCSI command to ATA device
1531 * @dev: ATA device to which the command is addressed
1532 * @cmd: SCSI command to execute
1533 * @done: SCSI command completion function
1534 * @xlat_func: Actor which translates @cmd to an ATA taskfile
1535 *
1536 * Our ->queuecommand() function has decided that the SCSI
1537 * command issued can be directly translated into an ATA
1538 * command, rather than handled internally.
1539 *
1540 * This function sets up an ata_queued_cmd structure for the
1541 * SCSI command, and sends that ata_queued_cmd to the hardware.
1542 *
1543 * The xlat_func argument (actor) returns 0 if ready to execute
1544 * ATA command, else 1 to finish translation. If 1 is returned
1545 * then cmd->result (and possibly cmd->sense_buffer) are assumed
1546 * to be set reflecting an error condition or clean (early)
1547 * termination.
1548 *
1549 * LOCKING:
1550 * spin_lock_irqsave(host lock)
1551 *
1552 * RETURNS:
1553 * 0 on success, SCSI_ML_QUEUE_DEVICE_BUSY if the command
1554 * needs to be deferred.
1555 */
1556 static int ata_scsi_translate(struct ata_device *dev, struct scsi_cmnd *cmd,
1557 void (*done)(struct scsi_cmnd *),
1558 ata_xlat_func_t xlat_func)
1559 {
1560 struct ata_port *ap = dev->link->ap;
1561 struct ata_queued_cmd *qc;
1562 int rc;
1563
1564 VPRINTK("ENTER\n");
1565
1566 qc = ata_scsi_qc_new(dev, cmd, done);
1567 if (!qc)
1568 goto err_mem;
1569
1570 /* data is present; dma-map it */
1571 if (cmd->sc_data_direction == DMA_FROM_DEVICE ||
1572 cmd->sc_data_direction == DMA_TO_DEVICE) {
1573 if (unlikely(scsi_bufflen(cmd) < 1)) {
1574 ata_dev_printk(dev, KERN_WARNING,
1575 "WARNING: zero len r/w req\n");
1576 goto err_did;
1577 }
1578
1579 ata_sg_init(qc, scsi_sglist(cmd), scsi_sg_count(cmd));
1580
1581 qc->dma_dir = cmd->sc_data_direction;
1582 }
1583
1584 qc->complete_fn = ata_scsi_qc_complete;
1585
1586 if (xlat_func(qc))
1587 goto early_finish;
1588
1589 if (ap->ops->qc_defer) {
1590 if ((rc = ap->ops->qc_defer(qc)))
1591 goto defer;
1592 }
1593
1594 /* select device, send command to hardware */
1595 ata_qc_issue(qc);
1596
1597 VPRINTK("EXIT\n");
1598 return 0;
1599
1600 early_finish:
1601 ata_qc_free(qc);
1602 qc->scsidone(cmd);
1603 DPRINTK("EXIT - early finish (good or error)\n");
1604 return 0;
1605
1606 err_did:
1607 ata_qc_free(qc);
1608 cmd->result = (DID_ERROR << 16);
1609 qc->scsidone(cmd);
1610 err_mem:
1611 DPRINTK("EXIT - internal\n");
1612 return 0;
1613
1614 defer:
1615 ata_qc_free(qc);
1616 DPRINTK("EXIT - defer\n");
1617 if (rc == ATA_DEFER_LINK)
1618 return SCSI_MLQUEUE_DEVICE_BUSY;
1619 else
1620 return SCSI_MLQUEUE_HOST_BUSY;
1621 }
1622
1623 /**
1624 * ata_scsi_rbuf_get - Map response buffer.
1625 * @cmd: SCSI command containing buffer to be mapped.
1626 * @buf_out: Pointer to mapped area.
1627 *
1628 * Maps buffer contained within SCSI command @cmd.
1629 *
1630 * LOCKING:
1631 * spin_lock_irqsave(host lock)
1632 *
1633 * RETURNS:
1634 * Length of response buffer.
1635 */
1636
1637 static unsigned int ata_scsi_rbuf_get(struct scsi_cmnd *cmd, u8 **buf_out)
1638 {
1639 u8 *buf;
1640 unsigned int buflen;
1641
1642 struct scatterlist *sg = scsi_sglist(cmd);
1643
1644 if (sg) {
1645 buf = kmap_atomic(sg_page(sg), KM_IRQ0) + sg->offset;
1646 buflen = sg->length;
1647 } else {
1648 buf = NULL;
1649 buflen = 0;
1650 }
1651
1652 *buf_out = buf;
1653 return buflen;
1654 }
1655
1656 /**
1657 * ata_scsi_rbuf_put - Unmap response buffer.
1658 * @cmd: SCSI command containing buffer to be unmapped.
1659 * @buf: buffer to unmap
1660 *
1661 * Unmaps response buffer contained within @cmd.
1662 *
1663 * LOCKING:
1664 * spin_lock_irqsave(host lock)
1665 */
1666
1667 static inline void ata_scsi_rbuf_put(struct scsi_cmnd *cmd, u8 *buf)
1668 {
1669 struct scatterlist *sg = scsi_sglist(cmd);
1670 if (sg)
1671 kunmap_atomic(buf - sg->offset, KM_IRQ0);
1672 }
1673
1674 /**
1675 * ata_scsi_rbuf_fill - wrapper for SCSI command simulators
1676 * @args: device IDENTIFY data / SCSI command of interest.
1677 * @actor: Callback hook for desired SCSI command simulator
1678 *
1679 * Takes care of the hard work of simulating a SCSI command...
1680 * Mapping the response buffer, calling the command's handler,
1681 * and handling the handler's return value. This return value
1682 * indicates whether the handler wishes the SCSI command to be
1683 * completed successfully (0), or not (in which case cmd->result
1684 * and sense buffer are assumed to be set).
1685 *
1686 * LOCKING:
1687 * spin_lock_irqsave(host lock)
1688 */
1689
1690 void ata_scsi_rbuf_fill(struct ata_scsi_args *args,
1691 unsigned int (*actor) (struct ata_scsi_args *args,
1692 u8 *rbuf, unsigned int buflen))
1693 {
1694 u8 *rbuf;
1695 unsigned int buflen, rc;
1696 struct scsi_cmnd *cmd = args->cmd;
1697 unsigned long flags;
1698
1699 local_irq_save(flags);
1700
1701 buflen = ata_scsi_rbuf_get(cmd, &rbuf);
1702 memset(rbuf, 0, buflen);
1703 rc = actor(args, rbuf, buflen);
1704 ata_scsi_rbuf_put(cmd, rbuf);
1705
1706 local_irq_restore(flags);
1707
1708 if (rc == 0)
1709 cmd->result = SAM_STAT_GOOD;
1710 args->done(cmd);
1711 }
1712
1713 /**
1714 * ATA_SCSI_RBUF_SET - helper to set values in SCSI response buffer
1715 * @idx: byte index into SCSI response buffer
1716 * @val: value to set
1717 *
1718 * To be used by SCSI command simulator functions. This macros
1719 * expects two local variables, u8 *rbuf and unsigned int buflen,
1720 * are in scope.
1721 *
1722 * LOCKING:
1723 * None.
1724 */
1725 #define ATA_SCSI_RBUF_SET(idx, val) do { \
1726 if ((idx) < buflen) rbuf[(idx)] = (u8)(val); \
1727 } while (0)
1728
1729 /**
1730 * ata_scsiop_inq_std - Simulate INQUIRY command
1731 * @args: device IDENTIFY data / SCSI command of interest.
1732 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1733 * @buflen: Response buffer length.
1734 *
1735 * Returns standard device identification data associated
1736 * with non-VPD INQUIRY command output.
1737 *
1738 * LOCKING:
1739 * spin_lock_irqsave(host lock)
1740 */
1741
1742 unsigned int ata_scsiop_inq_std(struct ata_scsi_args *args, u8 *rbuf,
1743 unsigned int buflen)
1744 {
1745 u8 hdr[] = {
1746 TYPE_DISK,
1747 0,
1748 0x5, /* claim SPC-3 version compatibility */
1749 2,
1750 95 - 4
1751 };
1752
1753 /* set scsi removeable (RMB) bit per ata bit */
1754 if (ata_id_removeable(args->id))
1755 hdr[1] |= (1 << 7);
1756
1757 VPRINTK("ENTER\n");
1758
1759 memcpy(rbuf, hdr, sizeof(hdr));
1760
1761 if (buflen > 35) {
1762 memcpy(&rbuf[8], "ATA ", 8);
1763 ata_id_string(args->id, &rbuf[16], ATA_ID_PROD, 16);
1764 ata_id_string(args->id, &rbuf[32], ATA_ID_FW_REV, 4);
1765 if (rbuf[32] == 0 || rbuf[32] == ' ')
1766 memcpy(&rbuf[32], "n/a ", 4);
1767 }
1768
1769 if (buflen > 63) {
1770 const u8 versions[] = {
1771 0x60, /* SAM-3 (no version claimed) */
1772
1773 0x03,
1774 0x20, /* SBC-2 (no version claimed) */
1775
1776 0x02,
1777 0x60 /* SPC-3 (no version claimed) */
1778 };
1779
1780 memcpy(rbuf + 59, versions, sizeof(versions));
1781 }
1782
1783 return 0;
1784 }
1785
1786 /**
1787 * ata_scsiop_inq_00 - Simulate INQUIRY VPD page 0, list of pages
1788 * @args: device IDENTIFY data / SCSI command of interest.
1789 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1790 * @buflen: Response buffer length.
1791 *
1792 * Returns list of inquiry VPD pages available.
1793 *
1794 * LOCKING:
1795 * spin_lock_irqsave(host lock)
1796 */
1797
1798 unsigned int ata_scsiop_inq_00(struct ata_scsi_args *args, u8 *rbuf,
1799 unsigned int buflen)
1800 {
1801 const u8 pages[] = {
1802 0x00, /* page 0x00, this page */
1803 0x80, /* page 0x80, unit serial no page */
1804 0x83 /* page 0x83, device ident page */
1805 };
1806 rbuf[3] = sizeof(pages); /* number of supported VPD pages */
1807
1808 if (buflen > 6)
1809 memcpy(rbuf + 4, pages, sizeof(pages));
1810
1811 return 0;
1812 }
1813
1814 /**
1815 * ata_scsiop_inq_80 - Simulate INQUIRY VPD page 80, device serial number
1816 * @args: device IDENTIFY data / SCSI command of interest.
1817 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1818 * @buflen: Response buffer length.
1819 *
1820 * Returns ATA device serial number.
1821 *
1822 * LOCKING:
1823 * spin_lock_irqsave(host lock)
1824 */
1825
1826 unsigned int ata_scsiop_inq_80(struct ata_scsi_args *args, u8 *rbuf,
1827 unsigned int buflen)
1828 {
1829 const u8 hdr[] = {
1830 0,
1831 0x80, /* this page code */
1832 0,
1833 ATA_ID_SERNO_LEN, /* page len */
1834 };
1835 memcpy(rbuf, hdr, sizeof(hdr));
1836
1837 if (buflen > (ATA_ID_SERNO_LEN + 4 - 1))
1838 ata_id_string(args->id, (unsigned char *) &rbuf[4],
1839 ATA_ID_SERNO, ATA_ID_SERNO_LEN);
1840
1841 return 0;
1842 }
1843
1844 /**
1845 * ata_scsiop_inq_83 - Simulate INQUIRY VPD page 83, device identity
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 * Yields two logical unit device identification designators:
1851 * - vendor specific ASCII containing the ATA serial number
1852 * - SAT defined "t10 vendor id based" containing ASCII vendor
1853 * name ("ATA "), model and serial numbers.
1854 *
1855 * LOCKING:
1856 * spin_lock_irqsave(host lock)
1857 */
1858
1859 unsigned int ata_scsiop_inq_83(struct ata_scsi_args *args, u8 *rbuf,
1860 unsigned int buflen)
1861 {
1862 int num;
1863 const int sat_model_serial_desc_len = 68;
1864
1865 rbuf[1] = 0x83; /* this page code */
1866 num = 4;
1867
1868 if (buflen > (ATA_ID_SERNO_LEN + num + 3)) {
1869 /* piv=0, assoc=lu, code_set=ACSII, designator=vendor */
1870 rbuf[num + 0] = 2;
1871 rbuf[num + 3] = ATA_ID_SERNO_LEN;
1872 num += 4;
1873 ata_id_string(args->id, (unsigned char *) rbuf + num,
1874 ATA_ID_SERNO, ATA_ID_SERNO_LEN);
1875 num += ATA_ID_SERNO_LEN;
1876 }
1877 if (buflen > (sat_model_serial_desc_len + num + 3)) {
1878 /* SAT defined lu model and serial numbers descriptor */
1879 /* piv=0, assoc=lu, code_set=ACSII, designator=t10 vendor id */
1880 rbuf[num + 0] = 2;
1881 rbuf[num + 1] = 1;
1882 rbuf[num + 3] = sat_model_serial_desc_len;
1883 num += 4;
1884 memcpy(rbuf + num, "ATA ", 8);
1885 num += 8;
1886 ata_id_string(args->id, (unsigned char *) rbuf + num,
1887 ATA_ID_PROD, ATA_ID_PROD_LEN);
1888 num += ATA_ID_PROD_LEN;
1889 ata_id_string(args->id, (unsigned char *) rbuf + num,
1890 ATA_ID_SERNO, ATA_ID_SERNO_LEN);
1891 num += ATA_ID_SERNO_LEN;
1892 }
1893 rbuf[3] = num - 4; /* page len (assume less than 256 bytes) */
1894 return 0;
1895 }
1896
1897 /**
1898 * ata_scsiop_inq_89 - Simulate INQUIRY VPD page 89, ATA info
1899 * @args: device IDENTIFY data / SCSI command of interest.
1900 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1901 * @buflen: Response buffer length.
1902 *
1903 * Yields SAT-specified ATA VPD page.
1904 *
1905 * LOCKING:
1906 * spin_lock_irqsave(host lock)
1907 */
1908
1909 static unsigned int ata_scsiop_inq_89(struct ata_scsi_args *args, u8 *rbuf,
1910 unsigned int buflen)
1911 {
1912 u8 pbuf[60];
1913 struct ata_taskfile tf;
1914 unsigned int i;
1915
1916 if (!buflen)
1917 return 0;
1918
1919 memset(&pbuf, 0, sizeof(pbuf));
1920 memset(&tf, 0, sizeof(tf));
1921
1922 pbuf[1] = 0x89; /* our page code */
1923 pbuf[2] = (0x238 >> 8); /* page size fixed at 238h */
1924 pbuf[3] = (0x238 & 0xff);
1925
1926 memcpy(&pbuf[8], "linux ", 8);
1927 memcpy(&pbuf[16], "libata ", 16);
1928 memcpy(&pbuf[32], DRV_VERSION, 4);
1929 ata_id_string(args->id, &pbuf[32], ATA_ID_FW_REV, 4);
1930
1931 /* we don't store the ATA device signature, so we fake it */
1932
1933 tf.command = ATA_DRDY; /* really, this is Status reg */
1934 tf.lbal = 0x1;
1935 tf.nsect = 0x1;
1936
1937 ata_tf_to_fis(&tf, 0, 1, &pbuf[36]); /* TODO: PMP? */
1938 pbuf[36] = 0x34; /* force D2H Reg FIS (34h) */
1939
1940 pbuf[56] = ATA_CMD_ID_ATA;
1941
1942 i = min(buflen, 60U);
1943 memcpy(rbuf, &pbuf[0], i);
1944 buflen -= i;
1945
1946 if (!buflen)
1947 return 0;
1948
1949 memcpy(&rbuf[60], &args->id[0], min(buflen, 512U));
1950 return 0;
1951 }
1952
1953 /**
1954 * ata_scsiop_noop - Command handler that simply returns success.
1955 * @args: device IDENTIFY data / SCSI command of interest.
1956 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1957 * @buflen: Response buffer length.
1958 *
1959 * No operation. Simply returns success to caller, to indicate
1960 * that the caller should successfully complete this SCSI command.
1961 *
1962 * LOCKING:
1963 * spin_lock_irqsave(host lock)
1964 */
1965
1966 unsigned int ata_scsiop_noop(struct ata_scsi_args *args, u8 *rbuf,
1967 unsigned int buflen)
1968 {
1969 VPRINTK("ENTER\n");
1970 return 0;
1971 }
1972
1973 /**
1974 * ata_msense_push - Push data onto MODE SENSE data output buffer
1975 * @ptr_io: (input/output) Location to store more output data
1976 * @last: End of output data buffer
1977 * @buf: Pointer to BLOB being added to output buffer
1978 * @buflen: Length of BLOB
1979 *
1980 * Store MODE SENSE data on an output buffer.
1981 *
1982 * LOCKING:
1983 * None.
1984 */
1985
1986 static void ata_msense_push(u8 **ptr_io, const u8 *last,
1987 const u8 *buf, unsigned int buflen)
1988 {
1989 u8 *ptr = *ptr_io;
1990
1991 if ((ptr + buflen - 1) > last)
1992 return;
1993
1994 memcpy(ptr, buf, buflen);
1995
1996 ptr += buflen;
1997
1998 *ptr_io = ptr;
1999 }
2000
2001 /**
2002 * ata_msense_caching - Simulate MODE SENSE caching info page
2003 * @id: device IDENTIFY data
2004 * @ptr_io: (input/output) Location to store more output data
2005 * @last: End of output data buffer
2006 *
2007 * Generate a caching info page, which conditionally indicates
2008 * write caching to the SCSI layer, depending on device
2009 * capabilities.
2010 *
2011 * LOCKING:
2012 * None.
2013 */
2014
2015 static unsigned int ata_msense_caching(u16 *id, u8 **ptr_io,
2016 const u8 *last)
2017 {
2018 u8 page[CACHE_MPAGE_LEN];
2019
2020 memcpy(page, def_cache_mpage, sizeof(page));
2021 if (ata_id_wcache_enabled(id))
2022 page[2] |= (1 << 2); /* write cache enable */
2023 if (!ata_id_rahead_enabled(id))
2024 page[12] |= (1 << 5); /* disable read ahead */
2025
2026 ata_msense_push(ptr_io, last, page, sizeof(page));
2027 return sizeof(page);
2028 }
2029
2030 /**
2031 * ata_msense_ctl_mode - Simulate MODE SENSE control mode page
2032 * @dev: Device associated with this MODE SENSE command
2033 * @ptr_io: (input/output) Location to store more output data
2034 * @last: End of output data buffer
2035 *
2036 * Generate a generic MODE SENSE control mode page.
2037 *
2038 * LOCKING:
2039 * None.
2040 */
2041
2042 static unsigned int ata_msense_ctl_mode(u8 **ptr_io, const u8 *last)
2043 {
2044 ata_msense_push(ptr_io, last, def_control_mpage,
2045 sizeof(def_control_mpage));
2046 return sizeof(def_control_mpage);
2047 }
2048
2049 /**
2050 * ata_msense_rw_recovery - Simulate MODE SENSE r/w error recovery page
2051 * @dev: Device associated with this MODE SENSE command
2052 * @ptr_io: (input/output) Location to store more output data
2053 * @last: End of output data buffer
2054 *
2055 * Generate a generic MODE SENSE r/w error recovery page.
2056 *
2057 * LOCKING:
2058 * None.
2059 */
2060
2061 static unsigned int ata_msense_rw_recovery(u8 **ptr_io, const u8 *last)
2062 {
2063
2064 ata_msense_push(ptr_io, last, def_rw_recovery_mpage,
2065 sizeof(def_rw_recovery_mpage));
2066 return sizeof(def_rw_recovery_mpage);
2067 }
2068
2069 /*
2070 * We can turn this into a real blacklist if it's needed, for now just
2071 * blacklist any Maxtor BANC1G10 revision firmware
2072 */
2073 static int ata_dev_supports_fua(u16 *id)
2074 {
2075 unsigned char model[ATA_ID_PROD_LEN + 1], fw[ATA_ID_FW_REV_LEN + 1];
2076
2077 if (!libata_fua)
2078 return 0;
2079 if (!ata_id_has_fua(id))
2080 return 0;
2081
2082 ata_id_c_string(id, model, ATA_ID_PROD, sizeof(model));
2083 ata_id_c_string(id, fw, ATA_ID_FW_REV, sizeof(fw));
2084
2085 if (strcmp(model, "Maxtor"))
2086 return 1;
2087 if (strcmp(fw, "BANC1G10"))
2088 return 1;
2089
2090 return 0; /* blacklisted */
2091 }
2092
2093 /**
2094 * ata_scsiop_mode_sense - Simulate MODE SENSE 6, 10 commands
2095 * @args: device IDENTIFY data / SCSI command of interest.
2096 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2097 * @buflen: Response buffer length.
2098 *
2099 * Simulate MODE SENSE commands. Assume this is invoked for direct
2100 * access devices (e.g. disks) only. There should be no block
2101 * descriptor for other device types.
2102 *
2103 * LOCKING:
2104 * spin_lock_irqsave(host lock)
2105 */
2106
2107 unsigned int ata_scsiop_mode_sense(struct ata_scsi_args *args, u8 *rbuf,
2108 unsigned int buflen)
2109 {
2110 struct ata_device *dev = args->dev;
2111 u8 *scsicmd = args->cmd->cmnd, *p, *last;
2112 const u8 sat_blk_desc[] = {
2113 0, 0, 0, 0, /* number of blocks: sat unspecified */
2114 0,
2115 0, 0x2, 0x0 /* block length: 512 bytes */
2116 };
2117 u8 pg, spg;
2118 unsigned int ebd, page_control, six_byte, output_len, alloc_len, minlen;
2119 u8 dpofua;
2120
2121 VPRINTK("ENTER\n");
2122
2123 six_byte = (scsicmd[0] == MODE_SENSE);
2124 ebd = !(scsicmd[1] & 0x8); /* dbd bit inverted == edb */
2125 /*
2126 * LLBA bit in msense(10) ignored (compliant)
2127 */
2128
2129 page_control = scsicmd[2] >> 6;
2130 switch (page_control) {
2131 case 0: /* current */
2132 break; /* supported */
2133 case 3: /* saved */
2134 goto saving_not_supp;
2135 case 1: /* changeable */
2136 case 2: /* defaults */
2137 default:
2138 goto invalid_fld;
2139 }
2140
2141 if (six_byte) {
2142 output_len = 4 + (ebd ? 8 : 0);
2143 alloc_len = scsicmd[4];
2144 } else {
2145 output_len = 8 + (ebd ? 8 : 0);
2146 alloc_len = (scsicmd[7] << 8) + scsicmd[8];
2147 }
2148 minlen = (alloc_len < buflen) ? alloc_len : buflen;
2149
2150 p = rbuf + output_len;
2151 last = rbuf + minlen - 1;
2152
2153 pg = scsicmd[2] & 0x3f;
2154 spg = scsicmd[3];
2155 /*
2156 * No mode subpages supported (yet) but asking for _all_
2157 * subpages may be valid
2158 */
2159 if (spg && (spg != ALL_SUB_MPAGES))
2160 goto invalid_fld;
2161
2162 switch(pg) {
2163 case RW_RECOVERY_MPAGE:
2164 output_len += ata_msense_rw_recovery(&p, last);
2165 break;
2166
2167 case CACHE_MPAGE:
2168 output_len += ata_msense_caching(args->id, &p, last);
2169 break;
2170
2171 case CONTROL_MPAGE: {
2172 output_len += ata_msense_ctl_mode(&p, last);
2173 break;
2174 }
2175
2176 case ALL_MPAGES:
2177 output_len += ata_msense_rw_recovery(&p, last);
2178 output_len += ata_msense_caching(args->id, &p, last);
2179 output_len += ata_msense_ctl_mode(&p, last);
2180 break;
2181
2182 default: /* invalid page code */
2183 goto invalid_fld;
2184 }
2185
2186 if (minlen < 1)
2187 return 0;
2188
2189 dpofua = 0;
2190 if (ata_dev_supports_fua(args->id) && (dev->flags & ATA_DFLAG_LBA48) &&
2191 (!(dev->flags & ATA_DFLAG_PIO) || dev->multi_count))
2192 dpofua = 1 << 4;
2193
2194 if (six_byte) {
2195 output_len--;
2196 rbuf[0] = output_len;
2197 if (minlen > 2)
2198 rbuf[2] |= dpofua;
2199 if (ebd) {
2200 if (minlen > 3)
2201 rbuf[3] = sizeof(sat_blk_desc);
2202 if (minlen > 11)
2203 memcpy(rbuf + 4, sat_blk_desc,
2204 sizeof(sat_blk_desc));
2205 }
2206 } else {
2207 output_len -= 2;
2208 rbuf[0] = output_len >> 8;
2209 if (minlen > 1)
2210 rbuf[1] = output_len;
2211 if (minlen > 3)
2212 rbuf[3] |= dpofua;
2213 if (ebd) {
2214 if (minlen > 7)
2215 rbuf[7] = sizeof(sat_blk_desc);
2216 if (minlen > 15)
2217 memcpy(rbuf + 8, sat_blk_desc,
2218 sizeof(sat_blk_desc));
2219 }
2220 }
2221 return 0;
2222
2223 invalid_fld:
2224 ata_scsi_set_sense(args->cmd, ILLEGAL_REQUEST, 0x24, 0x0);
2225 /* "Invalid field in cbd" */
2226 return 1;
2227
2228 saving_not_supp:
2229 ata_scsi_set_sense(args->cmd, ILLEGAL_REQUEST, 0x39, 0x0);
2230 /* "Saving parameters not supported" */
2231 return 1;
2232 }
2233
2234 /**
2235 * ata_scsiop_read_cap - Simulate READ CAPACITY[ 16] commands
2236 * @args: device IDENTIFY data / SCSI command of interest.
2237 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2238 * @buflen: Response buffer length.
2239 *
2240 * Simulate READ CAPACITY commands.
2241 *
2242 * LOCKING:
2243 * None.
2244 */
2245 unsigned int ata_scsiop_read_cap(struct ata_scsi_args *args, u8 *rbuf,
2246 unsigned int buflen)
2247 {
2248 u64 last_lba = args->dev->n_sectors - 1; /* LBA of the last block */
2249
2250 VPRINTK("ENTER\n");
2251
2252 if (args->cmd->cmnd[0] == READ_CAPACITY) {
2253 if (last_lba >= 0xffffffffULL)
2254 last_lba = 0xffffffff;
2255
2256 /* sector count, 32-bit */
2257 ATA_SCSI_RBUF_SET(0, last_lba >> (8 * 3));
2258 ATA_SCSI_RBUF_SET(1, last_lba >> (8 * 2));
2259 ATA_SCSI_RBUF_SET(2, last_lba >> (8 * 1));
2260 ATA_SCSI_RBUF_SET(3, last_lba);
2261
2262 /* sector size */
2263 ATA_SCSI_RBUF_SET(6, ATA_SECT_SIZE >> 8);
2264 ATA_SCSI_RBUF_SET(7, ATA_SECT_SIZE & 0xff);
2265 } else {
2266 /* sector count, 64-bit */
2267 ATA_SCSI_RBUF_SET(0, last_lba >> (8 * 7));
2268 ATA_SCSI_RBUF_SET(1, last_lba >> (8 * 6));
2269 ATA_SCSI_RBUF_SET(2, last_lba >> (8 * 5));
2270 ATA_SCSI_RBUF_SET(3, last_lba >> (8 * 4));
2271 ATA_SCSI_RBUF_SET(4, last_lba >> (8 * 3));
2272 ATA_SCSI_RBUF_SET(5, last_lba >> (8 * 2));
2273 ATA_SCSI_RBUF_SET(6, last_lba >> (8 * 1));
2274 ATA_SCSI_RBUF_SET(7, last_lba);
2275
2276 /* sector size */
2277 ATA_SCSI_RBUF_SET(10, ATA_SECT_SIZE >> 8);
2278 ATA_SCSI_RBUF_SET(11, ATA_SECT_SIZE & 0xff);
2279 }
2280
2281 return 0;
2282 }
2283
2284 /**
2285 * ata_scsiop_report_luns - Simulate REPORT LUNS command
2286 * @args: device IDENTIFY data / SCSI command of interest.
2287 * @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2288 * @buflen: Response buffer length.
2289 *
2290 * Simulate REPORT LUNS command.
2291 *
2292 * LOCKING:
2293 * spin_lock_irqsave(host lock)
2294 */
2295
2296 unsigned int ata_scsiop_report_luns(struct ata_scsi_args *args, u8 *rbuf,
2297 unsigned int buflen)
2298 {
2299 VPRINTK("ENTER\n");
2300 rbuf[3] = 8; /* just one lun, LUN 0, size 8 bytes */
2301
2302 return 0;
2303 }
2304
2305 /**
2306 * ata_scsi_set_sense - Set SCSI sense data and status
2307 * @cmd: SCSI request to be handled
2308 * @sk: SCSI-defined sense key
2309 * @asc: SCSI-defined additional sense code
2310 * @ascq: SCSI-defined additional sense code qualifier
2311 *
2312 * Helper function that builds a valid fixed format, current
2313 * response code and the given sense key (sk), additional sense
2314 * code (asc) and additional sense code qualifier (ascq) with
2315 * a SCSI command status of %SAM_STAT_CHECK_CONDITION and
2316 * DRIVER_SENSE set in the upper bits of scsi_cmnd::result .
2317 *
2318 * LOCKING:
2319 * Not required
2320 */
2321
2322 void ata_scsi_set_sense(struct scsi_cmnd *cmd, u8 sk, u8 asc, u8 ascq)
2323 {
2324 cmd->result = (DRIVER_SENSE << 24) | SAM_STAT_CHECK_CONDITION;
2325
2326 cmd->sense_buffer[0] = 0x70; /* fixed format, current */
2327 cmd->sense_buffer[2] = sk;
2328 cmd->sense_buffer[7] = 18 - 8; /* additional sense length */
2329 cmd->sense_buffer[12] = asc;
2330 cmd->sense_buffer[13] = ascq;
2331 }
2332
2333 /**
2334 * ata_scsi_badcmd - End a SCSI request with an error
2335 * @cmd: SCSI request to be handled
2336 * @done: SCSI command completion function
2337 * @asc: SCSI-defined additional sense code
2338 * @ascq: SCSI-defined additional sense code qualifier
2339 *
2340 * Helper function that completes a SCSI command with
2341 * %SAM_STAT_CHECK_CONDITION, with a sense key %ILLEGAL_REQUEST
2342 * and the specified additional sense codes.
2343 *
2344 * LOCKING:
2345 * spin_lock_irqsave(host lock)
2346 */
2347
2348 void ata_scsi_badcmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *), u8 asc, u8 ascq)
2349 {
2350 DPRINTK("ENTER\n");
2351 ata_scsi_set_sense(cmd, ILLEGAL_REQUEST, asc, ascq);
2352
2353 done(cmd);
2354 }
2355
2356 static void atapi_sense_complete(struct ata_queued_cmd *qc)
2357 {
2358 if (qc->err_mask && ((qc->err_mask & AC_ERR_DEV) == 0)) {
2359 /* FIXME: not quite right; we don't want the
2360 * translation of taskfile registers into
2361 * a sense descriptors, since that's only
2362 * correct for ATA, not ATAPI
2363 */
2364 ata_gen_passthru_sense(qc);
2365 }
2366
2367 qc->scsidone(qc->scsicmd);
2368 ata_qc_free(qc);
2369 }
2370
2371 /* is it pointless to prefer PIO for "safety reasons"? */
2372 static inline int ata_pio_use_silly(struct ata_port *ap)
2373 {
2374 return (ap->flags & ATA_FLAG_PIO_DMA);
2375 }
2376
2377 static void atapi_request_sense(struct ata_queued_cmd *qc)
2378 {
2379 struct ata_port *ap = qc->ap;
2380 struct scsi_cmnd *cmd = qc->scsicmd;
2381
2382 DPRINTK("ATAPI request sense\n");
2383
2384 /* FIXME: is this needed? */
2385 memset(cmd->sense_buffer, 0, SCSI_SENSE_BUFFERSIZE);
2386
2387 ap->ops->tf_read(ap, &qc->tf);
2388
2389 /* fill these in, for the case where they are -not- overwritten */
2390 cmd->sense_buffer[0] = 0x70;
2391 cmd->sense_buffer[2] = qc->tf.feature >> 4;
2392
2393 ata_qc_reinit(qc);
2394
2395 /* setup sg table and init transfer direction */
2396 sg_init_one(&qc->sgent, cmd->sense_buffer, SCSI_SENSE_BUFFERSIZE);
2397 ata_sg_init(qc, &qc->sgent, 1);
2398 qc->dma_dir = DMA_FROM_DEVICE;
2399
2400 memset(&qc->cdb, 0, qc->dev->cdb_len);
2401 qc->cdb[0] = REQUEST_SENSE;
2402 qc->cdb[4] = SCSI_SENSE_BUFFERSIZE;
2403
2404 qc->tf.flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
2405 qc->tf.command = ATA_CMD_PACKET;
2406
2407 if (ata_pio_use_silly(ap)) {
2408 qc->tf.protocol = ATAPI_PROT_DMA;
2409 qc->tf.feature |= ATAPI_PKT_DMA;
2410 } else {
2411 qc->tf.protocol = ATAPI_PROT_PIO;
2412 qc->tf.lbam = SCSI_SENSE_BUFFERSIZE;
2413 qc->tf.lbah = 0;
2414 }
2415 qc->nbytes = SCSI_SENSE_BUFFERSIZE;
2416
2417 qc->complete_fn = atapi_sense_complete;
2418
2419 ata_qc_issue(qc);
2420
2421 DPRINTK("EXIT\n");
2422 }
2423
2424 static void atapi_qc_complete(struct ata_queued_cmd *qc)
2425 {
2426 struct scsi_cmnd *cmd = qc->scsicmd;
2427 unsigned int err_mask = qc->err_mask;
2428
2429 VPRINTK("ENTER, err_mask 0x%X\n", err_mask);
2430
2431 /* handle completion from new EH */
2432 if (unlikely(qc->ap->ops->error_handler &&
2433 (err_mask || qc->flags & ATA_QCFLAG_SENSE_VALID))) {
2434
2435 if (!(qc->flags & ATA_QCFLAG_SENSE_VALID)) {
2436 /* FIXME: not quite right; we don't want the
2437 * translation of taskfile registers into a
2438 * sense descriptors, since that's only
2439 * correct for ATA, not ATAPI
2440 */
2441 ata_gen_passthru_sense(qc);
2442 }
2443
2444 /* SCSI EH automatically locks door if sdev->locked is
2445 * set. Sometimes door lock request continues to
2446 * fail, for example, when no media is present. This
2447 * creates a loop - SCSI EH issues door lock which
2448 * fails and gets invoked again to acquire sense data
2449 * for the failed command.
2450 *
2451 * If door lock fails, always clear sdev->locked to
2452 * avoid this infinite loop.
2453 */
2454 if (qc->cdb[0] == ALLOW_MEDIUM_REMOVAL)
2455 qc->dev->sdev->locked = 0;
2456
2457 qc->scsicmd->result = SAM_STAT_CHECK_CONDITION;
2458 qc->scsidone(cmd);
2459 ata_qc_free(qc);
2460 return;
2461 }
2462
2463 /* successful completion or old EH failure path */
2464 if (unlikely(err_mask & AC_ERR_DEV)) {
2465 cmd->result = SAM_STAT_CHECK_CONDITION;
2466 atapi_request_sense(qc);
2467 return;
2468 } else if (unlikely(err_mask)) {
2469 /* FIXME: not quite right; we don't want the
2470 * translation of taskfile registers into
2471 * a sense descriptors, since that's only
2472 * correct for ATA, not ATAPI
2473 */
2474 ata_gen_passthru_sense(qc);
2475 } else {
2476 u8 *scsicmd = cmd->cmnd;
2477
2478 if ((scsicmd[0] == INQUIRY) && ((scsicmd[1] & 0x03) == 0)) {
2479 u8 *buf = NULL;
2480 unsigned int buflen;
2481 unsigned long flags;
2482
2483 local_irq_save(flags);
2484
2485 buflen = ata_scsi_rbuf_get(cmd, &buf);
2486
2487 /* ATAPI devices typically report zero for their SCSI version,
2488 * and sometimes deviate from the spec WRT response data
2489 * format. If SCSI version is reported as zero like normal,
2490 * then we make the following fixups: 1) Fake MMC-5 version,
2491 * to indicate to the Linux scsi midlayer this is a modern
2492 * device. 2) Ensure response data format / ATAPI information
2493 * are always correct.
2494 */
2495 if (buf[2] == 0) {
2496 buf[2] = 0x5;
2497 buf[3] = 0x32;
2498 }
2499
2500 ata_scsi_rbuf_put(cmd, buf);
2501
2502 local_irq_restore(flags);
2503 }
2504
2505 cmd->result = SAM_STAT_GOOD;
2506 }
2507
2508 qc->scsidone(cmd);
2509 ata_qc_free(qc);
2510 }
2511 /**
2512 * atapi_xlat - Initialize PACKET taskfile
2513 * @qc: command structure to be initialized
2514 *
2515 * LOCKING:
2516 * spin_lock_irqsave(host lock)
2517 *
2518 * RETURNS:
2519 * Zero on success, non-zero on failure.
2520 */
2521 static unsigned int atapi_xlat(struct ata_queued_cmd *qc)
2522 {
2523 struct scsi_cmnd *scmd = qc->scsicmd;
2524 struct ata_device *dev = qc->dev;
2525 int using_pio = (dev->flags & ATA_DFLAG_PIO);
2526 int nodata = (scmd->sc_data_direction == DMA_NONE);
2527 unsigned int nbytes;
2528
2529 memset(qc->cdb, 0, dev->cdb_len);
2530 memcpy(qc->cdb, scmd->cmnd, scmd->cmd_len);
2531
2532 qc->complete_fn = atapi_qc_complete;
2533
2534 qc->tf.flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
2535 if (scmd->sc_data_direction == DMA_TO_DEVICE) {
2536 qc->tf.flags |= ATA_TFLAG_WRITE;
2537 DPRINTK("direction: write\n");
2538 }
2539
2540 qc->tf.command = ATA_CMD_PACKET;
2541 qc->nbytes = scsi_bufflen(scmd) + scmd->request->extra_len;
2542
2543 /* check whether ATAPI DMA is safe */
2544 if (!using_pio && ata_check_atapi_dma(qc))
2545 using_pio = 1;
2546
2547 /* Some controller variants snoop this value for Packet
2548 * transfers to do state machine and FIFO management. Thus we
2549 * want to set it properly, and for DMA where it is
2550 * effectively meaningless.
2551 */
2552 nbytes = min(scmd->request->data_len, (unsigned int)63 * 1024);
2553
2554 /* Most ATAPI devices which honor transfer chunk size don't
2555 * behave according to the spec when odd chunk size which
2556 * matches the transfer length is specified. If the number of
2557 * bytes to transfer is 2n+1. According to the spec, what
2558 * should happen is to indicate that 2n+1 is going to be
2559 * transferred and transfer 2n+2 bytes where the last byte is
2560 * padding.
2561 *
2562 * In practice, this doesn't happen. ATAPI devices first
2563 * indicate and transfer 2n bytes and then indicate and
2564 * transfer 2 bytes where the last byte is padding.
2565 *
2566 * This inconsistency confuses several controllers which
2567 * perform PIO using DMA such as Intel AHCIs and sil3124/32.
2568 * These controllers use actual number of transferred bytes to
2569 * update DMA poitner and transfer of 4n+2 bytes make those
2570 * controller push DMA pointer by 4n+4 bytes because SATA data
2571 * FISes are aligned to 4 bytes. This causes data corruption
2572 * and buffer overrun.
2573 *
2574 * Always setting nbytes to even number solves this problem
2575 * because then ATAPI devices don't have to split data at 2n
2576 * boundaries.
2577 */
2578 if (nbytes & 0x1)
2579 nbytes++;
2580
2581 qc->tf.lbam = (nbytes & 0xFF);
2582 qc->tf.lbah = (nbytes >> 8);
2583
2584 if (using_pio || nodata) {
2585 /* no data, or PIO data xfer */
2586 if (nodata)
2587 qc->tf.protocol = ATAPI_PROT_NODATA;
2588 else
2589 qc->tf.protocol = ATAPI_PROT_PIO;
2590 } else {
2591 /* DMA data xfer */
2592 qc->tf.protocol = ATAPI_PROT_DMA;
2593 qc->tf.feature |= ATAPI_PKT_DMA;
2594
2595 if ((dev->flags & ATA_DFLAG_DMADIR) &&
2596 (scmd->sc_data_direction != DMA_TO_DEVICE))
2597 /* some SATA bridges need us to indicate data xfer direction */
2598 qc->tf.feature |= ATAPI_DMADIR;
2599 }
2600
2601
2602 /* FIXME: We need to translate 0x05 READ_BLOCK_LIMITS to a MODE_SENSE
2603 as ATAPI tape drives don't get this right otherwise */
2604 return 0;
2605 }
2606
2607 static struct ata_device *ata_find_dev(struct ata_port *ap, int devno)
2608 {
2609 if (ap->nr_pmp_links == 0) {
2610 if (likely(devno < ata_link_max_devices(&ap->link)))
2611 return &ap->link.device[devno];
2612 } else {
2613 if (likely(devno < ap->nr_pmp_links))
2614 return &ap->pmp_link[devno].device[0];
2615 }
2616
2617 return NULL;
2618 }
2619
2620 static struct ata_device *__ata_scsi_find_dev(struct ata_port *ap,
2621 const struct scsi_device *scsidev)
2622 {
2623 int devno;
2624
2625 /* skip commands not addressed to targets we simulate */
2626 if (ap->nr_pmp_links == 0) {
2627 if (unlikely(scsidev->channel || scsidev->lun))
2628 return NULL;
2629 devno = scsidev->id;
2630 } else {
2631 if (unlikely(scsidev->id || scsidev->lun))
2632 return NULL;
2633 devno = scsidev->channel;
2634 }
2635
2636 return ata_find_dev(ap, devno);
2637 }
2638
2639 /**
2640 * ata_scsi_dev_enabled - determine if device is enabled
2641 * @dev: ATA device
2642 *
2643 * Determine if commands should be sent to the specified device.
2644 *
2645 * LOCKING:
2646 * spin_lock_irqsave(host lock)
2647 *
2648 * RETURNS:
2649 * 0 if commands are not allowed / 1 if commands are allowed
2650 */
2651
2652 static int ata_scsi_dev_enabled(struct ata_device *dev)
2653 {
2654 if (unlikely(!ata_dev_enabled(dev)))
2655 return 0;
2656
2657 if (!atapi_enabled || (dev->link->ap->flags & ATA_FLAG_NO_ATAPI)) {
2658 if (unlikely(dev->class == ATA_DEV_ATAPI)) {
2659 ata_dev_printk(dev, KERN_WARNING,
2660 "WARNING: ATAPI is %s, device ignored.\n",
2661 atapi_enabled ? "not supported with this driver" : "disabled");
2662 return 0;
2663 }
2664 }
2665
2666 return 1;
2667 }
2668
2669 /**
2670 * ata_scsi_find_dev - lookup ata_device from scsi_cmnd
2671 * @ap: ATA port to which the device is attached
2672 * @scsidev: SCSI device from which we derive the ATA device
2673 *
2674 * Given various information provided in struct scsi_cmnd,
2675 * map that onto an ATA bus, and using that mapping
2676 * determine which ata_device is associated with the
2677 * SCSI command to be sent.
2678 *
2679 * LOCKING:
2680 * spin_lock_irqsave(host lock)
2681 *
2682 * RETURNS:
2683 * Associated ATA device, or %NULL if not found.
2684 */
2685 static struct ata_device *
2686 ata_scsi_find_dev(struct ata_port *ap, const struct scsi_device *scsidev)
2687 {
2688 struct ata_device *dev = __ata_scsi_find_dev(ap, scsidev);
2689
2690 if (unlikely(!dev || !ata_scsi_dev_enabled(dev)))
2691 return NULL;
2692
2693 return dev;
2694 }
2695
2696 /*
2697 * ata_scsi_map_proto - Map pass-thru protocol value to taskfile value.
2698 * @byte1: Byte 1 from pass-thru CDB.
2699 *
2700 * RETURNS:
2701 * ATA_PROT_UNKNOWN if mapping failed/unimplemented, protocol otherwise.
2702 */
2703 static u8
2704 ata_scsi_map_proto(u8 byte1)
2705 {
2706 switch((byte1 & 0x1e) >> 1) {
2707 case 3: /* Non-data */
2708 return ATA_PROT_NODATA;
2709
2710 case 6: /* DMA */
2711 case 10: /* UDMA Data-in */
2712 case 11: /* UDMA Data-Out */
2713 return ATA_PROT_DMA;
2714
2715 case 4: /* PIO Data-in */
2716 case 5: /* PIO Data-out */
2717 return ATA_PROT_PIO;
2718
2719 case 0: /* Hard Reset */
2720 case 1: /* SRST */
2721 case 8: /* Device Diagnostic */
2722 case 9: /* Device Reset */
2723 case 7: /* DMA Queued */
2724 case 12: /* FPDMA */
2725 case 15: /* Return Response Info */
2726 default: /* Reserved */
2727 break;
2728 }
2729
2730 return ATA_PROT_UNKNOWN;
2731 }
2732
2733 /**
2734 * ata_scsi_pass_thru - convert ATA pass-thru CDB to taskfile
2735 * @qc: command structure to be initialized
2736 *
2737 * Handles either 12 or 16-byte versions of the CDB.
2738 *
2739 * RETURNS:
2740 * Zero on success, non-zero on failure.
2741 */
2742 static unsigned int ata_scsi_pass_thru(struct ata_queued_cmd *qc)
2743 {
2744 struct ata_taskfile *tf = &(qc->tf);
2745 struct scsi_cmnd *scmd = qc->scsicmd;
2746 struct ata_device *dev = qc->dev;
2747 const u8 *cdb = scmd->cmnd;
2748
2749 if ((tf->protocol = ata_scsi_map_proto(cdb[1])) == ATA_PROT_UNKNOWN)
2750 goto invalid_fld;
2751
2752 /*
2753 * Filter TPM commands by default. These provide an
2754 * essentially uncontrolled encrypted "back door" between
2755 * applications and the disk. Set libata.allow_tpm=1 if you
2756 * have a real reason for wanting to use them. This ensures
2757 * that installed software cannot easily mess stuff up without
2758 * user intent. DVR type users will probably ship with this enabled
2759 * for movie content management.
2760 *
2761 * Note that for ATA8 we can issue a DCS change and DCS freeze lock
2762 * for this and should do in future but that it is not sufficient as
2763 * DCS is an optional feature set. Thus we also do the software filter
2764 * so that we comply with the TC consortium stated goal that the user
2765 * can turn off TC features of their system.
2766 */
2767 if (tf->command >= 0x5C && tf->command <= 0x5F && !libata_allow_tpm)
2768 goto invalid_fld;
2769
2770 /* We may not issue DMA commands if no DMA mode is set */
2771 if (tf->protocol == ATA_PROT_DMA && dev->dma_mode == 0)
2772 goto invalid_fld;
2773
2774 /*
2775 * 12 and 16 byte CDBs use different offsets to
2776 * provide the various register values.
2777 */
2778 if (cdb[0] == ATA_16) {
2779 /*
2780 * 16-byte CDB - may contain extended commands.
2781 *
2782 * If that is the case, copy the upper byte register values.
2783 */
2784 if (cdb[1] & 0x01) {
2785 tf->hob_feature = cdb[3];
2786 tf->hob_nsect = cdb[5];
2787 tf->hob_lbal = cdb[7];
2788 tf->hob_lbam = cdb[9];
2789 tf->hob_lbah = cdb[11];
2790 tf->flags |= ATA_TFLAG_LBA48;
2791 } else
2792 tf->flags &= ~ATA_TFLAG_LBA48;
2793
2794 /*
2795 * Always copy low byte, device and command registers.
2796 */
2797 tf->feature = cdb[4];
2798 tf->nsect = cdb[6];
2799 tf->lbal = cdb[8];
2800 tf->lbam = cdb[10];
2801 tf->lbah = cdb[12];
2802 tf->device = cdb[13];
2803 tf->command = cdb[14];
2804 } else {
2805 /*
2806 * 12-byte CDB - incapable of extended commands.
2807 */
2808 tf->flags &= ~ATA_TFLAG_LBA48;
2809
2810 tf->feature = cdb[3];
2811 tf->nsect = cdb[4];
2812 tf->lbal = cdb[5];
2813 tf->lbam = cdb[6];
2814 tf->lbah = cdb[7];
2815 tf->device = cdb[8];
2816 tf->command = cdb[9];
2817 }
2818
2819 /* enforce correct master/slave bit */
2820 tf->device = dev->devno ?
2821 tf->device | ATA_DEV1 : tf->device & ~ATA_DEV1;
2822
2823 /* sanity check for pio multi commands */
2824 if ((cdb[1] & 0xe0) && !is_multi_taskfile(tf))
2825 goto invalid_fld;
2826
2827 if (is_multi_taskfile(tf)) {
2828 unsigned int multi_count = 1 << (cdb[1] >> 5);
2829
2830 /* compare the passed through multi_count
2831 * with the cached multi_count of libata
2832 */
2833 if (multi_count != dev->multi_count)
2834 ata_dev_printk(dev, KERN_WARNING,
2835 "invalid multi_count %u ignored\n",
2836 multi_count);
2837 }
2838
2839 /* READ/WRITE LONG use a non-standard sect_size */
2840 qc->sect_size = ATA_SECT_SIZE;
2841 switch (tf->command) {
2842 case ATA_CMD_READ_LONG:
2843 case ATA_CMD_READ_LONG_ONCE:
2844 case ATA_CMD_WRITE_LONG:
2845 case ATA_CMD_WRITE_LONG_ONCE:
2846 if (tf->protocol != ATA_PROT_PIO || tf->nsect != 1)
2847 goto invalid_fld;
2848 qc->sect_size = scsi_bufflen(scmd);
2849 }
2850
2851 /*
2852 * Filter SET_FEATURES - XFER MODE command -- otherwise,
2853 * SET_FEATURES - XFER MODE must be preceded/succeeded
2854 * by an update to hardware-specific registers for each
2855 * controller (i.e. the reason for ->set_piomode(),
2856 * ->set_dmamode(), and ->post_set_mode() hooks).
2857 */
2858 if ((tf->command == ATA_CMD_SET_FEATURES)
2859 && (tf->feature == SETFEATURES_XFER))
2860 goto invalid_fld;
2861
2862 /*
2863 * Set flags so that all registers will be written,
2864 * and pass on write indication (used for PIO/DMA
2865 * setup.)
2866 */
2867 tf->flags |= (ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE);
2868
2869 if (scmd->sc_data_direction == DMA_TO_DEVICE)
2870 tf->flags |= ATA_TFLAG_WRITE;
2871
2872 /*
2873 * Set transfer length.
2874 *
2875 * TODO: find out if we need to do more here to
2876 * cover scatter/gather case.
2877 */
2878 qc->nbytes = scsi_bufflen(scmd) + scmd->request->extra_len;
2879
2880 /* request result TF and be quiet about device error */
2881 qc->flags |= ATA_QCFLAG_RESULT_TF | ATA_QCFLAG_QUIET;
2882
2883 return 0;
2884
2885 invalid_fld:
2886 ata_scsi_set_sense(scmd, ILLEGAL_REQUEST, 0x24, 0x00);
2887 /* "Invalid field in cdb" */
2888 return 1;
2889 }
2890
2891 /**
2892 * ata_get_xlat_func - check if SCSI to ATA translation is possible
2893 * @dev: ATA device
2894 * @cmd: SCSI command opcode to consider
2895 *
2896 * Look up the SCSI command given, and determine whether the
2897 * SCSI command is to be translated or simulated.
2898 *
2899 * RETURNS:
2900 * Pointer to translation function if possible, %NULL if not.
2901 */
2902
2903 static inline ata_xlat_func_t ata_get_xlat_func(struct ata_device *dev, u8 cmd)
2904 {
2905 switch (cmd) {
2906 case READ_6:
2907 case READ_10:
2908 case READ_16:
2909
2910 case WRITE_6:
2911 case WRITE_10:
2912 case WRITE_16:
2913 return ata_scsi_rw_xlat;
2914
2915 case SYNCHRONIZE_CACHE:
2916 if (ata_try_flush_cache(dev))
2917 return ata_scsi_flush_xlat;
2918 break;
2919
2920 case VERIFY:
2921 case VERIFY_16:
2922 return ata_scsi_verify_xlat;
2923
2924 case ATA_12:
2925 case ATA_16:
2926 return ata_scsi_pass_thru;
2927
2928 case START_STOP:
2929 return ata_scsi_start_stop_xlat;
2930 }
2931
2932 return NULL;
2933 }
2934
2935 /**
2936 * ata_scsi_dump_cdb - dump SCSI command contents to dmesg
2937 * @ap: ATA port to which the command was being sent
2938 * @cmd: SCSI command to dump
2939 *
2940 * Prints the contents of a SCSI command via printk().
2941 */
2942
2943 static inline void ata_scsi_dump_cdb(struct ata_port *ap,
2944 struct scsi_cmnd *cmd)
2945 {
2946 #ifdef ATA_DEBUG
2947 struct scsi_device *scsidev = cmd->device;
2948 u8 *scsicmd = cmd->cmnd;
2949
2950 DPRINTK("CDB (%u:%d,%d,%d) %02x %02x %02x %02x %02x %02x %02x %02x %02x\n",
2951 ap->print_id,
2952 scsidev->channel, scsidev->id, scsidev->lun,
2953 scsicmd[0], scsicmd[1], scsicmd[2], scsicmd[3],
2954 scsicmd[4], scsicmd[5], scsicmd[6], scsicmd[7],
2955 scsicmd[8]);
2956 #endif
2957 }
2958
2959 static inline int __ata_scsi_queuecmd(struct scsi_cmnd *scmd,
2960 void (*done)(struct scsi_cmnd *),
2961 struct ata_device *dev)
2962 {
2963 u8 scsi_op = scmd->cmnd[0];
2964 ata_xlat_func_t xlat_func;
2965 int rc = 0;
2966
2967 if (dev->class == ATA_DEV_ATA) {
2968 if (unlikely(!scmd->cmd_len || scmd->cmd_len > dev->cdb_len))
2969 goto bad_cdb_len;
2970
2971 xlat_func = ata_get_xlat_func(dev, scsi_op);
2972 } else {
2973 if (unlikely(!scmd->cmd_len))
2974 goto bad_cdb_len;
2975
2976 xlat_func = NULL;
2977 if (likely((scsi_op != ATA_16) || !atapi_passthru16)) {
2978 /* relay SCSI command to ATAPI device */
2979 int len = COMMAND_SIZE(scsi_op);
2980 if (unlikely(len > scmd->cmd_len || len > dev->cdb_len))
2981 goto bad_cdb_len;
2982
2983 xlat_func = atapi_xlat;
2984 } else {
2985 /* ATA_16 passthru, treat as an ATA command */
2986 if (unlikely(scmd->cmd_len > 16))
2987 goto bad_cdb_len;
2988
2989 xlat_func = ata_get_xlat_func(dev, scsi_op);
2990 }
2991 }
2992
2993 if (xlat_func)
2994 rc = ata_scsi_translate(dev, scmd, done, xlat_func);
2995 else
2996 ata_scsi_simulate(dev, scmd, done);
2997
2998 return rc;
2999
3000 bad_cdb_len:
3001 DPRINTK("bad CDB len=%u, scsi_op=0x%02x, max=%u\n",
3002 scmd->cmd_len, scsi_op, dev->cdb_len);
3003 scmd->result = DID_ERROR << 16;
3004 done(scmd);
3005 return 0;
3006 }
3007
3008 /**
3009 * ata_scsi_queuecmd - Issue SCSI cdb to libata-managed device
3010 * @cmd: SCSI command to be sent
3011 * @done: Completion function, called when command is complete
3012 *
3013 * In some cases, this function translates SCSI commands into
3014 * ATA taskfiles, and queues the taskfiles to be sent to
3015 * hardware. In other cases, this function simulates a
3016 * SCSI device by evaluating and responding to certain
3017 * SCSI commands. This creates the overall effect of
3018 * ATA and ATAPI devices appearing as SCSI devices.
3019 *
3020 * LOCKING:
3021 * Releases scsi-layer-held lock, and obtains host lock.
3022 *
3023 * RETURNS:
3024 * Return value from __ata_scsi_queuecmd() if @cmd can be queued,
3025 * 0 otherwise.
3026 */
3027 int ata_scsi_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *))
3028 {
3029 struct ata_port *ap;
3030 struct ata_device *dev;
3031 struct scsi_device *scsidev = cmd->device;
3032 struct Scsi_Host *shost = scsidev->host;
3033 int rc = 0;
3034
3035 ap = ata_shost_to_port(shost);
3036
3037 spin_unlock(shost->host_lock);
3038 spin_lock(ap->lock);
3039
3040 ata_scsi_dump_cdb(ap, cmd);
3041
3042 dev = ata_scsi_find_dev(ap, scsidev);
3043 if (likely(dev))
3044 rc = __ata_scsi_queuecmd(cmd, done, dev);
3045 else {
3046 cmd->result = (DID_BAD_TARGET << 16);
3047 done(cmd);
3048 }
3049
3050 spin_unlock(ap->lock);
3051 spin_lock(shost->host_lock);
3052 return rc;
3053 }
3054
3055 /**
3056 * ata_scsi_simulate - simulate SCSI command on ATA device
3057 * @dev: the target device
3058 * @cmd: SCSI command being sent to device.
3059 * @done: SCSI command completion function.
3060 *
3061 * Interprets and directly executes a select list of SCSI commands
3062 * that can be handled internally.
3063 *
3064 * LOCKING:
3065 * spin_lock_irqsave(host lock)
3066 */
3067
3068 void ata_scsi_simulate(struct ata_device *dev, struct scsi_cmnd *cmd,
3069 void (*done)(struct scsi_cmnd *))
3070 {
3071 struct ata_scsi_args args;
3072 const u8 *scsicmd = cmd->cmnd;
3073 u8 tmp8;
3074
3075 args.dev = dev;
3076 args.id = dev->id;
3077 args.cmd = cmd;
3078 args.done = done;
3079
3080 switch(scsicmd[0]) {
3081 /* TODO: worth improving? */
3082 case FORMAT_UNIT:
3083 ata_scsi_invalid_field(cmd, done);
3084 break;
3085
3086 case INQUIRY:
3087 if (scsicmd[1] & 2) /* is CmdDt set? */
3088 ata_scsi_invalid_field(cmd, done);
3089 else if ((scsicmd[1] & 1) == 0) /* is EVPD clear? */
3090 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_std);
3091 else switch (scsicmd[2]) {
3092 case 0x00:
3093 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_00);
3094 break;
3095 case 0x80:
3096 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_80);
3097 break;
3098 case 0x83:
3099 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_83);
3100 break;
3101 case 0x89:
3102 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_89);
3103 break;
3104 default:
3105 ata_scsi_invalid_field(cmd, done);
3106 break;
3107 }
3108 break;
3109
3110 case MODE_SENSE:
3111 case MODE_SENSE_10:
3112 ata_scsi_rbuf_fill(&args, ata_scsiop_mode_sense);
3113 break;
3114
3115 case MODE_SELECT: /* unconditionally return */
3116 case MODE_SELECT_10: /* bad-field-in-cdb */
3117 ata_scsi_invalid_field(cmd, done);
3118 break;
3119
3120 case READ_CAPACITY:
3121 ata_scsi_rbuf_fill(&args, ata_scsiop_read_cap);
3122 break;
3123
3124 case SERVICE_ACTION_IN:
3125 if ((scsicmd[1] & 0x1f) == SAI_READ_CAPACITY_16)
3126 ata_scsi_rbuf_fill(&args, ata_scsiop_read_cap);
3127 else
3128 ata_scsi_invalid_field(cmd, done);
3129 break;
3130
3131 case REPORT_LUNS:
3132 ata_scsi_rbuf_fill(&args, ata_scsiop_report_luns);
3133 break;
3134
3135 case REQUEST_SENSE:
3136 ata_scsi_set_sense(cmd, 0, 0, 0);
3137 cmd->result = (DRIVER_SENSE << 24);
3138 done(cmd);
3139 break;
3140
3141 /* if we reach this, then writeback caching is disabled,
3142 * turning this into a no-op.
3143 */
3144 case SYNCHRONIZE_CACHE:
3145 /* fall through */
3146
3147 /* no-op's, complete with success */
3148 case REZERO_UNIT:
3149 case SEEK_6:
3150 case SEEK_10:
3151 case TEST_UNIT_READY:
3152 ata_scsi_rbuf_fill(&args, ata_scsiop_noop);
3153 break;
3154
3155 case SEND_DIAGNOSTIC:
3156 tmp8 = scsicmd[1] & ~(1 << 3);
3157 if ((tmp8 == 0x4) && (!scsicmd[3]) && (!scsicmd[4]))
3158 ata_scsi_rbuf_fill(&args, ata_scsiop_noop);
3159 else
3160 ata_scsi_invalid_field(cmd, done);
3161 break;
3162
3163 /* all other commands */
3164 default:
3165 ata_scsi_set_sense(cmd, ILLEGAL_REQUEST, 0x20, 0x0);
3166 /* "Invalid command operation code" */
3167 done(cmd);
3168 break;
3169 }
3170 }
3171
3172 int ata_scsi_add_hosts(struct ata_host *host, struct scsi_host_template *sht)
3173 {
3174 int i, rc;
3175
3176 for (i = 0; i < host->n_ports; i++) {
3177 struct ata_port *ap = host->ports[i];
3178 struct Scsi_Host *shost;
3179
3180 rc = -ENOMEM;
3181 shost = scsi_host_alloc(sht, sizeof(struct ata_port *));
3182 if (!shost)
3183 goto err_alloc;
3184
3185 *(struct ata_port **)&shost->hostdata[0] = ap;
3186 ap->scsi_host = shost;
3187
3188 shost->transportt = &ata_scsi_transport_template;
3189 shost->unique_id = ap->print_id;
3190 shost->max_id = 16;
3191 shost->max_lun = 1;
3192 shost->max_channel = 1;
3193 shost->max_cmd_len = 16;
3194
3195 /* Schedule policy is determined by ->qc_defer()
3196 * callback and it needs to see every deferred qc.
3197 * Set host_blocked to 1 to prevent SCSI midlayer from
3198 * automatically deferring requests.
3199 */
3200 shost->max_host_blocked = 1;
3201
3202 rc = scsi_add_host(ap->scsi_host, ap->host->dev);
3203 if (rc)
3204 goto err_add;
3205 }
3206
3207 return 0;
3208
3209 err_add:
3210 scsi_host_put(host->ports[i]->scsi_host);
3211 err_alloc:
3212 while (--i >= 0) {
3213 struct Scsi_Host *shost = host->ports[i]->scsi_host;
3214
3215 scsi_remove_host(shost);
3216 scsi_host_put(shost);
3217 }
3218 return rc;
3219 }
3220
3221 void ata_scsi_scan_host(struct ata_port *ap, int sync)
3222 {
3223 int tries = 5;
3224 struct ata_device *last_failed_dev = NULL;
3225 struct ata_link *link;
3226 struct ata_device *dev;
3227
3228 if (ap->flags & ATA_FLAG_DISABLED)
3229 return;
3230
3231 repeat:
3232 ata_port_for_each_link(link, ap) {
3233 ata_link_for_each_dev(dev, link) {
3234 struct scsi_device *sdev;
3235 int channel = 0, id = 0;
3236
3237 if (!ata_dev_enabled(dev) || dev->sdev)
3238 continue;
3239
3240 if (ata_is_host_link(link))
3241 id = dev->devno;
3242 else
3243 channel = link->pmp;
3244
3245 sdev = __scsi_add_device(ap->scsi_host, channel, id, 0,
3246 NULL);
3247 if (!IS_ERR(sdev)) {
3248 dev->sdev = sdev;
3249 scsi_device_put(sdev);
3250 }
3251 }
3252 }
3253
3254 /* If we scanned while EH was in progress or allocation
3255 * failure occurred, scan would have failed silently. Check
3256 * whether all devices are attached.
3257 */
3258 ata_port_for_each_link(link, ap) {
3259 ata_link_for_each_dev(dev, link) {
3260 if (ata_dev_enabled(dev) && !dev->sdev)
3261 goto exit_loop;
3262 }
3263 }
3264 exit_loop:
3265 if (!link)
3266 return;
3267
3268 /* we're missing some SCSI devices */
3269 if (sync) {
3270 /* If caller requested synchrnous scan && we've made
3271 * any progress, sleep briefly and repeat.
3272 */
3273 if (dev != last_failed_dev) {
3274 msleep(100);
3275 last_failed_dev = dev;
3276 goto repeat;
3277 }
3278
3279 /* We might be failing to detect boot device, give it
3280 * a few more chances.
3281 */
3282 if (--tries) {
3283 msleep(100);
3284 goto repeat;
3285 }
3286
3287 ata_port_printk(ap, KERN_ERR, "WARNING: synchronous SCSI scan "
3288 "failed without making any progress,\n"
3289 " switching to async\n");
3290 }
3291
3292 queue_delayed_work(ata_aux_wq, &ap->hotplug_task,
3293 round_jiffies_relative(HZ));
3294 }
3295
3296 /**
3297 * ata_scsi_offline_dev - offline attached SCSI device
3298 * @dev: ATA device to offline attached SCSI device for
3299 *
3300 * This function is called from ata_eh_hotplug() and responsible
3301 * for taking the SCSI device attached to @dev offline. This
3302 * function is called with host lock which protects dev->sdev
3303 * against clearing.
3304 *
3305 * LOCKING:
3306 * spin_lock_irqsave(host lock)
3307 *
3308 * RETURNS:
3309 * 1 if attached SCSI device exists, 0 otherwise.
3310 */
3311 int ata_scsi_offline_dev(struct ata_device *dev)
3312 {
3313 if (dev->sdev) {
3314 scsi_device_set_state(dev->sdev, SDEV_OFFLINE);
3315 return 1;
3316 }
3317 return 0;
3318 }
3319
3320 /**
3321 * ata_scsi_remove_dev - remove attached SCSI device
3322 * @dev: ATA device to remove attached SCSI device for
3323 *
3324 * This function is called from ata_eh_scsi_hotplug() and
3325 * responsible for removing the SCSI device attached to @dev.
3326 *
3327 * LOCKING:
3328 * Kernel thread context (may sleep).
3329 */
3330 static void ata_scsi_remove_dev(struct ata_device *dev)
3331 {
3332 struct ata_port *ap = dev->link->ap;
3333 struct scsi_device *sdev;
3334 unsigned long flags;
3335
3336 /* Alas, we need to grab scan_mutex to ensure SCSI device
3337 * state doesn't change underneath us and thus
3338 * scsi_device_get() always succeeds. The mutex locking can
3339 * be removed if there is __scsi_device_get() interface which
3340 * increments reference counts regardless of device state.
3341 */
3342 mutex_lock(&ap->scsi_host->scan_mutex);
3343 spin_lock_irqsave(ap->lock, flags);
3344
3345 /* clearing dev->sdev is protected by host lock */
3346 sdev = dev->sdev;
3347 dev->sdev = NULL;
3348
3349 if (sdev) {
3350 /* If user initiated unplug races with us, sdev can go
3351 * away underneath us after the host lock and
3352 * scan_mutex are released. Hold onto it.
3353 */
3354 if (scsi_device_get(sdev) == 0) {
3355 /* The following ensures the attached sdev is
3356 * offline on return from ata_scsi_offline_dev()
3357 * regardless it wins or loses the race
3358 * against this function.
3359 */
3360 scsi_device_set_state(sdev, SDEV_OFFLINE);
3361 } else {
3362 WARN_ON(1);
3363 sdev = NULL;
3364 }
3365 }
3366
3367 spin_unlock_irqrestore(ap->lock, flags);
3368 mutex_unlock(&ap->scsi_host->scan_mutex);
3369
3370 if (sdev) {
3371 ata_dev_printk(dev, KERN_INFO, "detaching (SCSI %s)\n",
3372 sdev->sdev_gendev.bus_id);
3373
3374 scsi_remove_device(sdev);
3375 scsi_device_put(sdev);
3376 }
3377 }
3378
3379 static void ata_scsi_handle_link_detach(struct ata_link *link)
3380 {
3381 struct ata_port *ap = link->ap;
3382 struct ata_device *dev;
3383
3384 ata_link_for_each_dev(dev, link) {
3385 unsigned long flags;
3386
3387 if (!(dev->flags & ATA_DFLAG_DETACHED))
3388 continue;
3389
3390 spin_lock_irqsave(ap->lock, flags);
3391 dev->flags &= ~ATA_DFLAG_DETACHED;
3392 spin_unlock_irqrestore(ap->lock, flags);
3393
3394 ata_scsi_remove_dev(dev);
3395 }
3396 }
3397
3398 /**
3399 * ata_scsi_media_change_notify - send media change event
3400 * @dev: Pointer to the disk device with media change event
3401 *
3402 * Tell the block layer to send a media change notification
3403 * event.
3404 *
3405 * LOCKING:
3406 * spin_lock_irqsave(host lock)
3407 */
3408 void ata_scsi_media_change_notify(struct ata_device *dev)
3409 {
3410 if (dev->sdev)
3411 sdev_evt_send_simple(dev->sdev, SDEV_EVT_MEDIA_CHANGE,
3412 GFP_ATOMIC);
3413 }
3414
3415 /**
3416 * ata_scsi_hotplug - SCSI part of hotplug
3417 * @work: Pointer to ATA port to perform SCSI hotplug on
3418 *
3419 * Perform SCSI part of hotplug. It's executed from a separate
3420 * workqueue after EH completes. This is necessary because SCSI
3421 * hot plugging requires working EH and hot unplugging is
3422 * synchronized with hot plugging with a mutex.
3423 *
3424 * LOCKING:
3425 * Kernel thread context (may sleep).
3426 */
3427 void ata_scsi_hotplug(struct work_struct *work)
3428 {
3429 struct ata_port *ap =
3430 container_of(work, struct ata_port, hotplug_task.work);
3431 int i;
3432
3433 if (ap->pflags & ATA_PFLAG_UNLOADING) {
3434 DPRINTK("ENTER/EXIT - unloading\n");
3435 return;
3436 }
3437
3438 DPRINTK("ENTER\n");
3439
3440 /* Unplug detached devices. We cannot use link iterator here
3441 * because PMP links have to be scanned even if PMP is
3442 * currently not attached. Iterate manually.
3443 */
3444 ata_scsi_handle_link_detach(&ap->link);
3445 if (ap->pmp_link)
3446 for (i = 0; i < SATA_PMP_MAX_PORTS; i++)
3447 ata_scsi_handle_link_detach(&ap->pmp_link[i]);
3448
3449 /* scan for new ones */
3450 ata_scsi_scan_host(ap, 0);
3451
3452 DPRINTK("EXIT\n");
3453 }
3454
3455 /**
3456 * ata_scsi_user_scan - indication for user-initiated bus scan
3457 * @shost: SCSI host to scan
3458 * @channel: Channel to scan
3459 * @id: ID to scan
3460 * @lun: LUN to scan
3461 *
3462 * This function is called when user explicitly requests bus
3463 * scan. Set probe pending flag and invoke EH.
3464 *
3465 * LOCKING:
3466 * SCSI layer (we don't care)
3467 *
3468 * RETURNS:
3469 * Zero.
3470 */
3471 static int ata_scsi_user_scan(struct Scsi_Host *shost, unsigned int channel,
3472 unsigned int id, unsigned int lun)
3473 {
3474 struct ata_port *ap = ata_shost_to_port(shost);
3475 unsigned long flags;
3476 int devno, rc = 0;
3477
3478 if (!ap->ops->error_handler)
3479 return -EOPNOTSUPP;
3480
3481 if (lun != SCAN_WILD_CARD && lun)
3482 return -EINVAL;
3483
3484 if (ap->nr_pmp_links == 0) {
3485 if (channel != SCAN_WILD_CARD && channel)
3486 return -EINVAL;
3487 devno = id;
3488 } else {
3489 if (id != SCAN_WILD_CARD && id)
3490 return -EINVAL;
3491 devno = channel;
3492 }
3493
3494 spin_lock_irqsave(ap->lock, flags);
3495
3496 if (devno == SCAN_WILD_CARD) {
3497 struct ata_link *link;
3498
3499 ata_port_for_each_link(link, ap) {
3500 struct ata_eh_info *ehi = &link->eh_info;
3501 ehi->probe_mask |= (1 << ata_link_max_devices(link)) - 1;
3502 ehi->action |= ATA_EH_SOFTRESET;
3503 }
3504 } else {
3505 struct ata_device *dev = ata_find_dev(ap, devno);
3506
3507 if (dev) {
3508 struct ata_eh_info *ehi = &dev->link->eh_info;
3509 ehi->probe_mask |= 1 << dev->devno;
3510 ehi->action |= ATA_EH_SOFTRESET;
3511 ehi->flags |= ATA_EHI_RESUME_LINK;
3512 } else
3513 rc = -EINVAL;
3514 }
3515
3516 if (rc == 0) {
3517 ata_port_schedule_eh(ap);
3518 spin_unlock_irqrestore(ap->lock, flags);
3519 ata_port_wait_eh(ap);
3520 } else
3521 spin_unlock_irqrestore(ap->lock, flags);
3522
3523 return rc;
3524 }
3525
3526 /**
3527 * ata_scsi_dev_rescan - initiate scsi_rescan_device()
3528 * @work: Pointer to ATA port to perform scsi_rescan_device()
3529 *
3530 * After ATA pass thru (SAT) commands are executed successfully,
3531 * libata need to propagate the changes to SCSI layer. This
3532 * function must be executed from ata_aux_wq such that sdev
3533 * attach/detach don't race with rescan.
3534 *
3535 * LOCKING:
3536 * Kernel thread context (may sleep).
3537 */
3538 void ata_scsi_dev_rescan(struct work_struct *work)
3539 {
3540 struct ata_port *ap =
3541 container_of(work, struct ata_port, scsi_rescan_task);
3542 struct ata_link *link;
3543 struct ata_device *dev;
3544 unsigned long flags;
3545
3546 spin_lock_irqsave(ap->lock, flags);
3547
3548 ata_port_for_each_link(link, ap) {
3549 ata_link_for_each_dev(dev, link) {
3550 struct scsi_device *sdev = dev->sdev;
3551
3552 if (!ata_dev_enabled(dev) || !sdev)
3553 continue;
3554 if (scsi_device_get(sdev))
3555 continue;
3556
3557 spin_unlock_irqrestore(ap->lock, flags);
3558 scsi_rescan_device(&(sdev->sdev_gendev));
3559 scsi_device_put(sdev);
3560 spin_lock_irqsave(ap->lock, flags);
3561 }
3562 }
3563
3564 spin_unlock_irqrestore(ap->lock, flags);
3565 }
3566
3567 /**
3568 * ata_sas_port_alloc - Allocate port for a SAS attached SATA device
3569 * @host: ATA host container for all SAS ports
3570 * @port_info: Information from low-level host driver
3571 * @shost: SCSI host that the scsi device is attached to
3572 *
3573 * LOCKING:
3574 * PCI/etc. bus probe sem.
3575 *
3576 * RETURNS:
3577 * ata_port pointer on success / NULL on failure.
3578 */
3579
3580 struct ata_port *ata_sas_port_alloc(struct ata_host *host,
3581 struct ata_port_info *port_info,
3582 struct Scsi_Host *shost)
3583 {
3584 struct ata_port *ap;
3585
3586 ap = ata_port_alloc(host);
3587 if (!ap)
3588 return NULL;
3589
3590 ap->port_no = 0;
3591 ap->lock = shost->host_lock;
3592 ap->pio_mask = port_info->pio_mask;
3593 ap->mwdma_mask = port_info->mwdma_mask;
3594 ap->udma_mask = port_info->udma_mask;
3595 ap->flags |= port_info->flags;
3596 ap->ops = port_info->port_ops;
3597 ap->cbl = ATA_CBL_SATA;
3598
3599 return ap;
3600 }
3601 EXPORT_SYMBOL_GPL(ata_sas_port_alloc);
3602
3603 /**
3604 * ata_sas_port_start - Set port up for dma.
3605 * @ap: Port to initialize
3606 *
3607 * Called just after data structures for each port are
3608 * initialized.
3609 *
3610 * May be used as the port_start() entry in ata_port_operations.
3611 *
3612 * LOCKING:
3613 * Inherited from caller.
3614 */
3615 int ata_sas_port_start(struct ata_port *ap)
3616 {
3617 return 0;
3618 }
3619 EXPORT_SYMBOL_GPL(ata_sas_port_start);
3620
3621 /**
3622 * ata_port_stop - Undo ata_sas_port_start()
3623 * @ap: Port to shut down
3624 *
3625 * May be used as the port_stop() entry in ata_port_operations.
3626 *
3627 * LOCKING:
3628 * Inherited from caller.
3629 */
3630
3631 void ata_sas_port_stop(struct ata_port *ap)
3632 {
3633 }
3634 EXPORT_SYMBOL_GPL(ata_sas_port_stop);
3635
3636 /**
3637 * ata_sas_port_init - Initialize a SATA device
3638 * @ap: SATA port to initialize
3639 *
3640 * LOCKING:
3641 * PCI/etc. bus probe sem.
3642 *
3643 * RETURNS:
3644 * Zero on success, non-zero on error.
3645 */
3646
3647 int ata_sas_port_init(struct ata_port *ap)
3648 {
3649 int rc = ap->ops->port_start(ap);
3650
3651 if (!rc) {
3652 ap->print_id = ata_print_id++;
3653 rc = ata_bus_probe(ap);
3654 }
3655
3656 return rc;
3657 }
3658 EXPORT_SYMBOL_GPL(ata_sas_port_init);
3659
3660 /**
3661 * ata_sas_port_destroy - Destroy a SATA port allocated by ata_sas_port_alloc
3662 * @ap: SATA port to destroy
3663 *
3664 */
3665
3666 void ata_sas_port_destroy(struct ata_port *ap)
3667 {
3668 if (ap->ops->port_stop)
3669 ap->ops->port_stop(ap);
3670 kfree(ap);
3671 }
3672 EXPORT_SYMBOL_GPL(ata_sas_port_destroy);
3673
3674 /**
3675 * ata_sas_slave_configure - Default slave_config routine for libata devices
3676 * @sdev: SCSI device to configure
3677 * @ap: ATA port to which SCSI device is attached
3678 *
3679 * RETURNS:
3680 * Zero.
3681 */
3682
3683 int ata_sas_slave_configure(struct scsi_device *sdev, struct ata_port *ap)
3684 {
3685 ata_scsi_sdev_config(sdev);
3686 ata_scsi_dev_config(sdev, ap->link.device);
3687 return 0;
3688 }
3689 EXPORT_SYMBOL_GPL(ata_sas_slave_configure);
3690
3691 /**
3692 * ata_sas_queuecmd - Issue SCSI cdb to libata-managed device
3693 * @cmd: SCSI command to be sent
3694 * @done: Completion function, called when command is complete
3695 * @ap: ATA port to which the command is being sent
3696 *
3697 * RETURNS:
3698 * Return value from __ata_scsi_queuecmd() if @cmd can be queued,
3699 * 0 otherwise.
3700 */
3701
3702 int ata_sas_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *),
3703 struct ata_port *ap)
3704 {
3705 int rc = 0;
3706
3707 ata_scsi_dump_cdb(ap, cmd);
3708
3709 if (likely(ata_scsi_dev_enabled(ap->link.device)))
3710 rc = __ata_scsi_queuecmd(cmd, done, ap->link.device);
3711 else {
3712 cmd->result = (DID_BAD_TARGET << 16);
3713 done(cmd);
3714 }
3715 return rc;
3716 }
3717 EXPORT_SYMBOL_GPL(ata_sas_queuecmd);