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