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