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