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