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