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