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