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