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