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