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