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