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