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