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