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