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