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