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