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