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