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