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