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