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