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