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