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