Merge branch 'irq-urgent-for-linus' of git://git.kernel.org/pub/scm/linux/kernel...
[cascardo/linux.git] / drivers / ata / libata-scsi.c
1 /*
2  *  libata-scsi.c - helper library for ATA
3  *
4  *  Maintained by:  Tejun Heo <tj@kernel.org>
5  *                  Please ALWAYS copy linux-ide@vger.kernel.org
6  *                  on emails.
7  *
8  *  Copyright 2003-2004 Red Hat, Inc.  All rights reserved.
9  *  Copyright 2003-2004 Jeff Garzik
10  *
11  *
12  *  This program is free software; you can redistribute it and/or modify
13  *  it under the terms of the GNU General Public License as published by
14  *  the Free Software Foundation; either version 2, or (at your option)
15  *  any later version.
16  *
17  *  This program is distributed in the hope that it will be useful,
18  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
19  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
20  *  GNU General Public License for more details.
21  *
22  *  You should have received a copy of the GNU General Public License
23  *  along with this program; see the file COPYING.  If not, write to
24  *  the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
25  *
26  *
27  *  libata documentation is available via 'make {ps|pdf}docs',
28  *  as Documentation/DocBook/libata.*
29  *
30  *  Hardware documentation available from
31  *  - http://www.t10.org/
32  *  - http://www.t13.org/
33  *
34  */
35
36 #include <linux/slab.h>
37 #include <linux/kernel.h>
38 #include <linux/blkdev.h>
39 #include <linux/spinlock.h>
40 #include <linux/export.h>
41 #include <scsi/scsi.h>
42 #include <scsi/scsi_host.h>
43 #include <scsi/scsi_cmnd.h>
44 #include <scsi/scsi_eh.h>
45 #include <scsi/scsi_device.h>
46 #include <scsi/scsi_tcq.h>
47 #include <scsi/scsi_transport.h>
48 #include <linux/libata.h>
49 #include <linux/hdreg.h>
50 #include <linux/uaccess.h>
51 #include <linux/suspend.h>
52 #include <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 now;
178         unsigned int uninitialized_var(msecs);
179         int rc = 0;
180
181         ap = ata_shost_to_port(sdev->host);
182
183         spin_lock_irq(ap->lock);
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 = kstrtol(buf, 10, &input);
221         if (rc)
222                 return rc;
223         if (input < -2)
224                 return -EINVAL;
225         if (input > ATA_TMOUT_MAX_PARK) {
226                 rc = -EOVERFLOW;
227                 input = ATA_TMOUT_MAX_PARK;
228         }
229
230         ap = ata_shost_to_port(sdev->host);
231
232         spin_lock_irqsave(ap->lock, flags);
233         dev = ata_scsi_find_dev(ap, sdev);
234         if (unlikely(!dev)) {
235                 rc = -ENODEV;
236                 goto unlock;
237         }
238         if (dev->class != ATA_DEV_ATA &&
239             dev->class != ATA_DEV_ZAC) {
240                 rc = -EOPNOTSUPP;
241                 goto unlock;
242         }
243
244         if (input >= 0) {
245                 if (dev->flags & ATA_DFLAG_NO_UNLOAD) {
246                         rc = -EOPNOTSUPP;
247                         goto unlock;
248                 }
249
250                 dev->unpark_deadline = ata_deadline(jiffies, input);
251                 dev->link->eh_info.dev_action[dev->devno] |= ATA_EH_PARK;
252                 ata_port_schedule_eh(ap);
253                 complete(&ap->park_req_pending);
254         } else {
255                 switch (input) {
256                 case -1:
257                         dev->flags &= ~ATA_DFLAG_NO_UNLOAD;
258                         break;
259                 case -2:
260                         dev->flags |= ATA_DFLAG_NO_UNLOAD;
261                         break;
262                 }
263         }
264 unlock:
265         spin_unlock_irqrestore(ap->lock, flags);
266
267         return rc ? rc : len;
268 }
269 DEVICE_ATTR(unload_heads, S_IRUGO | S_IWUSR,
270             ata_scsi_park_show, ata_scsi_park_store);
271 EXPORT_SYMBOL_GPL(dev_attr_unload_heads);
272
273 void ata_scsi_set_sense(struct ata_device *dev, struct scsi_cmnd *cmd,
274                         u8 sk, u8 asc, u8 ascq)
275 {
276         bool d_sense = (dev->flags & ATA_DFLAG_D_SENSE);
277
278         if (!cmd)
279                 return;
280
281         cmd->result = (DRIVER_SENSE << 24) | SAM_STAT_CHECK_CONDITION;
282
283         scsi_build_sense_buffer(d_sense, cmd->sense_buffer, sk, asc, ascq);
284 }
285
286 void ata_scsi_set_sense_information(struct ata_device *dev,
287                                     struct scsi_cmnd *cmd,
288                                     const struct ata_taskfile *tf)
289 {
290         u64 information;
291
292         if (!cmd)
293                 return;
294
295         information = ata_tf_read_block(tf, dev);
296         if (information == U64_MAX)
297                 return;
298
299         scsi_set_sense_information(cmd->sense_buffer,
300                                    SCSI_SENSE_BUFFERSIZE, information);
301 }
302
303 static void ata_scsi_set_invalid_field(struct ata_device *dev,
304                                        struct scsi_cmnd *cmd, u16 field, u8 bit)
305 {
306         ata_scsi_set_sense(dev, cmd, ILLEGAL_REQUEST, 0x24, 0x0);
307         /* "Invalid field in CDB" */
308         scsi_set_sense_field_pointer(cmd->sense_buffer, SCSI_SENSE_BUFFERSIZE,
309                                      field, bit, 1);
310 }
311
312 static void ata_scsi_set_invalid_parameter(struct ata_device *dev,
313                                            struct scsi_cmnd *cmd, u16 field)
314 {
315         /* "Invalid field in parameter list" */
316         ata_scsi_set_sense(dev, cmd, ILLEGAL_REQUEST, 0x26, 0x0);
317         scsi_set_sense_field_pointer(cmd->sense_buffer, SCSI_SENSE_BUFFERSIZE,
318                                      field, 0xff, 0);
319 }
320
321 static ssize_t
322 ata_scsi_em_message_store(struct device *dev, struct device_attribute *attr,
323                           const char *buf, size_t count)
324 {
325         struct Scsi_Host *shost = class_to_shost(dev);
326         struct ata_port *ap = ata_shost_to_port(shost);
327         if (ap->ops->em_store && (ap->flags & ATA_FLAG_EM))
328                 return ap->ops->em_store(ap, buf, count);
329         return -EINVAL;
330 }
331
332 static ssize_t
333 ata_scsi_em_message_show(struct device *dev, struct device_attribute *attr,
334                          char *buf)
335 {
336         struct Scsi_Host *shost = class_to_shost(dev);
337         struct ata_port *ap = ata_shost_to_port(shost);
338
339         if (ap->ops->em_show && (ap->flags & ATA_FLAG_EM))
340                 return ap->ops->em_show(ap, buf);
341         return -EINVAL;
342 }
343 DEVICE_ATTR(em_message, S_IRUGO | S_IWUSR,
344                 ata_scsi_em_message_show, ata_scsi_em_message_store);
345 EXPORT_SYMBOL_GPL(dev_attr_em_message);
346
347 static ssize_t
348 ata_scsi_em_message_type_show(struct device *dev, struct device_attribute *attr,
349                               char *buf)
350 {
351         struct Scsi_Host *shost = class_to_shost(dev);
352         struct ata_port *ap = ata_shost_to_port(shost);
353
354         return snprintf(buf, 23, "%d\n", ap->em_message_type);
355 }
356 DEVICE_ATTR(em_message_type, S_IRUGO,
357                   ata_scsi_em_message_type_show, NULL);
358 EXPORT_SYMBOL_GPL(dev_attr_em_message_type);
359
360 static ssize_t
361 ata_scsi_activity_show(struct device *dev, struct device_attribute *attr,
362                 char *buf)
363 {
364         struct scsi_device *sdev = to_scsi_device(dev);
365         struct ata_port *ap = ata_shost_to_port(sdev->host);
366         struct ata_device *atadev = ata_scsi_find_dev(ap, sdev);
367
368         if (atadev && ap->ops->sw_activity_show &&
369             (ap->flags & ATA_FLAG_SW_ACTIVITY))
370                 return ap->ops->sw_activity_show(atadev, buf);
371         return -EINVAL;
372 }
373
374 static ssize_t
375 ata_scsi_activity_store(struct device *dev, struct device_attribute *attr,
376         const char *buf, size_t count)
377 {
378         struct scsi_device *sdev = to_scsi_device(dev);
379         struct ata_port *ap = ata_shost_to_port(sdev->host);
380         struct ata_device *atadev = ata_scsi_find_dev(ap, sdev);
381         enum sw_activity val;
382         int rc;
383
384         if (atadev && ap->ops->sw_activity_store &&
385             (ap->flags & ATA_FLAG_SW_ACTIVITY)) {
386                 val = simple_strtoul(buf, NULL, 0);
387                 switch (val) {
388                 case OFF: case BLINK_ON: case BLINK_OFF:
389                         rc = ap->ops->sw_activity_store(atadev, val);
390                         if (!rc)
391                                 return count;
392                         else
393                                 return rc;
394                 }
395         }
396         return -EINVAL;
397 }
398 DEVICE_ATTR(sw_activity, S_IWUSR | S_IRUGO, ata_scsi_activity_show,
399                         ata_scsi_activity_store);
400 EXPORT_SYMBOL_GPL(dev_attr_sw_activity);
401
402 struct device_attribute *ata_common_sdev_attrs[] = {
403         &dev_attr_unload_heads,
404         NULL
405 };
406 EXPORT_SYMBOL_GPL(ata_common_sdev_attrs);
407
408 static void ata_scsi_invalid_field(struct ata_device *dev,
409                                    struct scsi_cmnd *cmd, u16 field)
410 {
411         ata_scsi_set_invalid_field(dev, cmd, field, 0xff);
412         cmd->scsi_done(cmd);
413 }
414
415 /**
416  *      ata_std_bios_param - generic bios head/sector/cylinder calculator used by sd.
417  *      @sdev: SCSI device for which BIOS geometry is to be determined
418  *      @bdev: block device associated with @sdev
419  *      @capacity: capacity of SCSI device
420  *      @geom: location to which geometry will be output
421  *
422  *      Generic bios head/sector/cylinder calculator
423  *      used by sd. Most BIOSes nowadays expect a XXX/255/16  (CHS)
424  *      mapping. Some situations may arise where the disk is not
425  *      bootable if this is not used.
426  *
427  *      LOCKING:
428  *      Defined by the SCSI layer.  We don't really care.
429  *
430  *      RETURNS:
431  *      Zero.
432  */
433 int ata_std_bios_param(struct scsi_device *sdev, struct block_device *bdev,
434                        sector_t capacity, int geom[])
435 {
436         geom[0] = 255;
437         geom[1] = 63;
438         sector_div(capacity, 255*63);
439         geom[2] = capacity;
440
441         return 0;
442 }
443
444 /**
445  *      ata_scsi_unlock_native_capacity - unlock native capacity
446  *      @sdev: SCSI device to adjust device capacity for
447  *
448  *      This function is called if a partition on @sdev extends beyond
449  *      the end of the device.  It requests EH to unlock HPA.
450  *
451  *      LOCKING:
452  *      Defined by the SCSI layer.  Might sleep.
453  */
454 void ata_scsi_unlock_native_capacity(struct scsi_device *sdev)
455 {
456         struct ata_port *ap = ata_shost_to_port(sdev->host);
457         struct ata_device *dev;
458         unsigned long flags;
459
460         spin_lock_irqsave(ap->lock, flags);
461
462         dev = ata_scsi_find_dev(ap, sdev);
463         if (dev && dev->n_sectors < dev->n_native_sectors) {
464                 dev->flags |= ATA_DFLAG_UNLOCK_HPA;
465                 dev->link->eh_info.action |= ATA_EH_RESET;
466                 ata_port_schedule_eh(ap);
467         }
468
469         spin_unlock_irqrestore(ap->lock, flags);
470         ata_port_wait_eh(ap);
471 }
472
473 /**
474  *      ata_get_identity - Handler for HDIO_GET_IDENTITY ioctl
475  *      @ap: target port
476  *      @sdev: SCSI device to get identify data for
477  *      @arg: User buffer area for identify data
478  *
479  *      LOCKING:
480  *      Defined by the SCSI layer.  We don't really care.
481  *
482  *      RETURNS:
483  *      Zero on success, negative errno on error.
484  */
485 static int ata_get_identity(struct ata_port *ap, struct scsi_device *sdev,
486                             void __user *arg)
487 {
488         struct ata_device *dev = ata_scsi_find_dev(ap, sdev);
489         u16 __user *dst = arg;
490         char buf[40];
491
492         if (!dev)
493                 return -ENOMSG;
494
495         if (copy_to_user(dst, dev->id, ATA_ID_WORDS * sizeof(u16)))
496                 return -EFAULT;
497
498         ata_id_string(dev->id, buf, ATA_ID_PROD, ATA_ID_PROD_LEN);
499         if (copy_to_user(dst + ATA_ID_PROD, buf, ATA_ID_PROD_LEN))
500                 return -EFAULT;
501
502         ata_id_string(dev->id, buf, ATA_ID_FW_REV, ATA_ID_FW_REV_LEN);
503         if (copy_to_user(dst + ATA_ID_FW_REV, buf, ATA_ID_FW_REV_LEN))
504                 return -EFAULT;
505
506         ata_id_string(dev->id, buf, ATA_ID_SERNO, ATA_ID_SERNO_LEN);
507         if (copy_to_user(dst + ATA_ID_SERNO, buf, ATA_ID_SERNO_LEN))
508                 return -EFAULT;
509
510         return 0;
511 }
512
513 /**
514  *      ata_cmd_ioctl - Handler for HDIO_DRIVE_CMD ioctl
515  *      @scsidev: Device to which we are issuing command
516  *      @arg: User provided data for issuing command
517  *
518  *      LOCKING:
519  *      Defined by the SCSI layer.  We don't really care.
520  *
521  *      RETURNS:
522  *      Zero on success, negative errno on error.
523  */
524 int ata_cmd_ioctl(struct scsi_device *scsidev, void __user *arg)
525 {
526         int rc = 0;
527         u8 scsi_cmd[MAX_COMMAND_SIZE];
528         u8 args[4], *argbuf = NULL, *sensebuf = NULL;
529         int argsize = 0;
530         enum dma_data_direction data_dir;
531         int cmd_result;
532
533         if (arg == NULL)
534                 return -EINVAL;
535
536         if (copy_from_user(args, arg, sizeof(args)))
537                 return -EFAULT;
538
539         sensebuf = kzalloc(SCSI_SENSE_BUFFERSIZE, GFP_NOIO);
540         if (!sensebuf)
541                 return -ENOMEM;
542
543         memset(scsi_cmd, 0, sizeof(scsi_cmd));
544
545         if (args[3]) {
546                 argsize = ATA_SECT_SIZE * args[3];
547                 argbuf = kmalloc(argsize, GFP_KERNEL);
548                 if (argbuf == NULL) {
549                         rc = -ENOMEM;
550                         goto error;
551                 }
552
553                 scsi_cmd[1]  = (4 << 1); /* PIO Data-in */
554                 scsi_cmd[2]  = 0x0e;     /* no off.line or cc, read from dev,
555                                             block count in sector count field */
556                 data_dir = DMA_FROM_DEVICE;
557         } else {
558                 scsi_cmd[1]  = (3 << 1); /* Non-data */
559                 scsi_cmd[2]  = 0x20;     /* cc but no off.line or data xfer */
560                 data_dir = DMA_NONE;
561         }
562
563         scsi_cmd[0] = ATA_16;
564
565         scsi_cmd[4] = args[2];
566         if (args[0] == ATA_CMD_SMART) { /* hack -- ide driver does this too */
567                 scsi_cmd[6]  = args[3];
568                 scsi_cmd[8]  = args[1];
569                 scsi_cmd[10] = 0x4f;
570                 scsi_cmd[12] = 0xc2;
571         } else {
572                 scsi_cmd[6]  = args[1];
573         }
574         scsi_cmd[14] = args[0];
575
576         /* Good values for timeout and retries?  Values below
577            from scsi_ioctl_send_command() for default case... */
578         cmd_result = scsi_execute(scsidev, scsi_cmd, data_dir, argbuf, argsize,
579                                   sensebuf, (10*HZ), 5, 0, NULL);
580
581         if (driver_byte(cmd_result) == DRIVER_SENSE) {/* sense data available */
582                 u8 *desc = sensebuf + 8;
583                 cmd_result &= ~(0xFF<<24); /* DRIVER_SENSE is not an error */
584
585                 /* If we set cc then ATA pass-through will cause a
586                  * check condition even if no error. Filter that. */
587                 if (cmd_result & SAM_STAT_CHECK_CONDITION) {
588                         struct scsi_sense_hdr sshdr;
589                         scsi_normalize_sense(sensebuf, SCSI_SENSE_BUFFERSIZE,
590                                              &sshdr);
591                         if (sshdr.sense_key == RECOVERED_ERROR &&
592                             sshdr.asc == 0 && sshdr.ascq == 0x1d)
593                                 cmd_result &= ~SAM_STAT_CHECK_CONDITION;
594                 }
595
596                 /* Send userspace a few ATA registers (same as drivers/ide) */
597                 if (sensebuf[0] == 0x72 &&      /* format is "descriptor" */
598                     desc[0] == 0x09) {          /* code is "ATA Descriptor" */
599                         args[0] = desc[13];     /* status */
600                         args[1] = desc[3];      /* error */
601                         args[2] = desc[5];      /* sector count (0:7) */
602                         if (copy_to_user(arg, args, sizeof(args)))
603                                 rc = -EFAULT;
604                 }
605         }
606
607
608         if (cmd_result) {
609                 rc = -EIO;
610                 goto error;
611         }
612
613         if ((argbuf)
614          && copy_to_user(arg + sizeof(args), argbuf, argsize))
615                 rc = -EFAULT;
616 error:
617         kfree(sensebuf);
618         kfree(argbuf);
619         return rc;
620 }
621
622 /**
623  *      ata_task_ioctl - Handler for HDIO_DRIVE_TASK ioctl
624  *      @scsidev: Device to which we are issuing command
625  *      @arg: User provided data for issuing command
626  *
627  *      LOCKING:
628  *      Defined by the SCSI layer.  We don't really care.
629  *
630  *      RETURNS:
631  *      Zero on success, negative errno on error.
632  */
633 int ata_task_ioctl(struct scsi_device *scsidev, void __user *arg)
634 {
635         int rc = 0;
636         u8 scsi_cmd[MAX_COMMAND_SIZE];
637         u8 args[7], *sensebuf = NULL;
638         int cmd_result;
639
640         if (arg == NULL)
641                 return -EINVAL;
642
643         if (copy_from_user(args, arg, sizeof(args)))
644                 return -EFAULT;
645
646         sensebuf = kzalloc(SCSI_SENSE_BUFFERSIZE, GFP_NOIO);
647         if (!sensebuf)
648                 return -ENOMEM;
649
650         memset(scsi_cmd, 0, sizeof(scsi_cmd));
651         scsi_cmd[0]  = ATA_16;
652         scsi_cmd[1]  = (3 << 1); /* Non-data */
653         scsi_cmd[2]  = 0x20;     /* cc but no off.line or data xfer */
654         scsi_cmd[4]  = args[1];
655         scsi_cmd[6]  = args[2];
656         scsi_cmd[8]  = args[3];
657         scsi_cmd[10] = args[4];
658         scsi_cmd[12] = args[5];
659         scsi_cmd[13] = args[6] & 0x4f;
660         scsi_cmd[14] = args[0];
661
662         /* Good values for timeout and retries?  Values below
663            from scsi_ioctl_send_command() for default case... */
664         cmd_result = scsi_execute(scsidev, scsi_cmd, DMA_NONE, NULL, 0,
665                                 sensebuf, (10*HZ), 5, 0, NULL);
666
667         if (driver_byte(cmd_result) == DRIVER_SENSE) {/* sense data available */
668                 u8 *desc = sensebuf + 8;
669                 cmd_result &= ~(0xFF<<24); /* DRIVER_SENSE is not an error */
670
671                 /* If we set cc then ATA pass-through will cause a
672                  * check condition even if no error. Filter that. */
673                 if (cmd_result & SAM_STAT_CHECK_CONDITION) {
674                         struct scsi_sense_hdr sshdr;
675                         scsi_normalize_sense(sensebuf, SCSI_SENSE_BUFFERSIZE,
676                                                 &sshdr);
677                         if (sshdr.sense_key == RECOVERED_ERROR &&
678                             sshdr.asc == 0 && sshdr.ascq == 0x1d)
679                                 cmd_result &= ~SAM_STAT_CHECK_CONDITION;
680                 }
681
682                 /* Send userspace ATA registers */
683                 if (sensebuf[0] == 0x72 &&      /* format is "descriptor" */
684                                 desc[0] == 0x09) {/* code is "ATA Descriptor" */
685                         args[0] = desc[13];     /* status */
686                         args[1] = desc[3];      /* error */
687                         args[2] = desc[5];      /* sector count (0:7) */
688                         args[3] = desc[7];      /* lbal */
689                         args[4] = desc[9];      /* lbam */
690                         args[5] = desc[11];     /* lbah */
691                         args[6] = desc[12];     /* select */
692                         if (copy_to_user(arg, args, sizeof(args)))
693                                 rc = -EFAULT;
694                 }
695         }
696
697         if (cmd_result) {
698                 rc = -EIO;
699                 goto error;
700         }
701
702  error:
703         kfree(sensebuf);
704         return rc;
705 }
706
707 static int ata_ioc32(struct ata_port *ap)
708 {
709         if (ap->flags & ATA_FLAG_PIO_DMA)
710                 return 1;
711         if (ap->pflags & ATA_PFLAG_PIO32)
712                 return 1;
713         return 0;
714 }
715
716 int ata_sas_scsi_ioctl(struct ata_port *ap, struct scsi_device *scsidev,
717                      int cmd, void __user *arg)
718 {
719         unsigned long val;
720         int rc = -EINVAL;
721         unsigned long flags;
722
723         switch (cmd) {
724         case HDIO_GET_32BIT:
725                 spin_lock_irqsave(ap->lock, flags);
726                 val = ata_ioc32(ap);
727                 spin_unlock_irqrestore(ap->lock, flags);
728                 return put_user(val, (unsigned long __user *)arg);
729
730         case HDIO_SET_32BIT:
731                 val = (unsigned long) arg;
732                 rc = 0;
733                 spin_lock_irqsave(ap->lock, flags);
734                 if (ap->pflags & ATA_PFLAG_PIO32CHANGE) {
735                         if (val)
736                                 ap->pflags |= ATA_PFLAG_PIO32;
737                         else
738                                 ap->pflags &= ~ATA_PFLAG_PIO32;
739                 } else {
740                         if (val != ata_ioc32(ap))
741                                 rc = -EINVAL;
742                 }
743                 spin_unlock_irqrestore(ap->lock, flags);
744                 return rc;
745
746         case HDIO_GET_IDENTITY:
747                 return ata_get_identity(ap, scsidev, arg);
748
749         case HDIO_DRIVE_CMD:
750                 if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
751                         return -EACCES;
752                 return ata_cmd_ioctl(scsidev, arg);
753
754         case HDIO_DRIVE_TASK:
755                 if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
756                         return -EACCES;
757                 return ata_task_ioctl(scsidev, arg);
758
759         default:
760                 rc = -ENOTTY;
761                 break;
762         }
763
764         return rc;
765 }
766 EXPORT_SYMBOL_GPL(ata_sas_scsi_ioctl);
767
768 int ata_scsi_ioctl(struct scsi_device *scsidev, int cmd, void __user *arg)
769 {
770         return ata_sas_scsi_ioctl(ata_shost_to_port(scsidev->host),
771                                 scsidev, cmd, arg);
772 }
773 EXPORT_SYMBOL_GPL(ata_scsi_ioctl);
774
775 /**
776  *      ata_scsi_qc_new - acquire new ata_queued_cmd reference
777  *      @dev: ATA device to which the new command is attached
778  *      @cmd: SCSI command that originated this ATA command
779  *
780  *      Obtain a reference to an unused ata_queued_cmd structure,
781  *      which is the basic libata structure representing a single
782  *      ATA command sent to the hardware.
783  *
784  *      If a command was available, fill in the SCSI-specific
785  *      portions of the structure with information on the
786  *      current command.
787  *
788  *      LOCKING:
789  *      spin_lock_irqsave(host lock)
790  *
791  *      RETURNS:
792  *      Command allocated, or %NULL if none available.
793  */
794 static struct ata_queued_cmd *ata_scsi_qc_new(struct ata_device *dev,
795                                               struct scsi_cmnd *cmd)
796 {
797         struct ata_queued_cmd *qc;
798
799         qc = ata_qc_new_init(dev, cmd->request->tag);
800         if (qc) {
801                 qc->scsicmd = cmd;
802                 qc->scsidone = cmd->scsi_done;
803
804                 qc->sg = scsi_sglist(cmd);
805                 qc->n_elem = scsi_sg_count(cmd);
806         } else {
807                 cmd->result = (DID_OK << 16) | (QUEUE_FULL << 1);
808                 cmd->scsi_done(cmd);
809         }
810
811         return qc;
812 }
813
814 static void ata_qc_set_pc_nbytes(struct ata_queued_cmd *qc)
815 {
816         struct scsi_cmnd *scmd = qc->scsicmd;
817
818         qc->extrabytes = scmd->request->extra_len;
819         qc->nbytes = scsi_bufflen(scmd) + qc->extrabytes;
820 }
821
822 /**
823  *      ata_dump_status - user friendly display of error info
824  *      @id: id of the port in question
825  *      @tf: ptr to filled out taskfile
826  *
827  *      Decode and dump the ATA error/status registers for the user so
828  *      that they have some idea what really happened at the non
829  *      make-believe layer.
830  *
831  *      LOCKING:
832  *      inherited from caller
833  */
834 static void ata_dump_status(unsigned id, struct ata_taskfile *tf)
835 {
836         u8 stat = tf->command, err = tf->feature;
837
838         printk(KERN_WARNING "ata%u: status=0x%02x { ", id, stat);
839         if (stat & ATA_BUSY) {
840                 printk("Busy }\n");     /* Data is not valid in this case */
841         } else {
842                 if (stat & ATA_DRDY)    printk("DriveReady ");
843                 if (stat & ATA_DF)      printk("DeviceFault ");
844                 if (stat & ATA_DSC)     printk("SeekComplete ");
845                 if (stat & ATA_DRQ)     printk("DataRequest ");
846                 if (stat & ATA_CORR)    printk("CorrectedError ");
847                 if (stat & ATA_SENSE)   printk("Sense ");
848                 if (stat & ATA_ERR)     printk("Error ");
849                 printk("}\n");
850
851                 if (err) {
852                         printk(KERN_WARNING "ata%u: error=0x%02x { ", id, err);
853                         if (err & ATA_ABORTED)  printk("DriveStatusError ");
854                         if (err & ATA_ICRC) {
855                                 if (err & ATA_ABORTED)
856                                                 printk("BadCRC ");
857                                 else            printk("Sector ");
858                         }
859                         if (err & ATA_UNC)      printk("UncorrectableError ");
860                         if (err & ATA_IDNF)     printk("SectorIdNotFound ");
861                         if (err & ATA_TRK0NF)   printk("TrackZeroNotFound ");
862                         if (err & ATA_AMNF)     printk("AddrMarkNotFound ");
863                         printk("}\n");
864                 }
865         }
866 }
867
868 /**
869  *      ata_to_sense_error - convert ATA error to SCSI error
870  *      @id: ATA device number
871  *      @drv_stat: value contained in ATA status register
872  *      @drv_err: value contained in ATA error register
873  *      @sk: the sense key we'll fill out
874  *      @asc: the additional sense code we'll fill out
875  *      @ascq: the additional sense code qualifier we'll fill out
876  *      @verbose: be verbose
877  *
878  *      Converts an ATA error into a SCSI error.  Fill out pointers to
879  *      SK, ASC, and ASCQ bytes for later use in fixed or descriptor
880  *      format sense blocks.
881  *
882  *      LOCKING:
883  *      spin_lock_irqsave(host lock)
884  */
885 static void ata_to_sense_error(unsigned id, u8 drv_stat, u8 drv_err, u8 *sk,
886                                u8 *asc, u8 *ascq, int verbose)
887 {
888         int i;
889
890         /* Based on the 3ware driver translation table */
891         static const unsigned char sense_table[][4] = {
892                 /* BBD|ECC|ID|MAR */
893                 {0xd1,          ABORTED_COMMAND, 0x00, 0x00},
894                         // Device busy                  Aborted command
895                 /* BBD|ECC|ID */
896                 {0xd0,          ABORTED_COMMAND, 0x00, 0x00},
897                         // Device busy                  Aborted command
898                 /* ECC|MC|MARK */
899                 {0x61,          HARDWARE_ERROR, 0x00, 0x00},
900                         // Device fault                 Hardware error
901                 /* ICRC|ABRT */         /* NB: ICRC & !ABRT is BBD */
902                 {0x84,          ABORTED_COMMAND, 0x47, 0x00},
903                         // Data CRC error               SCSI parity error
904                 /* MC|ID|ABRT|TRK0|MARK */
905                 {0x37,          NOT_READY, 0x04, 0x00},
906                         // Unit offline                 Not ready
907                 /* MCR|MARK */
908                 {0x09,          NOT_READY, 0x04, 0x00},
909                         // Unrecovered disk error       Not ready
910                 /*  Bad address mark */
911                 {0x01,          MEDIUM_ERROR, 0x13, 0x00},
912                         // Address mark not found for data field
913                 /* TRK0 - Track 0 not found */
914                 {0x02,          HARDWARE_ERROR, 0x00, 0x00},
915                         // Hardware error
916                 /* Abort: 0x04 is not translated here, see below */
917                 /* Media change request */
918                 {0x08,          NOT_READY, 0x04, 0x00},
919                         // FIXME: faking offline
920                 /* SRV/IDNF - ID not found */
921                 {0x10,          ILLEGAL_REQUEST, 0x21, 0x00},
922                         // Logical address out of range
923                 /* MC - Media Changed */
924                 {0x20,          UNIT_ATTENTION, 0x28, 0x00},
925                         // Not ready to ready change, medium may have changed
926                 /* ECC - Uncorrectable ECC error */
927                 {0x40,          MEDIUM_ERROR, 0x11, 0x04},
928                         // Unrecovered read error
929                 /* BBD - block marked bad */
930                 {0x80,          MEDIUM_ERROR, 0x11, 0x04},
931                         // Block marked bad     Medium error, unrecovered read error
932                 {0xFF, 0xFF, 0xFF, 0xFF}, // END mark
933         };
934         static const unsigned char stat_table[][4] = {
935                 /* Must be first because BUSY means no other bits valid */
936                 {0x80,          ABORTED_COMMAND, 0x47, 0x00},
937                 // Busy, fake parity for now
938                 {0x40,          ILLEGAL_REQUEST, 0x21, 0x04},
939                 // Device ready, unaligned write command
940                 {0x20,          HARDWARE_ERROR,  0x44, 0x00},
941                 // Device fault, internal target failure
942                 {0x08,          ABORTED_COMMAND, 0x47, 0x00},
943                 // Timed out in xfer, fake parity for now
944                 {0x04,          RECOVERED_ERROR, 0x11, 0x00},
945                 // Recovered ECC error    Medium error, recovered
946                 {0xFF, 0xFF, 0xFF, 0xFF}, // END mark
947         };
948
949         /*
950          *      Is this an error we can process/parse
951          */
952         if (drv_stat & ATA_BUSY) {
953                 drv_err = 0;    /* Ignore the err bits, they're invalid */
954         }
955
956         if (drv_err) {
957                 /* Look for drv_err */
958                 for (i = 0; sense_table[i][0] != 0xFF; i++) {
959                         /* Look for best matches first */
960                         if ((sense_table[i][0] & drv_err) ==
961                             sense_table[i][0]) {
962                                 *sk = sense_table[i][1];
963                                 *asc = sense_table[i][2];
964                                 *ascq = sense_table[i][3];
965                                 goto translate_done;
966                         }
967                 }
968         }
969
970         /*
971          * Fall back to interpreting status bits.  Note that if the drv_err
972          * has only the ABRT bit set, we decode drv_stat.  ABRT by itself
973          * is not descriptive enough.
974          */
975         for (i = 0; stat_table[i][0] != 0xFF; i++) {
976                 if (stat_table[i][0] & drv_stat) {
977                         *sk = stat_table[i][1];
978                         *asc = stat_table[i][2];
979                         *ascq = stat_table[i][3];
980                         goto translate_done;
981                 }
982         }
983
984         /*
985          * We need a sensible error return here, which is tricky, and one
986          * that won't cause people to do things like return a disk wrongly.
987          */
988         *sk = ABORTED_COMMAND;
989         *asc = 0x00;
990         *ascq = 0x00;
991
992  translate_done:
993         if (verbose)
994                 printk(KERN_ERR "ata%u: translated ATA stat/err 0x%02x/%02x "
995                        "to SCSI SK/ASC/ASCQ 0x%x/%02x/%02x\n",
996                        id, drv_stat, drv_err, *sk, *asc, *ascq);
997         return;
998 }
999
1000 /*
1001  *      ata_gen_passthru_sense - Generate check condition sense block.
1002  *      @qc: Command that completed.
1003  *
1004  *      This function is specific to the ATA descriptor format sense
1005  *      block specified for the ATA pass through commands.  Regardless
1006  *      of whether the command errored or not, return a sense
1007  *      block. Copy all controller registers into the sense
1008  *      block. If there was no error, we get the request from an ATA
1009  *      passthrough command, so we use the following sense data:
1010  *      sk = RECOVERED ERROR
1011  *      asc,ascq = ATA PASS-THROUGH INFORMATION AVAILABLE
1012  *      
1013  *
1014  *      LOCKING:
1015  *      None.
1016  */
1017 static void ata_gen_passthru_sense(struct ata_queued_cmd *qc)
1018 {
1019         struct scsi_cmnd *cmd = qc->scsicmd;
1020         struct ata_taskfile *tf = &qc->result_tf;
1021         unsigned char *sb = cmd->sense_buffer;
1022         unsigned char *desc = sb + 8;
1023         int verbose = qc->ap->ops->error_handler == NULL;
1024         u8 sense_key, asc, ascq;
1025
1026         memset(sb, 0, SCSI_SENSE_BUFFERSIZE);
1027
1028         cmd->result = (DRIVER_SENSE << 24) | SAM_STAT_CHECK_CONDITION;
1029
1030         /*
1031          * Use ata_to_sense_error() to map status register bits
1032          * onto sense key, asc & ascq.
1033          */
1034         if (qc->err_mask ||
1035             tf->command & (ATA_BUSY | ATA_DF | ATA_ERR | ATA_DRQ)) {
1036                 ata_to_sense_error(qc->ap->print_id, tf->command, tf->feature,
1037                                    &sense_key, &asc, &ascq, verbose);
1038                 ata_scsi_set_sense(qc->dev, cmd, sense_key, asc, ascq);
1039         } else {
1040                 /*
1041                  * ATA PASS-THROUGH INFORMATION AVAILABLE
1042                  * Always in descriptor format sense.
1043                  */
1044                 scsi_build_sense_buffer(1, cmd->sense_buffer,
1045                                         RECOVERED_ERROR, 0, 0x1D);
1046         }
1047
1048         if ((cmd->sense_buffer[0] & 0x7f) >= 0x72) {
1049                 u8 len;
1050
1051                 /* descriptor format */
1052                 len = sb[7];
1053                 desc = (char *)scsi_sense_desc_find(sb, len + 8, 9);
1054                 if (!desc) {
1055                         if (SCSI_SENSE_BUFFERSIZE < len + 14)
1056                                 return;
1057                         sb[7] = len + 14;
1058                         desc = sb + 8 + len;
1059                 }
1060                 desc[0] = 9;
1061                 desc[1] = 12;
1062                 /*
1063                  * Copy registers into sense buffer.
1064                  */
1065                 desc[2] = 0x00;
1066                 desc[3] = tf->feature;  /* == error reg */
1067                 desc[5] = tf->nsect;
1068                 desc[7] = tf->lbal;
1069                 desc[9] = tf->lbam;
1070                 desc[11] = tf->lbah;
1071                 desc[12] = tf->device;
1072                 desc[13] = tf->command; /* == status reg */
1073
1074                 /*
1075                  * Fill in Extend bit, and the high order bytes
1076                  * if applicable.
1077                  */
1078                 if (tf->flags & ATA_TFLAG_LBA48) {
1079                         desc[2] |= 0x01;
1080                         desc[4] = tf->hob_nsect;
1081                         desc[6] = tf->hob_lbal;
1082                         desc[8] = tf->hob_lbam;
1083                         desc[10] = tf->hob_lbah;
1084                 }
1085         } else {
1086                 /* Fixed sense format */
1087                 desc[0] = tf->feature;
1088                 desc[1] = tf->command; /* status */
1089                 desc[2] = tf->device;
1090                 desc[3] = tf->nsect;
1091                 desc[0] = 0;
1092                 if (tf->flags & ATA_TFLAG_LBA48)  {
1093                         desc[8] |= 0x80;
1094                         if (tf->hob_nsect)
1095                                 desc[8] |= 0x40;
1096                         if (tf->hob_lbal || tf->hob_lbam || tf->hob_lbah)
1097                                 desc[8] |= 0x20;
1098                 }
1099                 desc[9] = tf->lbal;
1100                 desc[10] = tf->lbam;
1101                 desc[11] = tf->lbah;
1102         }
1103 }
1104
1105 /**
1106  *      ata_gen_ata_sense - generate a SCSI fixed sense block
1107  *      @qc: Command that we are erroring out
1108  *
1109  *      Generate sense block for a failed ATA command @qc.  Descriptor
1110  *      format is used to accommodate LBA48 block address.
1111  *
1112  *      LOCKING:
1113  *      None.
1114  */
1115 static void ata_gen_ata_sense(struct ata_queued_cmd *qc)
1116 {
1117         struct ata_device *dev = qc->dev;
1118         struct scsi_cmnd *cmd = qc->scsicmd;
1119         struct ata_taskfile *tf = &qc->result_tf;
1120         unsigned char *sb = cmd->sense_buffer;
1121         int verbose = qc->ap->ops->error_handler == NULL;
1122         u64 block;
1123         u8 sense_key, asc, ascq;
1124
1125         memset(sb, 0, SCSI_SENSE_BUFFERSIZE);
1126
1127         cmd->result = (DRIVER_SENSE << 24) | SAM_STAT_CHECK_CONDITION;
1128
1129         if (ata_dev_disabled(dev)) {
1130                 /* Device disabled after error recovery */
1131                 /* LOGICAL UNIT NOT READY, HARD RESET REQUIRED */
1132                 ata_scsi_set_sense(dev, cmd, NOT_READY, 0x04, 0x21);
1133                 return;
1134         }
1135         /* Use ata_to_sense_error() to map status register bits
1136          * onto sense key, asc & ascq.
1137          */
1138         if (qc->err_mask ||
1139             tf->command & (ATA_BUSY | ATA_DF | ATA_ERR | ATA_DRQ)) {
1140                 ata_to_sense_error(qc->ap->print_id, tf->command, tf->feature,
1141                                    &sense_key, &asc, &ascq, verbose);
1142                 ata_scsi_set_sense(dev, cmd, sense_key, asc, ascq);
1143         } else {
1144                 /* Could not decode error */
1145                 ata_dev_warn(dev, "could not decode error status 0x%x err_mask 0x%x\n",
1146                              tf->command, qc->err_mask);
1147                 ata_scsi_set_sense(dev, cmd, ABORTED_COMMAND, 0, 0);
1148                 return;
1149         }
1150
1151         block = ata_tf_read_block(&qc->result_tf, dev);
1152         if (block == U64_MAX)
1153                 return;
1154
1155         scsi_set_sense_information(sb, SCSI_SENSE_BUFFERSIZE, block);
1156 }
1157
1158 static void ata_scsi_sdev_config(struct scsi_device *sdev)
1159 {
1160         sdev->use_10_for_rw = 1;
1161         sdev->use_10_for_ms = 1;
1162
1163         /* Schedule policy is determined by ->qc_defer() callback and
1164          * it needs to see every deferred qc.  Set dev_blocked to 1 to
1165          * prevent SCSI midlayer from automatically deferring
1166          * requests.
1167          */
1168         sdev->max_device_blocked = 1;
1169 }
1170
1171 /**
1172  *      atapi_drain_needed - Check whether data transfer may overflow
1173  *      @rq: request to be checked
1174  *
1175  *      ATAPI commands which transfer variable length data to host
1176  *      might overflow due to application error or hardware bug.  This
1177  *      function checks whether overflow should be drained and ignored
1178  *      for @request.
1179  *
1180  *      LOCKING:
1181  *      None.
1182  *
1183  *      RETURNS:
1184  *      1 if ; otherwise, 0.
1185  */
1186 static int atapi_drain_needed(struct request *rq)
1187 {
1188         if (likely(rq->cmd_type != REQ_TYPE_BLOCK_PC))
1189                 return 0;
1190
1191         if (!blk_rq_bytes(rq) || op_is_write(req_op(rq)))
1192                 return 0;
1193
1194         return atapi_cmd_type(rq->cmd[0]) == ATAPI_MISC;
1195 }
1196
1197 static int ata_scsi_dev_config(struct scsi_device *sdev,
1198                                struct ata_device *dev)
1199 {
1200         struct request_queue *q = sdev->request_queue;
1201
1202         if (!ata_id_has_unload(dev->id))
1203                 dev->flags |= ATA_DFLAG_NO_UNLOAD;
1204
1205         /* configure max sectors */
1206         blk_queue_max_hw_sectors(q, dev->max_sectors);
1207
1208         if (dev->class == ATA_DEV_ATAPI) {
1209                 void *buf;
1210
1211                 sdev->sector_size = ATA_SECT_SIZE;
1212
1213                 /* set DMA padding */
1214                 blk_queue_update_dma_pad(q, ATA_DMA_PAD_SZ - 1);
1215
1216                 /* configure draining */
1217                 buf = kmalloc(ATAPI_MAX_DRAIN, q->bounce_gfp | GFP_KERNEL);
1218                 if (!buf) {
1219                         ata_dev_err(dev, "drain buffer allocation failed\n");
1220                         return -ENOMEM;
1221                 }
1222
1223                 blk_queue_dma_drain(q, atapi_drain_needed, buf, ATAPI_MAX_DRAIN);
1224         } else {
1225                 sdev->sector_size = ata_id_logical_sector_size(dev->id);
1226                 sdev->manage_start_stop = 1;
1227         }
1228
1229         /*
1230          * ata_pio_sectors() expects buffer for each sector to not cross
1231          * page boundary.  Enforce it by requiring buffers to be sector
1232          * aligned, which works iff sector_size is not larger than
1233          * PAGE_SIZE.  ATAPI devices also need the alignment as
1234          * IDENTIFY_PACKET is executed as ATA_PROT_PIO.
1235          */
1236         if (sdev->sector_size > PAGE_SIZE)
1237                 ata_dev_warn(dev,
1238                         "sector_size=%u > PAGE_SIZE, PIO may malfunction\n",
1239                         sdev->sector_size);
1240
1241         blk_queue_update_dma_alignment(q, sdev->sector_size - 1);
1242
1243         if (dev->flags & ATA_DFLAG_AN)
1244                 set_bit(SDEV_EVT_MEDIA_CHANGE, sdev->supported_events);
1245
1246         if (dev->flags & ATA_DFLAG_NCQ) {
1247                 int depth;
1248
1249                 depth = min(sdev->host->can_queue, ata_id_queue_depth(dev->id));
1250                 depth = min(ATA_MAX_QUEUE - 1, depth);
1251                 scsi_change_queue_depth(sdev, depth);
1252         }
1253
1254         blk_queue_flush_queueable(q, false);
1255
1256         dev->sdev = sdev;
1257         return 0;
1258 }
1259
1260 /**
1261  *      ata_scsi_slave_config - Set SCSI device attributes
1262  *      @sdev: SCSI device to examine
1263  *
1264  *      This is called before we actually start reading
1265  *      and writing to the device, to configure certain
1266  *      SCSI mid-layer behaviors.
1267  *
1268  *      LOCKING:
1269  *      Defined by SCSI layer.  We don't really care.
1270  */
1271
1272 int ata_scsi_slave_config(struct scsi_device *sdev)
1273 {
1274         struct ata_port *ap = ata_shost_to_port(sdev->host);
1275         struct ata_device *dev = __ata_scsi_find_dev(ap, sdev);
1276         int rc = 0;
1277
1278         ata_scsi_sdev_config(sdev);
1279
1280         if (dev)
1281                 rc = ata_scsi_dev_config(sdev, dev);
1282
1283         return rc;
1284 }
1285
1286 /**
1287  *      ata_scsi_slave_destroy - SCSI device is about to be destroyed
1288  *      @sdev: SCSI device to be destroyed
1289  *
1290  *      @sdev is about to be destroyed for hot/warm unplugging.  If
1291  *      this unplugging was initiated by libata as indicated by NULL
1292  *      dev->sdev, this function doesn't have to do anything.
1293  *      Otherwise, SCSI layer initiated warm-unplug is in progress.
1294  *      Clear dev->sdev, schedule the device for ATA detach and invoke
1295  *      EH.
1296  *
1297  *      LOCKING:
1298  *      Defined by SCSI layer.  We don't really care.
1299  */
1300 void ata_scsi_slave_destroy(struct scsi_device *sdev)
1301 {
1302         struct ata_port *ap = ata_shost_to_port(sdev->host);
1303         struct request_queue *q = sdev->request_queue;
1304         unsigned long flags;
1305         struct ata_device *dev;
1306
1307         if (!ap->ops->error_handler)
1308                 return;
1309
1310         spin_lock_irqsave(ap->lock, flags);
1311         dev = __ata_scsi_find_dev(ap, sdev);
1312         if (dev && dev->sdev) {
1313                 /* SCSI device already in CANCEL state, no need to offline it */
1314                 dev->sdev = NULL;
1315                 dev->flags |= ATA_DFLAG_DETACH;
1316                 ata_port_schedule_eh(ap);
1317         }
1318         spin_unlock_irqrestore(ap->lock, flags);
1319
1320         kfree(q->dma_drain_buffer);
1321         q->dma_drain_buffer = NULL;
1322         q->dma_drain_size = 0;
1323 }
1324
1325 /**
1326  *      __ata_change_queue_depth - helper for ata_scsi_change_queue_depth
1327  *      @ap: ATA port to which the device change the queue depth
1328  *      @sdev: SCSI device to configure queue depth for
1329  *      @queue_depth: new queue depth
1330  *
1331  *      libsas and libata have different approaches for associating a sdev to
1332  *      its ata_port.
1333  *
1334  */
1335 int __ata_change_queue_depth(struct ata_port *ap, struct scsi_device *sdev,
1336                              int queue_depth)
1337 {
1338         struct ata_device *dev;
1339         unsigned long flags;
1340
1341         if (queue_depth < 1 || queue_depth == sdev->queue_depth)
1342                 return sdev->queue_depth;
1343
1344         dev = ata_scsi_find_dev(ap, sdev);
1345         if (!dev || !ata_dev_enabled(dev))
1346                 return sdev->queue_depth;
1347
1348         /* NCQ enabled? */
1349         spin_lock_irqsave(ap->lock, flags);
1350         dev->flags &= ~ATA_DFLAG_NCQ_OFF;
1351         if (queue_depth == 1 || !ata_ncq_enabled(dev)) {
1352                 dev->flags |= ATA_DFLAG_NCQ_OFF;
1353                 queue_depth = 1;
1354         }
1355         spin_unlock_irqrestore(ap->lock, flags);
1356
1357         /* limit and apply queue depth */
1358         queue_depth = min(queue_depth, sdev->host->can_queue);
1359         queue_depth = min(queue_depth, ata_id_queue_depth(dev->id));
1360         queue_depth = min(queue_depth, ATA_MAX_QUEUE - 1);
1361
1362         if (sdev->queue_depth == queue_depth)
1363                 return -EINVAL;
1364
1365         return scsi_change_queue_depth(sdev, queue_depth);
1366 }
1367
1368 /**
1369  *      ata_scsi_change_queue_depth - SCSI callback for queue depth config
1370  *      @sdev: SCSI device to configure queue depth for
1371  *      @queue_depth: new queue depth
1372  *
1373  *      This is libata standard hostt->change_queue_depth callback.
1374  *      SCSI will call into this callback when user tries to set queue
1375  *      depth via sysfs.
1376  *
1377  *      LOCKING:
1378  *      SCSI layer (we don't care)
1379  *
1380  *      RETURNS:
1381  *      Newly configured queue depth.
1382  */
1383 int ata_scsi_change_queue_depth(struct scsi_device *sdev, int queue_depth)
1384 {
1385         struct ata_port *ap = ata_shost_to_port(sdev->host);
1386
1387         return __ata_change_queue_depth(ap, sdev, queue_depth);
1388 }
1389
1390 /**
1391  *      ata_scsi_start_stop_xlat - Translate SCSI START STOP UNIT command
1392  *      @qc: Storage for translated ATA taskfile
1393  *
1394  *      Sets up an ATA taskfile to issue STANDBY (to stop) or READ VERIFY
1395  *      (to start). Perhaps these commands should be preceded by
1396  *      CHECK POWER MODE to see what power mode the device is already in.
1397  *      [See SAT revision 5 at www.t10.org]
1398  *
1399  *      LOCKING:
1400  *      spin_lock_irqsave(host lock)
1401  *
1402  *      RETURNS:
1403  *      Zero on success, non-zero on error.
1404  */
1405 static unsigned int ata_scsi_start_stop_xlat(struct ata_queued_cmd *qc)
1406 {
1407         struct scsi_cmnd *scmd = qc->scsicmd;
1408         struct ata_taskfile *tf = &qc->tf;
1409         const u8 *cdb = scmd->cmnd;
1410         u16 fp;
1411         u8 bp = 0xff;
1412
1413         if (scmd->cmd_len < 5) {
1414                 fp = 4;
1415                 goto invalid_fld;
1416         }
1417
1418         tf->flags |= ATA_TFLAG_DEVICE | ATA_TFLAG_ISADDR;
1419         tf->protocol = ATA_PROT_NODATA;
1420         if (cdb[1] & 0x1) {
1421                 ;       /* ignore IMMED bit, violates sat-r05 */
1422         }
1423         if (cdb[4] & 0x2) {
1424                 fp = 4;
1425                 bp = 1;
1426                 goto invalid_fld;       /* LOEJ bit set not supported */
1427         }
1428         if (((cdb[4] >> 4) & 0xf) != 0) {
1429                 fp = 4;
1430                 bp = 3;
1431                 goto invalid_fld;       /* power conditions not supported */
1432         }
1433
1434         if (cdb[4] & 0x1) {
1435                 tf->nsect = 1;  /* 1 sector, lba=0 */
1436
1437                 if (qc->dev->flags & ATA_DFLAG_LBA) {
1438                         tf->flags |= ATA_TFLAG_LBA;
1439
1440                         tf->lbah = 0x0;
1441                         tf->lbam = 0x0;
1442                         tf->lbal = 0x0;
1443                         tf->device |= ATA_LBA;
1444                 } else {
1445                         /* CHS */
1446                         tf->lbal = 0x1; /* sect */
1447                         tf->lbam = 0x0; /* cyl low */
1448                         tf->lbah = 0x0; /* cyl high */
1449                 }
1450
1451                 tf->command = ATA_CMD_VERIFY;   /* READ VERIFY */
1452         } else {
1453                 /* Some odd clown BIOSen issue spindown on power off (ACPI S4
1454                  * or S5) causing some drives to spin up and down again.
1455                  */
1456                 if ((qc->ap->flags & ATA_FLAG_NO_POWEROFF_SPINDOWN) &&
1457                     system_state == SYSTEM_POWER_OFF)
1458                         goto skip;
1459
1460                 if ((qc->ap->flags & ATA_FLAG_NO_HIBERNATE_SPINDOWN) &&
1461                      system_entering_hibernation())
1462                         goto skip;
1463
1464                 /* Issue ATA STANDBY IMMEDIATE command */
1465                 tf->command = ATA_CMD_STANDBYNOW1;
1466         }
1467
1468         /*
1469          * Standby and Idle condition timers could be implemented but that
1470          * would require libata to implement the Power condition mode page
1471          * and allow the user to change it. Changing mode pages requires
1472          * MODE SELECT to be implemented.
1473          */
1474
1475         return 0;
1476
1477  invalid_fld:
1478         ata_scsi_set_invalid_field(qc->dev, scmd, fp, bp);
1479         return 1;
1480  skip:
1481         scmd->result = SAM_STAT_GOOD;
1482         return 1;
1483 }
1484
1485
1486 /**
1487  *      ata_scsi_flush_xlat - Translate SCSI SYNCHRONIZE CACHE command
1488  *      @qc: Storage for translated ATA taskfile
1489  *
1490  *      Sets up an ATA taskfile to issue FLUSH CACHE or
1491  *      FLUSH CACHE EXT.
1492  *
1493  *      LOCKING:
1494  *      spin_lock_irqsave(host lock)
1495  *
1496  *      RETURNS:
1497  *      Zero on success, non-zero on error.
1498  */
1499 static unsigned int ata_scsi_flush_xlat(struct ata_queued_cmd *qc)
1500 {
1501         struct ata_taskfile *tf = &qc->tf;
1502
1503         tf->flags |= ATA_TFLAG_DEVICE;
1504         tf->protocol = ATA_PROT_NODATA;
1505
1506         if (qc->dev->flags & ATA_DFLAG_FLUSH_EXT)
1507                 tf->command = ATA_CMD_FLUSH_EXT;
1508         else
1509                 tf->command = ATA_CMD_FLUSH;
1510
1511         /* flush is critical for IO integrity, consider it an IO command */
1512         qc->flags |= ATA_QCFLAG_IO;
1513
1514         return 0;
1515 }
1516
1517 /**
1518  *      scsi_6_lba_len - Get LBA and transfer length
1519  *      @cdb: SCSI command to translate
1520  *
1521  *      Calculate LBA and transfer length for 6-byte commands.
1522  *
1523  *      RETURNS:
1524  *      @plba: the LBA
1525  *      @plen: the transfer length
1526  */
1527 static void scsi_6_lba_len(const u8 *cdb, u64 *plba, u32 *plen)
1528 {
1529         u64 lba = 0;
1530         u32 len;
1531
1532         VPRINTK("six-byte command\n");
1533
1534         lba |= ((u64)(cdb[1] & 0x1f)) << 16;
1535         lba |= ((u64)cdb[2]) << 8;
1536         lba |= ((u64)cdb[3]);
1537
1538         len = cdb[4];
1539
1540         *plba = lba;
1541         *plen = len;
1542 }
1543
1544 /**
1545  *      scsi_10_lba_len - Get LBA and transfer length
1546  *      @cdb: SCSI command to translate
1547  *
1548  *      Calculate LBA and transfer length for 10-byte commands.
1549  *
1550  *      RETURNS:
1551  *      @plba: the LBA
1552  *      @plen: the transfer length
1553  */
1554 static void scsi_10_lba_len(const u8 *cdb, u64 *plba, u32 *plen)
1555 {
1556         u64 lba = 0;
1557         u32 len = 0;
1558
1559         VPRINTK("ten-byte command\n");
1560
1561         lba |= ((u64)cdb[2]) << 24;
1562         lba |= ((u64)cdb[3]) << 16;
1563         lba |= ((u64)cdb[4]) << 8;
1564         lba |= ((u64)cdb[5]);
1565
1566         len |= ((u32)cdb[7]) << 8;
1567         len |= ((u32)cdb[8]);
1568
1569         *plba = lba;
1570         *plen = len;
1571 }
1572
1573 /**
1574  *      scsi_16_lba_len - Get LBA and transfer length
1575  *      @cdb: SCSI command to translate
1576  *
1577  *      Calculate LBA and transfer length for 16-byte commands.
1578  *
1579  *      RETURNS:
1580  *      @plba: the LBA
1581  *      @plen: the transfer length
1582  */
1583 static void scsi_16_lba_len(const u8 *cdb, u64 *plba, u32 *plen)
1584 {
1585         u64 lba = 0;
1586         u32 len = 0;
1587
1588         VPRINTK("sixteen-byte command\n");
1589
1590         lba |= ((u64)cdb[2]) << 56;
1591         lba |= ((u64)cdb[3]) << 48;
1592         lba |= ((u64)cdb[4]) << 40;
1593         lba |= ((u64)cdb[5]) << 32;
1594         lba |= ((u64)cdb[6]) << 24;
1595         lba |= ((u64)cdb[7]) << 16;
1596         lba |= ((u64)cdb[8]) << 8;
1597         lba |= ((u64)cdb[9]);
1598
1599         len |= ((u32)cdb[10]) << 24;
1600         len |= ((u32)cdb[11]) << 16;
1601         len |= ((u32)cdb[12]) << 8;
1602         len |= ((u32)cdb[13]);
1603
1604         *plba = lba;
1605         *plen = len;
1606 }
1607
1608 /**
1609  *      ata_scsi_verify_xlat - Translate SCSI VERIFY command into an ATA one
1610  *      @qc: Storage for translated ATA taskfile
1611  *
1612  *      Converts SCSI VERIFY command to an ATA READ VERIFY command.
1613  *
1614  *      LOCKING:
1615  *      spin_lock_irqsave(host lock)
1616  *
1617  *      RETURNS:
1618  *      Zero on success, non-zero on error.
1619  */
1620 static unsigned int ata_scsi_verify_xlat(struct ata_queued_cmd *qc)
1621 {
1622         struct scsi_cmnd *scmd = qc->scsicmd;
1623         struct ata_taskfile *tf = &qc->tf;
1624         struct ata_device *dev = qc->dev;
1625         u64 dev_sectors = qc->dev->n_sectors;
1626         const u8 *cdb = scmd->cmnd;
1627         u64 block;
1628         u32 n_block;
1629         u16 fp;
1630
1631         tf->flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
1632         tf->protocol = ATA_PROT_NODATA;
1633
1634         if (cdb[0] == VERIFY) {
1635                 if (scmd->cmd_len < 10) {
1636                         fp = 9;
1637                         goto invalid_fld;
1638                 }
1639                 scsi_10_lba_len(cdb, &block, &n_block);
1640         } else if (cdb[0] == VERIFY_16) {
1641                 if (scmd->cmd_len < 16) {
1642                         fp = 15;
1643                         goto invalid_fld;
1644                 }
1645                 scsi_16_lba_len(cdb, &block, &n_block);
1646         } else {
1647                 fp = 0;
1648                 goto invalid_fld;
1649         }
1650
1651         if (!n_block)
1652                 goto nothing_to_do;
1653         if (block >= dev_sectors)
1654                 goto out_of_range;
1655         if ((block + n_block) > dev_sectors)
1656                 goto out_of_range;
1657
1658         if (dev->flags & ATA_DFLAG_LBA) {
1659                 tf->flags |= ATA_TFLAG_LBA;
1660
1661                 if (lba_28_ok(block, n_block)) {
1662                         /* use LBA28 */
1663                         tf->command = ATA_CMD_VERIFY;
1664                         tf->device |= (block >> 24) & 0xf;
1665                 } else if (lba_48_ok(block, n_block)) {
1666                         if (!(dev->flags & ATA_DFLAG_LBA48))
1667                                 goto out_of_range;
1668
1669                         /* use LBA48 */
1670                         tf->flags |= ATA_TFLAG_LBA48;
1671                         tf->command = ATA_CMD_VERIFY_EXT;
1672
1673                         tf->hob_nsect = (n_block >> 8) & 0xff;
1674
1675                         tf->hob_lbah = (block >> 40) & 0xff;
1676                         tf->hob_lbam = (block >> 32) & 0xff;
1677                         tf->hob_lbal = (block >> 24) & 0xff;
1678                 } else
1679                         /* request too large even for LBA48 */
1680                         goto out_of_range;
1681
1682                 tf->nsect = n_block & 0xff;
1683
1684                 tf->lbah = (block >> 16) & 0xff;
1685                 tf->lbam = (block >> 8) & 0xff;
1686                 tf->lbal = block & 0xff;
1687
1688                 tf->device |= ATA_LBA;
1689         } else {
1690                 /* CHS */
1691                 u32 sect, head, cyl, track;
1692
1693                 if (!lba_28_ok(block, n_block))
1694                         goto out_of_range;
1695
1696                 /* Convert LBA to CHS */
1697                 track = (u32)block / dev->sectors;
1698                 cyl   = track / dev->heads;
1699                 head  = track % dev->heads;
1700                 sect  = (u32)block % dev->sectors + 1;
1701
1702                 DPRINTK("block %u track %u cyl %u head %u sect %u\n",
1703                         (u32)block, track, cyl, head, sect);
1704
1705                 /* Check whether the converted CHS can fit.
1706                    Cylinder: 0-65535
1707                    Head: 0-15
1708                    Sector: 1-255*/
1709                 if ((cyl >> 16) || (head >> 4) || (sect >> 8) || (!sect))
1710                         goto out_of_range;
1711
1712                 tf->command = ATA_CMD_VERIFY;
1713                 tf->nsect = n_block & 0xff; /* Sector count 0 means 256 sectors */
1714                 tf->lbal = sect;
1715                 tf->lbam = cyl;
1716                 tf->lbah = cyl >> 8;
1717                 tf->device |= head;
1718         }
1719
1720         return 0;
1721
1722 invalid_fld:
1723         ata_scsi_set_invalid_field(qc->dev, scmd, fp, 0xff);
1724         return 1;
1725
1726 out_of_range:
1727         ata_scsi_set_sense(qc->dev, 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 /**
1737  *      ata_scsi_rw_xlat - Translate SCSI r/w command into an ATA one
1738  *      @qc: Storage for translated ATA taskfile
1739  *
1740  *      Converts any of six SCSI read/write commands into the
1741  *      ATA counterpart, including starting sector (LBA),
1742  *      sector count, and taking into account the device's LBA48
1743  *      support.
1744  *
1745  *      Commands %READ_6, %READ_10, %READ_16, %WRITE_6, %WRITE_10, and
1746  *      %WRITE_16 are currently supported.
1747  *
1748  *      LOCKING:
1749  *      spin_lock_irqsave(host lock)
1750  *
1751  *      RETURNS:
1752  *      Zero on success, non-zero on error.
1753  */
1754 static unsigned int ata_scsi_rw_xlat(struct ata_queued_cmd *qc)
1755 {
1756         struct scsi_cmnd *scmd = qc->scsicmd;
1757         const u8 *cdb = scmd->cmnd;
1758         unsigned int tf_flags = 0;
1759         u64 block;
1760         u32 n_block;
1761         int rc;
1762         u16 fp = 0;
1763
1764         if (cdb[0] == WRITE_10 || cdb[0] == WRITE_6 || cdb[0] == WRITE_16)
1765                 tf_flags |= ATA_TFLAG_WRITE;
1766
1767         /* Calculate the SCSI LBA, transfer length and FUA. */
1768         switch (cdb[0]) {
1769         case READ_10:
1770         case WRITE_10:
1771                 if (unlikely(scmd->cmd_len < 10)) {
1772                         fp = 9;
1773                         goto invalid_fld;
1774                 }
1775                 scsi_10_lba_len(cdb, &block, &n_block);
1776                 if (cdb[1] & (1 << 3))
1777                         tf_flags |= ATA_TFLAG_FUA;
1778                 break;
1779         case READ_6:
1780         case WRITE_6:
1781                 if (unlikely(scmd->cmd_len < 6)) {
1782                         fp = 5;
1783                         goto invalid_fld;
1784                 }
1785                 scsi_6_lba_len(cdb, &block, &n_block);
1786
1787                 /* for 6-byte r/w commands, transfer length 0
1788                  * means 256 blocks of data, not 0 block.
1789                  */
1790                 if (!n_block)
1791                         n_block = 256;
1792                 break;
1793         case READ_16:
1794         case WRITE_16:
1795                 if (unlikely(scmd->cmd_len < 16)) {
1796                         fp = 15;
1797                         goto invalid_fld;
1798                 }
1799                 scsi_16_lba_len(cdb, &block, &n_block);
1800                 if (cdb[1] & (1 << 3))
1801                         tf_flags |= ATA_TFLAG_FUA;
1802                 break;
1803         default:
1804                 DPRINTK("no-byte command\n");
1805                 fp = 0;
1806                 goto invalid_fld;
1807         }
1808
1809         /* Check and compose ATA command */
1810         if (!n_block)
1811                 /* For 10-byte and 16-byte SCSI R/W commands, transfer
1812                  * length 0 means transfer 0 block of data.
1813                  * However, for ATA R/W commands, sector count 0 means
1814                  * 256 or 65536 sectors, not 0 sectors as in SCSI.
1815                  *
1816                  * WARNING: one or two older ATA drives treat 0 as 0...
1817                  */
1818                 goto nothing_to_do;
1819
1820         qc->flags |= ATA_QCFLAG_IO;
1821         qc->nbytes = n_block * scmd->device->sector_size;
1822
1823         rc = ata_build_rw_tf(&qc->tf, qc->dev, block, n_block, tf_flags,
1824                              qc->tag);
1825         if (likely(rc == 0))
1826                 return 0;
1827
1828         if (rc == -ERANGE)
1829                 goto out_of_range;
1830         /* treat all other errors as -EINVAL, fall through */
1831 invalid_fld:
1832         ata_scsi_set_invalid_field(qc->dev, scmd, fp, 0xff);
1833         return 1;
1834
1835 out_of_range:
1836         ata_scsi_set_sense(qc->dev, scmd, ILLEGAL_REQUEST, 0x21, 0x0);
1837         /* "Logical Block Address out of range" */
1838         return 1;
1839
1840 nothing_to_do:
1841         scmd->result = SAM_STAT_GOOD;
1842         return 1;
1843 }
1844
1845 static void ata_qc_done(struct ata_queued_cmd *qc)
1846 {
1847         struct scsi_cmnd *cmd = qc->scsicmd;
1848         void (*done)(struct scsi_cmnd *) = qc->scsidone;
1849
1850         ata_qc_free(qc);
1851         done(cmd);
1852 }
1853
1854 static void ata_scsi_qc_complete(struct ata_queued_cmd *qc)
1855 {
1856         struct ata_port *ap = qc->ap;
1857         struct scsi_cmnd *cmd = qc->scsicmd;
1858         u8 *cdb = cmd->cmnd;
1859         int need_sense = (qc->err_mask != 0);
1860
1861         /* For ATA pass thru (SAT) commands, generate a sense block if
1862          * user mandated it or if there's an error.  Note that if we
1863          * generate because the user forced us to [CK_COND =1], a check
1864          * condition is generated and the ATA register values are returned
1865          * whether the command completed successfully or not. If there
1866          * was no error, we use the following sense data:
1867          * sk = RECOVERED ERROR
1868          * asc,ascq = ATA PASS-THROUGH INFORMATION AVAILABLE
1869          */
1870         if (((cdb[0] == ATA_16) || (cdb[0] == ATA_12)) &&
1871             ((cdb[2] & 0x20) || need_sense))
1872                 ata_gen_passthru_sense(qc);
1873         else if (qc->flags & ATA_QCFLAG_SENSE_VALID)
1874                 cmd->result = SAM_STAT_CHECK_CONDITION;
1875         else if (need_sense)
1876                 ata_gen_ata_sense(qc);
1877         else
1878                 cmd->result = SAM_STAT_GOOD;
1879
1880         if (need_sense && !ap->ops->error_handler)
1881                 ata_dump_status(ap->print_id, &qc->result_tf);
1882
1883         ata_qc_done(qc);
1884 }
1885
1886 /**
1887  *      ata_scsi_translate - Translate then issue SCSI command to ATA device
1888  *      @dev: ATA device to which the command is addressed
1889  *      @cmd: SCSI command to execute
1890  *      @xlat_func: Actor which translates @cmd to an ATA taskfile
1891  *
1892  *      Our ->queuecommand() function has decided that the SCSI
1893  *      command issued can be directly translated into an ATA
1894  *      command, rather than handled internally.
1895  *
1896  *      This function sets up an ata_queued_cmd structure for the
1897  *      SCSI command, and sends that ata_queued_cmd to the hardware.
1898  *
1899  *      The xlat_func argument (actor) returns 0 if ready to execute
1900  *      ATA command, else 1 to finish translation. If 1 is returned
1901  *      then cmd->result (and possibly cmd->sense_buffer) are assumed
1902  *      to be set reflecting an error condition or clean (early)
1903  *      termination.
1904  *
1905  *      LOCKING:
1906  *      spin_lock_irqsave(host lock)
1907  *
1908  *      RETURNS:
1909  *      0 on success, SCSI_ML_QUEUE_DEVICE_BUSY if the command
1910  *      needs to be deferred.
1911  */
1912 static int ata_scsi_translate(struct ata_device *dev, struct scsi_cmnd *cmd,
1913                               ata_xlat_func_t xlat_func)
1914 {
1915         struct ata_port *ap = dev->link->ap;
1916         struct ata_queued_cmd *qc;
1917         int rc;
1918
1919         VPRINTK("ENTER\n");
1920
1921         qc = ata_scsi_qc_new(dev, cmd);
1922         if (!qc)
1923                 goto err_mem;
1924
1925         /* data is present; dma-map it */
1926         if (cmd->sc_data_direction == DMA_FROM_DEVICE ||
1927             cmd->sc_data_direction == DMA_TO_DEVICE) {
1928                 if (unlikely(scsi_bufflen(cmd) < 1)) {
1929                         ata_dev_warn(dev, "WARNING: zero len r/w req\n");
1930                         goto err_did;
1931                 }
1932
1933                 ata_sg_init(qc, scsi_sglist(cmd), scsi_sg_count(cmd));
1934
1935                 qc->dma_dir = cmd->sc_data_direction;
1936         }
1937
1938         qc->complete_fn = ata_scsi_qc_complete;
1939
1940         if (xlat_func(qc))
1941                 goto early_finish;
1942
1943         if (ap->ops->qc_defer) {
1944                 if ((rc = ap->ops->qc_defer(qc)))
1945                         goto defer;
1946         }
1947
1948         /* select device, send command to hardware */
1949         ata_qc_issue(qc);
1950
1951         VPRINTK("EXIT\n");
1952         return 0;
1953
1954 early_finish:
1955         ata_qc_free(qc);
1956         cmd->scsi_done(cmd);
1957         DPRINTK("EXIT - early finish (good or error)\n");
1958         return 0;
1959
1960 err_did:
1961         ata_qc_free(qc);
1962         cmd->result = (DID_ERROR << 16);
1963         cmd->scsi_done(cmd);
1964 err_mem:
1965         DPRINTK("EXIT - internal\n");
1966         return 0;
1967
1968 defer:
1969         ata_qc_free(qc);
1970         DPRINTK("EXIT - defer\n");
1971         if (rc == ATA_DEFER_LINK)
1972                 return SCSI_MLQUEUE_DEVICE_BUSY;
1973         else
1974                 return SCSI_MLQUEUE_HOST_BUSY;
1975 }
1976
1977 /**
1978  *      ata_scsi_rbuf_get - Map response buffer.
1979  *      @cmd: SCSI command containing buffer to be mapped.
1980  *      @flags: unsigned long variable to store irq enable status
1981  *      @copy_in: copy in from user buffer
1982  *
1983  *      Prepare buffer for simulated SCSI commands.
1984  *
1985  *      LOCKING:
1986  *      spin_lock_irqsave(ata_scsi_rbuf_lock) on success
1987  *
1988  *      RETURNS:
1989  *      Pointer to response buffer.
1990  */
1991 static void *ata_scsi_rbuf_get(struct scsi_cmnd *cmd, bool copy_in,
1992                                unsigned long *flags)
1993 {
1994         spin_lock_irqsave(&ata_scsi_rbuf_lock, *flags);
1995
1996         memset(ata_scsi_rbuf, 0, ATA_SCSI_RBUF_SIZE);
1997         if (copy_in)
1998                 sg_copy_to_buffer(scsi_sglist(cmd), scsi_sg_count(cmd),
1999                                   ata_scsi_rbuf, ATA_SCSI_RBUF_SIZE);
2000         return ata_scsi_rbuf;
2001 }
2002
2003 /**
2004  *      ata_scsi_rbuf_put - Unmap response buffer.
2005  *      @cmd: SCSI command containing buffer to be unmapped.
2006  *      @copy_out: copy out result
2007  *      @flags: @flags passed to ata_scsi_rbuf_get()
2008  *
2009  *      Returns rbuf buffer.  The result is copied to @cmd's buffer if
2010  *      @copy_back is true.
2011  *
2012  *      LOCKING:
2013  *      Unlocks ata_scsi_rbuf_lock.
2014  */
2015 static inline void ata_scsi_rbuf_put(struct scsi_cmnd *cmd, bool copy_out,
2016                                      unsigned long *flags)
2017 {
2018         if (copy_out)
2019                 sg_copy_from_buffer(scsi_sglist(cmd), scsi_sg_count(cmd),
2020                                     ata_scsi_rbuf, ATA_SCSI_RBUF_SIZE);
2021         spin_unlock_irqrestore(&ata_scsi_rbuf_lock, *flags);
2022 }
2023
2024 /**
2025  *      ata_scsi_rbuf_fill - wrapper for SCSI command simulators
2026  *      @args: device IDENTIFY data / SCSI command of interest.
2027  *      @actor: Callback hook for desired SCSI command simulator
2028  *
2029  *      Takes care of the hard work of simulating a SCSI command...
2030  *      Mapping the response buffer, calling the command's handler,
2031  *      and handling the handler's return value.  This return value
2032  *      indicates whether the handler wishes the SCSI command to be
2033  *      completed successfully (0), or not (in which case cmd->result
2034  *      and sense buffer are assumed to be set).
2035  *
2036  *      LOCKING:
2037  *      spin_lock_irqsave(host lock)
2038  */
2039 static void ata_scsi_rbuf_fill(struct ata_scsi_args *args,
2040                 unsigned int (*actor)(struct ata_scsi_args *args, u8 *rbuf))
2041 {
2042         u8 *rbuf;
2043         unsigned int rc;
2044         struct scsi_cmnd *cmd = args->cmd;
2045         unsigned long flags;
2046
2047         rbuf = ata_scsi_rbuf_get(cmd, false, &flags);
2048         rc = actor(args, rbuf);
2049         ata_scsi_rbuf_put(cmd, rc == 0, &flags);
2050
2051         if (rc == 0)
2052                 cmd->result = SAM_STAT_GOOD;
2053         args->done(cmd);
2054 }
2055
2056 /**
2057  *      ata_scsiop_inq_std - Simulate INQUIRY command
2058  *      @args: device IDENTIFY data / SCSI command of interest.
2059  *      @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2060  *
2061  *      Returns standard device identification data associated
2062  *      with non-VPD INQUIRY command output.
2063  *
2064  *      LOCKING:
2065  *      spin_lock_irqsave(host lock)
2066  */
2067 static unsigned int ata_scsiop_inq_std(struct ata_scsi_args *args, u8 *rbuf)
2068 {
2069         const u8 versions[] = {
2070                 0x00,
2071                 0x60,   /* SAM-3 (no version claimed) */
2072
2073                 0x03,
2074                 0x20,   /* SBC-2 (no version claimed) */
2075
2076                 0x03,
2077                 0x00    /* SPC-3 (no version claimed) */
2078         };
2079         const u8 versions_zbc[] = {
2080                 0x00,
2081                 0xA0,   /* SAM-5 (no version claimed) */
2082
2083                 0x06,
2084                 0x00,   /* SBC-4 (no version claimed) */
2085
2086                 0x05,
2087                 0xC0,   /* SPC-5 (no version claimed) */
2088
2089                 0x60,
2090                 0x24,   /* ZBC r05 */
2091         };
2092
2093         u8 hdr[] = {
2094                 TYPE_DISK,
2095                 0,
2096                 0x5,    /* claim SPC-3 version compatibility */
2097                 2,
2098                 95 - 4,
2099                 0,
2100                 0,
2101                 2
2102         };
2103
2104         VPRINTK("ENTER\n");
2105
2106         /* set scsi removable (RMB) bit per ata bit, or if the
2107          * AHCI port says it's external (Hotplug-capable, eSATA).
2108          */
2109         if (ata_id_removable(args->id) ||
2110             (args->dev->link->ap->pflags & ATA_PFLAG_EXTERNAL))
2111                 hdr[1] |= (1 << 7);
2112
2113         if (args->dev->class == ATA_DEV_ZAC) {
2114                 hdr[0] = TYPE_ZBC;
2115                 hdr[2] = 0x7; /* claim SPC-5 version compatibility */
2116         }
2117
2118         memcpy(rbuf, hdr, sizeof(hdr));
2119         memcpy(&rbuf[8], "ATA     ", 8);
2120         ata_id_string(args->id, &rbuf[16], ATA_ID_PROD, 16);
2121
2122         /* From SAT, use last 2 words from fw rev unless they are spaces */
2123         ata_id_string(args->id, &rbuf[32], ATA_ID_FW_REV + 2, 4);
2124         if (strncmp(&rbuf[32], "    ", 4) == 0)
2125                 ata_id_string(args->id, &rbuf[32], ATA_ID_FW_REV, 4);
2126
2127         if (rbuf[32] == 0 || rbuf[32] == ' ')
2128                 memcpy(&rbuf[32], "n/a ", 4);
2129
2130         if (ata_id_zoned_cap(args->id) || args->dev->class == ATA_DEV_ZAC)
2131                 memcpy(rbuf + 58, versions_zbc, sizeof(versions_zbc));
2132         else
2133                 memcpy(rbuf + 58, versions, sizeof(versions));
2134
2135         return 0;
2136 }
2137
2138 /**
2139  *      ata_scsiop_inq_00 - Simulate INQUIRY VPD page 0, list of pages
2140  *      @args: device IDENTIFY data / SCSI command of interest.
2141  *      @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2142  *
2143  *      Returns list of inquiry VPD pages available.
2144  *
2145  *      LOCKING:
2146  *      spin_lock_irqsave(host lock)
2147  */
2148 static unsigned int ata_scsiop_inq_00(struct ata_scsi_args *args, u8 *rbuf)
2149 {
2150         int num_pages;
2151         const u8 pages[] = {
2152                 0x00,   /* page 0x00, this page */
2153                 0x80,   /* page 0x80, unit serial no page */
2154                 0x83,   /* page 0x83, device ident page */
2155                 0x89,   /* page 0x89, ata info page */
2156                 0xb0,   /* page 0xb0, block limits page */
2157                 0xb1,   /* page 0xb1, block device characteristics page */
2158                 0xb2,   /* page 0xb2, thin provisioning page */
2159                 0xb6,   /* page 0xb6, zoned block device characteristics */
2160         };
2161
2162         num_pages = sizeof(pages);
2163         if (!(args->dev->flags & ATA_DFLAG_ZAC))
2164                 num_pages--;
2165         rbuf[3] = num_pages;    /* number of supported VPD pages */
2166         memcpy(rbuf + 4, pages, num_pages);
2167         return 0;
2168 }
2169
2170 /**
2171  *      ata_scsiop_inq_80 - Simulate INQUIRY VPD page 80, device serial number
2172  *      @args: device IDENTIFY data / SCSI command of interest.
2173  *      @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2174  *
2175  *      Returns ATA device serial number.
2176  *
2177  *      LOCKING:
2178  *      spin_lock_irqsave(host lock)
2179  */
2180 static unsigned int ata_scsiop_inq_80(struct ata_scsi_args *args, u8 *rbuf)
2181 {
2182         const u8 hdr[] = {
2183                 0,
2184                 0x80,                   /* this page code */
2185                 0,
2186                 ATA_ID_SERNO_LEN,       /* page len */
2187         };
2188
2189         memcpy(rbuf, hdr, sizeof(hdr));
2190         ata_id_string(args->id, (unsigned char *) &rbuf[4],
2191                       ATA_ID_SERNO, ATA_ID_SERNO_LEN);
2192         return 0;
2193 }
2194
2195 /**
2196  *      ata_scsiop_inq_83 - Simulate INQUIRY VPD page 83, device identity
2197  *      @args: device IDENTIFY data / SCSI command of interest.
2198  *      @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2199  *
2200  *      Yields two logical unit device identification designators:
2201  *       - vendor specific ASCII containing the ATA serial number
2202  *       - SAT defined "t10 vendor id based" containing ASCII vendor
2203  *         name ("ATA     "), model and serial numbers.
2204  *
2205  *      LOCKING:
2206  *      spin_lock_irqsave(host lock)
2207  */
2208 static unsigned int ata_scsiop_inq_83(struct ata_scsi_args *args, u8 *rbuf)
2209 {
2210         const int sat_model_serial_desc_len = 68;
2211         int num;
2212
2213         rbuf[1] = 0x83;                 /* this page code */
2214         num = 4;
2215
2216         /* piv=0, assoc=lu, code_set=ACSII, designator=vendor */
2217         rbuf[num + 0] = 2;
2218         rbuf[num + 3] = ATA_ID_SERNO_LEN;
2219         num += 4;
2220         ata_id_string(args->id, (unsigned char *) rbuf + num,
2221                       ATA_ID_SERNO, ATA_ID_SERNO_LEN);
2222         num += ATA_ID_SERNO_LEN;
2223
2224         /* SAT defined lu model and serial numbers descriptor */
2225         /* piv=0, assoc=lu, code_set=ACSII, designator=t10 vendor id */
2226         rbuf[num + 0] = 2;
2227         rbuf[num + 1] = 1;
2228         rbuf[num + 3] = sat_model_serial_desc_len;
2229         num += 4;
2230         memcpy(rbuf + num, "ATA     ", 8);
2231         num += 8;
2232         ata_id_string(args->id, (unsigned char *) rbuf + num, ATA_ID_PROD,
2233                       ATA_ID_PROD_LEN);
2234         num += ATA_ID_PROD_LEN;
2235         ata_id_string(args->id, (unsigned char *) rbuf + num, ATA_ID_SERNO,
2236                       ATA_ID_SERNO_LEN);
2237         num += ATA_ID_SERNO_LEN;
2238
2239         if (ata_id_has_wwn(args->id)) {
2240                 /* SAT defined lu world wide name */
2241                 /* piv=0, assoc=lu, code_set=binary, designator=NAA */
2242                 rbuf[num + 0] = 1;
2243                 rbuf[num + 1] = 3;
2244                 rbuf[num + 3] = ATA_ID_WWN_LEN;
2245                 num += 4;
2246                 ata_id_string(args->id, (unsigned char *) rbuf + num,
2247                               ATA_ID_WWN, ATA_ID_WWN_LEN);
2248                 num += ATA_ID_WWN_LEN;
2249         }
2250         rbuf[3] = num - 4;    /* page len (assume less than 256 bytes) */
2251         return 0;
2252 }
2253
2254 /**
2255  *      ata_scsiop_inq_89 - Simulate INQUIRY VPD page 89, ATA info
2256  *      @args: device IDENTIFY data / SCSI command of interest.
2257  *      @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2258  *
2259  *      Yields SAT-specified ATA VPD page.
2260  *
2261  *      LOCKING:
2262  *      spin_lock_irqsave(host lock)
2263  */
2264 static unsigned int ata_scsiop_inq_89(struct ata_scsi_args *args, u8 *rbuf)
2265 {
2266         struct ata_taskfile tf;
2267
2268         memset(&tf, 0, sizeof(tf));
2269
2270         rbuf[1] = 0x89;                 /* our page code */
2271         rbuf[2] = (0x238 >> 8);         /* page size fixed at 238h */
2272         rbuf[3] = (0x238 & 0xff);
2273
2274         memcpy(&rbuf[8], "linux   ", 8);
2275         memcpy(&rbuf[16], "libata          ", 16);
2276         memcpy(&rbuf[32], DRV_VERSION, 4);
2277
2278         /* we don't store the ATA device signature, so we fake it */
2279
2280         tf.command = ATA_DRDY;          /* really, this is Status reg */
2281         tf.lbal = 0x1;
2282         tf.nsect = 0x1;
2283
2284         ata_tf_to_fis(&tf, 0, 1, &rbuf[36]);    /* TODO: PMP? */
2285         rbuf[36] = 0x34;                /* force D2H Reg FIS (34h) */
2286
2287         rbuf[56] = ATA_CMD_ID_ATA;
2288
2289         memcpy(&rbuf[60], &args->id[0], 512);
2290         return 0;
2291 }
2292
2293 static unsigned int ata_scsiop_inq_b0(struct ata_scsi_args *args, u8 *rbuf)
2294 {
2295         u16 min_io_sectors;
2296
2297         rbuf[1] = 0xb0;
2298         rbuf[3] = 0x3c;         /* required VPD size with unmap support */
2299
2300         /*
2301          * Optimal transfer length granularity.
2302          *
2303          * This is always one physical block, but for disks with a smaller
2304          * logical than physical sector size we need to figure out what the
2305          * latter is.
2306          */
2307         min_io_sectors = 1 << ata_id_log2_per_physical_sector(args->id);
2308         put_unaligned_be16(min_io_sectors, &rbuf[6]);
2309
2310         /*
2311          * Optimal unmap granularity.
2312          *
2313          * The ATA spec doesn't even know about a granularity or alignment
2314          * for the TRIM command.  We can leave away most of the unmap related
2315          * VPD page entries, but we have specifify a granularity to signal
2316          * that we support some form of unmap - in thise case via WRITE SAME
2317          * with the unmap bit set.
2318          */
2319         if (ata_id_has_trim(args->id)) {
2320                 put_unaligned_be64(65535 * ATA_MAX_TRIM_RNUM, &rbuf[36]);
2321                 put_unaligned_be32(1, &rbuf[28]);
2322         }
2323
2324         return 0;
2325 }
2326
2327 static unsigned int ata_scsiop_inq_b1(struct ata_scsi_args *args, u8 *rbuf)
2328 {
2329         int form_factor = ata_id_form_factor(args->id);
2330         int media_rotation_rate = ata_id_rotation_rate(args->id);
2331         u8 zoned = ata_id_zoned_cap(args->id);
2332
2333         rbuf[1] = 0xb1;
2334         rbuf[3] = 0x3c;
2335         rbuf[4] = media_rotation_rate >> 8;
2336         rbuf[5] = media_rotation_rate;
2337         rbuf[7] = form_factor;
2338         if (zoned)
2339                 rbuf[8] = (zoned << 4);
2340
2341         return 0;
2342 }
2343
2344 static unsigned int ata_scsiop_inq_b2(struct ata_scsi_args *args, u8 *rbuf)
2345 {
2346         /* SCSI Thin Provisioning VPD page: SBC-3 rev 22 or later */
2347         rbuf[1] = 0xb2;
2348         rbuf[3] = 0x4;
2349         rbuf[5] = 1 << 6;       /* TPWS */
2350
2351         return 0;
2352 }
2353
2354 static unsigned int ata_scsiop_inq_b6(struct ata_scsi_args *args, u8 *rbuf)
2355 {
2356         /*
2357          * zbc-r05 SCSI Zoned Block device characteristics VPD page
2358          */
2359         rbuf[1] = 0xb6;
2360         rbuf[3] = 0x3C;
2361
2362         /*
2363          * URSWRZ bit is only meaningful for host-managed ZAC drives
2364          */
2365         if (args->dev->zac_zoned_cap & 1)
2366                 rbuf[4] |= 1;
2367         put_unaligned_be32(args->dev->zac_zones_optimal_open, &rbuf[8]);
2368         put_unaligned_be32(args->dev->zac_zones_optimal_nonseq, &rbuf[12]);
2369         put_unaligned_be32(args->dev->zac_zones_max_open, &rbuf[16]);
2370
2371         return 0;
2372 }
2373
2374 /**
2375  *      ata_scsiop_noop - Command handler that simply returns success.
2376  *      @args: device IDENTIFY data / SCSI command of interest.
2377  *      @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2378  *
2379  *      No operation.  Simply returns success to caller, to indicate
2380  *      that the caller should successfully complete this SCSI command.
2381  *
2382  *      LOCKING:
2383  *      spin_lock_irqsave(host lock)
2384  */
2385 static unsigned int ata_scsiop_noop(struct ata_scsi_args *args, u8 *rbuf)
2386 {
2387         VPRINTK("ENTER\n");
2388         return 0;
2389 }
2390
2391 /**
2392  *      modecpy - Prepare response for MODE SENSE
2393  *      @dest: output buffer
2394  *      @src: data being copied
2395  *      @n: length of mode page
2396  *      @changeable: whether changeable parameters are requested
2397  *
2398  *      Generate a generic MODE SENSE page for either current or changeable
2399  *      parameters.
2400  *
2401  *      LOCKING:
2402  *      None.
2403  */
2404 static void modecpy(u8 *dest, const u8 *src, int n, bool changeable)
2405 {
2406         if (changeable) {
2407                 memcpy(dest, src, 2);
2408                 memset(dest + 2, 0, n - 2);
2409         } else {
2410                 memcpy(dest, src, n);
2411         }
2412 }
2413
2414 /**
2415  *      ata_msense_caching - Simulate MODE SENSE caching info page
2416  *      @id: device IDENTIFY data
2417  *      @buf: output buffer
2418  *      @changeable: whether changeable parameters are requested
2419  *
2420  *      Generate a caching info page, which conditionally indicates
2421  *      write caching to the SCSI layer, depending on device
2422  *      capabilities.
2423  *
2424  *      LOCKING:
2425  *      None.
2426  */
2427 static unsigned int ata_msense_caching(u16 *id, u8 *buf, bool changeable)
2428 {
2429         modecpy(buf, def_cache_mpage, sizeof(def_cache_mpage), changeable);
2430         if (changeable) {
2431                 buf[2] |= (1 << 2);     /* ata_mselect_caching() */
2432         } else {
2433                 buf[2] |= (ata_id_wcache_enabled(id) << 2);     /* write cache enable */
2434                 buf[12] |= (!ata_id_rahead_enabled(id) << 5);   /* disable read ahead */
2435         }
2436         return sizeof(def_cache_mpage);
2437 }
2438
2439 /**
2440  *      ata_msense_control - Simulate MODE SENSE control mode page
2441  *      @dev: ATA device of interest
2442  *      @buf: output buffer
2443  *      @changeable: whether changeable parameters are requested
2444  *
2445  *      Generate a generic MODE SENSE control mode page.
2446  *
2447  *      LOCKING:
2448  *      None.
2449  */
2450 static unsigned int ata_msense_control(struct ata_device *dev, u8 *buf,
2451                                         bool changeable)
2452 {
2453         modecpy(buf, def_control_mpage, sizeof(def_control_mpage), changeable);
2454         if (changeable) {
2455                 buf[2] |= (1 << 2);     /* ata_mselect_control() */
2456         } else {
2457                 bool d_sense = (dev->flags & ATA_DFLAG_D_SENSE);
2458
2459                 buf[2] |= (d_sense << 2);       /* descriptor format sense data */
2460         }
2461         return sizeof(def_control_mpage);
2462 }
2463
2464 /**
2465  *      ata_msense_rw_recovery - Simulate MODE SENSE r/w error recovery page
2466  *      @buf: output buffer
2467  *      @changeable: whether changeable parameters are requested
2468  *
2469  *      Generate a generic MODE SENSE r/w error recovery page.
2470  *
2471  *      LOCKING:
2472  *      None.
2473  */
2474 static unsigned int ata_msense_rw_recovery(u8 *buf, bool changeable)
2475 {
2476         modecpy(buf, def_rw_recovery_mpage, sizeof(def_rw_recovery_mpage),
2477                 changeable);
2478         return sizeof(def_rw_recovery_mpage);
2479 }
2480
2481 /*
2482  * We can turn this into a real blacklist if it's needed, for now just
2483  * blacklist any Maxtor BANC1G10 revision firmware
2484  */
2485 static int ata_dev_supports_fua(u16 *id)
2486 {
2487         unsigned char model[ATA_ID_PROD_LEN + 1], fw[ATA_ID_FW_REV_LEN + 1];
2488
2489         if (!libata_fua)
2490                 return 0;
2491         if (!ata_id_has_fua(id))
2492                 return 0;
2493
2494         ata_id_c_string(id, model, ATA_ID_PROD, sizeof(model));
2495         ata_id_c_string(id, fw, ATA_ID_FW_REV, sizeof(fw));
2496
2497         if (strcmp(model, "Maxtor"))
2498                 return 1;
2499         if (strcmp(fw, "BANC1G10"))
2500                 return 1;
2501
2502         return 0; /* blacklisted */
2503 }
2504
2505 /**
2506  *      ata_scsiop_mode_sense - Simulate MODE SENSE 6, 10 commands
2507  *      @args: device IDENTIFY data / SCSI command of interest.
2508  *      @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2509  *
2510  *      Simulate MODE SENSE commands. Assume this is invoked for direct
2511  *      access devices (e.g. disks) only. There should be no block
2512  *      descriptor for other device types.
2513  *
2514  *      LOCKING:
2515  *      spin_lock_irqsave(host lock)
2516  */
2517 static unsigned int ata_scsiop_mode_sense(struct ata_scsi_args *args, u8 *rbuf)
2518 {
2519         struct ata_device *dev = args->dev;
2520         u8 *scsicmd = args->cmd->cmnd, *p = rbuf;
2521         const u8 sat_blk_desc[] = {
2522                 0, 0, 0, 0,     /* number of blocks: sat unspecified */
2523                 0,
2524                 0, 0x2, 0x0     /* block length: 512 bytes */
2525         };
2526         u8 pg, spg;
2527         unsigned int ebd, page_control, six_byte;
2528         u8 dpofua, bp = 0xff;
2529         u16 fp;
2530
2531         VPRINTK("ENTER\n");
2532
2533         six_byte = (scsicmd[0] == MODE_SENSE);
2534         ebd = !(scsicmd[1] & 0x8);      /* dbd bit inverted == edb */
2535         /*
2536          * LLBA bit in msense(10) ignored (compliant)
2537          */
2538
2539         page_control = scsicmd[2] >> 6;
2540         switch (page_control) {
2541         case 0: /* current */
2542         case 1: /* changeable */
2543         case 2: /* defaults */
2544                 break;  /* supported */
2545         case 3: /* saved */
2546                 goto saving_not_supp;
2547         default:
2548                 fp = 2;
2549                 bp = 6;
2550                 goto invalid_fld;
2551         }
2552
2553         if (six_byte)
2554                 p += 4 + (ebd ? 8 : 0);
2555         else
2556                 p += 8 + (ebd ? 8 : 0);
2557
2558         pg = scsicmd[2] & 0x3f;
2559         spg = scsicmd[3];
2560         /*
2561          * No mode subpages supported (yet) but asking for _all_
2562          * subpages may be valid
2563          */
2564         if (spg && (spg != ALL_SUB_MPAGES)) {
2565                 fp = 3;
2566                 goto invalid_fld;
2567         }
2568
2569         switch(pg) {
2570         case RW_RECOVERY_MPAGE:
2571                 p += ata_msense_rw_recovery(p, page_control == 1);
2572                 break;
2573
2574         case CACHE_MPAGE:
2575                 p += ata_msense_caching(args->id, p, page_control == 1);
2576                 break;
2577
2578         case CONTROL_MPAGE:
2579                 p += ata_msense_control(args->dev, p, page_control == 1);
2580                 break;
2581
2582         case ALL_MPAGES:
2583                 p += ata_msense_rw_recovery(p, page_control == 1);
2584                 p += ata_msense_caching(args->id, p, page_control == 1);
2585                 p += ata_msense_control(args->dev, p, page_control == 1);
2586                 break;
2587
2588         default:                /* invalid page code */
2589                 fp = 2;
2590                 goto invalid_fld;
2591         }
2592
2593         dpofua = 0;
2594         if (ata_dev_supports_fua(args->id) && (dev->flags & ATA_DFLAG_LBA48) &&
2595             (!(dev->flags & ATA_DFLAG_PIO) || dev->multi_count))
2596                 dpofua = 1 << 4;
2597
2598         if (six_byte) {
2599                 rbuf[0] = p - rbuf - 1;
2600                 rbuf[2] |= dpofua;
2601                 if (ebd) {
2602                         rbuf[3] = sizeof(sat_blk_desc);
2603                         memcpy(rbuf + 4, sat_blk_desc, sizeof(sat_blk_desc));
2604                 }
2605         } else {
2606                 unsigned int output_len = p - rbuf - 2;
2607
2608                 rbuf[0] = output_len >> 8;
2609                 rbuf[1] = output_len;
2610                 rbuf[3] |= dpofua;
2611                 if (ebd) {
2612                         rbuf[7] = sizeof(sat_blk_desc);
2613                         memcpy(rbuf + 8, sat_blk_desc, sizeof(sat_blk_desc));
2614                 }
2615         }
2616         return 0;
2617
2618 invalid_fld:
2619         ata_scsi_set_invalid_field(dev, args->cmd, fp, bp);
2620         return 1;
2621
2622 saving_not_supp:
2623         ata_scsi_set_sense(dev, args->cmd, ILLEGAL_REQUEST, 0x39, 0x0);
2624          /* "Saving parameters not supported" */
2625         return 1;
2626 }
2627
2628 /**
2629  *      ata_scsiop_read_cap - Simulate READ CAPACITY[ 16] commands
2630  *      @args: device IDENTIFY data / SCSI command of interest.
2631  *      @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2632  *
2633  *      Simulate READ CAPACITY commands.
2634  *
2635  *      LOCKING:
2636  *      None.
2637  */
2638 static unsigned int ata_scsiop_read_cap(struct ata_scsi_args *args, u8 *rbuf)
2639 {
2640         struct ata_device *dev = args->dev;
2641         u64 last_lba = dev->n_sectors - 1; /* LBA of the last block */
2642         u32 sector_size; /* physical sector size in bytes */
2643         u8 log2_per_phys;
2644         u16 lowest_aligned;
2645
2646         sector_size = ata_id_logical_sector_size(dev->id);
2647         log2_per_phys = ata_id_log2_per_physical_sector(dev->id);
2648         lowest_aligned = ata_id_logical_sector_offset(dev->id, log2_per_phys);
2649
2650         VPRINTK("ENTER\n");
2651
2652         if (args->cmd->cmnd[0] == READ_CAPACITY) {
2653                 if (last_lba >= 0xffffffffULL)
2654                         last_lba = 0xffffffff;
2655
2656                 /* sector count, 32-bit */
2657                 rbuf[0] = last_lba >> (8 * 3);
2658                 rbuf[1] = last_lba >> (8 * 2);
2659                 rbuf[2] = last_lba >> (8 * 1);
2660                 rbuf[3] = last_lba;
2661
2662                 /* sector size */
2663                 rbuf[4] = sector_size >> (8 * 3);
2664                 rbuf[5] = sector_size >> (8 * 2);
2665                 rbuf[6] = sector_size >> (8 * 1);
2666                 rbuf[7] = sector_size;
2667         } else {
2668                 /* sector count, 64-bit */
2669                 rbuf[0] = last_lba >> (8 * 7);
2670                 rbuf[1] = last_lba >> (8 * 6);
2671                 rbuf[2] = last_lba >> (8 * 5);
2672                 rbuf[3] = last_lba >> (8 * 4);
2673                 rbuf[4] = last_lba >> (8 * 3);
2674                 rbuf[5] = last_lba >> (8 * 2);
2675                 rbuf[6] = last_lba >> (8 * 1);
2676                 rbuf[7] = last_lba;
2677
2678                 /* sector size */
2679                 rbuf[ 8] = sector_size >> (8 * 3);
2680                 rbuf[ 9] = sector_size >> (8 * 2);
2681                 rbuf[10] = sector_size >> (8 * 1);
2682                 rbuf[11] = sector_size;
2683
2684                 rbuf[12] = 0;
2685                 rbuf[13] = log2_per_phys;
2686                 rbuf[14] = (lowest_aligned >> 8) & 0x3f;
2687                 rbuf[15] = lowest_aligned;
2688
2689                 if (ata_id_has_trim(args->id) &&
2690                     !(dev->horkage & ATA_HORKAGE_NOTRIM)) {
2691                         rbuf[14] |= 0x80; /* LBPME */
2692
2693                         if (ata_id_has_zero_after_trim(args->id) &&
2694                             dev->horkage & ATA_HORKAGE_ZERO_AFTER_TRIM) {
2695                                 ata_dev_info(dev, "Enabling discard_zeroes_data\n");
2696                                 rbuf[14] |= 0x40; /* LBPRZ */
2697                         }
2698                 }
2699                 if (ata_id_zoned_cap(args->id) ||
2700                     args->dev->class == ATA_DEV_ZAC)
2701                         rbuf[12] = (1 << 4); /* RC_BASIS */
2702         }
2703         return 0;
2704 }
2705
2706 /**
2707  *      ata_scsiop_report_luns - Simulate REPORT LUNS command
2708  *      @args: device IDENTIFY data / SCSI command of interest.
2709  *      @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2710  *
2711  *      Simulate REPORT LUNS command.
2712  *
2713  *      LOCKING:
2714  *      spin_lock_irqsave(host lock)
2715  */
2716 static unsigned int ata_scsiop_report_luns(struct ata_scsi_args *args, u8 *rbuf)
2717 {
2718         VPRINTK("ENTER\n");
2719         rbuf[3] = 8;    /* just one lun, LUN 0, size 8 bytes */
2720
2721         return 0;
2722 }
2723
2724 static void atapi_sense_complete(struct ata_queued_cmd *qc)
2725 {
2726         if (qc->err_mask && ((qc->err_mask & AC_ERR_DEV) == 0)) {
2727                 /* FIXME: not quite right; we don't want the
2728                  * translation of taskfile registers into
2729                  * a sense descriptors, since that's only
2730                  * correct for ATA, not ATAPI
2731                  */
2732                 ata_gen_passthru_sense(qc);
2733         }
2734
2735         ata_qc_done(qc);
2736 }
2737
2738 /* is it pointless to prefer PIO for "safety reasons"? */
2739 static inline int ata_pio_use_silly(struct ata_port *ap)
2740 {
2741         return (ap->flags & ATA_FLAG_PIO_DMA);
2742 }
2743
2744 static void atapi_request_sense(struct ata_queued_cmd *qc)
2745 {
2746         struct ata_port *ap = qc->ap;
2747         struct scsi_cmnd *cmd = qc->scsicmd;
2748
2749         DPRINTK("ATAPI request sense\n");
2750
2751         memset(cmd->sense_buffer, 0, SCSI_SENSE_BUFFERSIZE);
2752
2753 #ifdef CONFIG_ATA_SFF
2754         if (ap->ops->sff_tf_read)
2755                 ap->ops->sff_tf_read(ap, &qc->tf);
2756 #endif
2757
2758         /* fill these in, for the case where they are -not- overwritten */
2759         cmd->sense_buffer[0] = 0x70;
2760         cmd->sense_buffer[2] = qc->tf.feature >> 4;
2761
2762         ata_qc_reinit(qc);
2763
2764         /* setup sg table and init transfer direction */
2765         sg_init_one(&qc->sgent, cmd->sense_buffer, SCSI_SENSE_BUFFERSIZE);
2766         ata_sg_init(qc, &qc->sgent, 1);
2767         qc->dma_dir = DMA_FROM_DEVICE;
2768
2769         memset(&qc->cdb, 0, qc->dev->cdb_len);
2770         qc->cdb[0] = REQUEST_SENSE;
2771         qc->cdb[4] = SCSI_SENSE_BUFFERSIZE;
2772
2773         qc->tf.flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
2774         qc->tf.command = ATA_CMD_PACKET;
2775
2776         if (ata_pio_use_silly(ap)) {
2777                 qc->tf.protocol = ATAPI_PROT_DMA;
2778                 qc->tf.feature |= ATAPI_PKT_DMA;
2779         } else {
2780                 qc->tf.protocol = ATAPI_PROT_PIO;
2781                 qc->tf.lbam = SCSI_SENSE_BUFFERSIZE;
2782                 qc->tf.lbah = 0;
2783         }
2784         qc->nbytes = SCSI_SENSE_BUFFERSIZE;
2785
2786         qc->complete_fn = atapi_sense_complete;
2787
2788         ata_qc_issue(qc);
2789
2790         DPRINTK("EXIT\n");
2791 }
2792
2793 static void atapi_qc_complete(struct ata_queued_cmd *qc)
2794 {
2795         struct scsi_cmnd *cmd = qc->scsicmd;
2796         unsigned int err_mask = qc->err_mask;
2797
2798         VPRINTK("ENTER, err_mask 0x%X\n", err_mask);
2799
2800         /* handle completion from new EH */
2801         if (unlikely(qc->ap->ops->error_handler &&
2802                      (err_mask || qc->flags & ATA_QCFLAG_SENSE_VALID))) {
2803
2804                 if (!(qc->flags & ATA_QCFLAG_SENSE_VALID)) {
2805                         /* FIXME: not quite right; we don't want the
2806                          * translation of taskfile registers into a
2807                          * sense descriptors, since that's only
2808                          * correct for ATA, not ATAPI
2809                          */
2810                         ata_gen_passthru_sense(qc);
2811                 }
2812
2813                 /* SCSI EH automatically locks door if sdev->locked is
2814                  * set.  Sometimes door lock request continues to
2815                  * fail, for example, when no media is present.  This
2816                  * creates a loop - SCSI EH issues door lock which
2817                  * fails and gets invoked again to acquire sense data
2818                  * for the failed command.
2819                  *
2820                  * If door lock fails, always clear sdev->locked to
2821                  * avoid this infinite loop.
2822                  *
2823                  * This may happen before SCSI scan is complete.  Make
2824                  * sure qc->dev->sdev isn't NULL before dereferencing.
2825                  */
2826                 if (qc->cdb[0] == ALLOW_MEDIUM_REMOVAL && qc->dev->sdev)
2827                         qc->dev->sdev->locked = 0;
2828
2829                 qc->scsicmd->result = SAM_STAT_CHECK_CONDITION;
2830                 ata_qc_done(qc);
2831                 return;
2832         }
2833
2834         /* successful completion or old EH failure path */
2835         if (unlikely(err_mask & AC_ERR_DEV)) {
2836                 cmd->result = SAM_STAT_CHECK_CONDITION;
2837                 atapi_request_sense(qc);
2838                 return;
2839         } else if (unlikely(err_mask)) {
2840                 /* FIXME: not quite right; we don't want the
2841                  * translation of taskfile registers into
2842                  * a sense descriptors, since that's only
2843                  * correct for ATA, not ATAPI
2844                  */
2845                 ata_gen_passthru_sense(qc);
2846         } else {
2847                 u8 *scsicmd = cmd->cmnd;
2848
2849                 if ((scsicmd[0] == INQUIRY) && ((scsicmd[1] & 0x03) == 0)) {
2850                         unsigned long flags;
2851                         u8 *buf;
2852
2853                         buf = ata_scsi_rbuf_get(cmd, true, &flags);
2854
2855         /* ATAPI devices typically report zero for their SCSI version,
2856          * and sometimes deviate from the spec WRT response data
2857          * format.  If SCSI version is reported as zero like normal,
2858          * then we make the following fixups:  1) Fake MMC-5 version,
2859          * to indicate to the Linux scsi midlayer this is a modern
2860          * device.  2) Ensure response data format / ATAPI information
2861          * are always correct.
2862          */
2863                         if (buf[2] == 0) {
2864                                 buf[2] = 0x5;
2865                                 buf[3] = 0x32;
2866                         }
2867
2868                         ata_scsi_rbuf_put(cmd, true, &flags);
2869                 }
2870
2871                 cmd->result = SAM_STAT_GOOD;
2872         }
2873
2874         ata_qc_done(qc);
2875 }
2876 /**
2877  *      atapi_xlat - Initialize PACKET taskfile
2878  *      @qc: command structure to be initialized
2879  *
2880  *      LOCKING:
2881  *      spin_lock_irqsave(host lock)
2882  *
2883  *      RETURNS:
2884  *      Zero on success, non-zero on failure.
2885  */
2886 static unsigned int atapi_xlat(struct ata_queued_cmd *qc)
2887 {
2888         struct scsi_cmnd *scmd = qc->scsicmd;
2889         struct ata_device *dev = qc->dev;
2890         int nodata = (scmd->sc_data_direction == DMA_NONE);
2891         int using_pio = !nodata && (dev->flags & ATA_DFLAG_PIO);
2892         unsigned int nbytes;
2893
2894         memset(qc->cdb, 0, dev->cdb_len);
2895         memcpy(qc->cdb, scmd->cmnd, scmd->cmd_len);
2896
2897         qc->complete_fn = atapi_qc_complete;
2898
2899         qc->tf.flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
2900         if (scmd->sc_data_direction == DMA_TO_DEVICE) {
2901                 qc->tf.flags |= ATA_TFLAG_WRITE;
2902                 DPRINTK("direction: write\n");
2903         }
2904
2905         qc->tf.command = ATA_CMD_PACKET;
2906         ata_qc_set_pc_nbytes(qc);
2907
2908         /* check whether ATAPI DMA is safe */
2909         if (!nodata && !using_pio && atapi_check_dma(qc))
2910                 using_pio = 1;
2911
2912         /* Some controller variants snoop this value for Packet
2913          * transfers to do state machine and FIFO management.  Thus we
2914          * want to set it properly, and for DMA where it is
2915          * effectively meaningless.
2916          */
2917         nbytes = min(ata_qc_raw_nbytes(qc), (unsigned int)63 * 1024);
2918
2919         /* Most ATAPI devices which honor transfer chunk size don't
2920          * behave according to the spec when odd chunk size which
2921          * matches the transfer length is specified.  If the number of
2922          * bytes to transfer is 2n+1.  According to the spec, what
2923          * should happen is to indicate that 2n+1 is going to be
2924          * transferred and transfer 2n+2 bytes where the last byte is
2925          * padding.
2926          *
2927          * In practice, this doesn't happen.  ATAPI devices first
2928          * indicate and transfer 2n bytes and then indicate and
2929          * transfer 2 bytes where the last byte is padding.
2930          *
2931          * This inconsistency confuses several controllers which
2932          * perform PIO using DMA such as Intel AHCIs and sil3124/32.
2933          * These controllers use actual number of transferred bytes to
2934          * update DMA poitner and transfer of 4n+2 bytes make those
2935          * controller push DMA pointer by 4n+4 bytes because SATA data
2936          * FISes are aligned to 4 bytes.  This causes data corruption
2937          * and buffer overrun.
2938          *
2939          * Always setting nbytes to even number solves this problem
2940          * because then ATAPI devices don't have to split data at 2n
2941          * boundaries.
2942          */
2943         if (nbytes & 0x1)
2944                 nbytes++;
2945
2946         qc->tf.lbam = (nbytes & 0xFF);
2947         qc->tf.lbah = (nbytes >> 8);
2948
2949         if (nodata)
2950                 qc->tf.protocol = ATAPI_PROT_NODATA;
2951         else if (using_pio)
2952                 qc->tf.protocol = ATAPI_PROT_PIO;
2953         else {
2954                 /* DMA data xfer */
2955                 qc->tf.protocol = ATAPI_PROT_DMA;
2956                 qc->tf.feature |= ATAPI_PKT_DMA;
2957
2958                 if ((dev->flags & ATA_DFLAG_DMADIR) &&
2959                     (scmd->sc_data_direction != DMA_TO_DEVICE))
2960                         /* some SATA bridges need us to indicate data xfer direction */
2961                         qc->tf.feature |= ATAPI_DMADIR;
2962         }
2963
2964
2965         /* FIXME: We need to translate 0x05 READ_BLOCK_LIMITS to a MODE_SENSE
2966            as ATAPI tape drives don't get this right otherwise */
2967         return 0;
2968 }
2969
2970 static struct ata_device *ata_find_dev(struct ata_port *ap, int devno)
2971 {
2972         if (!sata_pmp_attached(ap)) {
2973                 if (likely(devno < ata_link_max_devices(&ap->link)))
2974                         return &ap->link.device[devno];
2975         } else {
2976                 if (likely(devno < ap->nr_pmp_links))
2977                         return &ap->pmp_link[devno].device[0];
2978         }
2979
2980         return NULL;
2981 }
2982
2983 static struct ata_device *__ata_scsi_find_dev(struct ata_port *ap,
2984                                               const struct scsi_device *scsidev)
2985 {
2986         int devno;
2987
2988         /* skip commands not addressed to targets we simulate */
2989         if (!sata_pmp_attached(ap)) {
2990                 if (unlikely(scsidev->channel || scsidev->lun))
2991                         return NULL;
2992                 devno = scsidev->id;
2993         } else {
2994                 if (unlikely(scsidev->id || scsidev->lun))
2995                         return NULL;
2996                 devno = scsidev->channel;
2997         }
2998
2999         return ata_find_dev(ap, devno);
3000 }
3001
3002 /**
3003  *      ata_scsi_find_dev - lookup ata_device from scsi_cmnd
3004  *      @ap: ATA port to which the device is attached
3005  *      @scsidev: SCSI device from which we derive the ATA device
3006  *
3007  *      Given various information provided in struct scsi_cmnd,
3008  *      map that onto an ATA bus, and using that mapping
3009  *      determine which ata_device is associated with the
3010  *      SCSI command to be sent.
3011  *
3012  *      LOCKING:
3013  *      spin_lock_irqsave(host lock)
3014  *
3015  *      RETURNS:
3016  *      Associated ATA device, or %NULL if not found.
3017  */
3018 static struct ata_device *
3019 ata_scsi_find_dev(struct ata_port *ap, const struct scsi_device *scsidev)
3020 {
3021         struct ata_device *dev = __ata_scsi_find_dev(ap, scsidev);
3022
3023         if (unlikely(!dev || !ata_dev_enabled(dev)))
3024                 return NULL;
3025
3026         return dev;
3027 }
3028
3029 /*
3030  *      ata_scsi_map_proto - Map pass-thru protocol value to taskfile value.
3031  *      @byte1: Byte 1 from pass-thru CDB.
3032  *
3033  *      RETURNS:
3034  *      ATA_PROT_UNKNOWN if mapping failed/unimplemented, protocol otherwise.
3035  */
3036 static u8
3037 ata_scsi_map_proto(u8 byte1)
3038 {
3039         switch((byte1 & 0x1e) >> 1) {
3040         case 3:         /* Non-data */
3041                 return ATA_PROT_NODATA;
3042
3043         case 6:         /* DMA */
3044         case 10:        /* UDMA Data-in */
3045         case 11:        /* UDMA Data-Out */
3046                 return ATA_PROT_DMA;
3047
3048         case 4:         /* PIO Data-in */
3049         case 5:         /* PIO Data-out */
3050                 return ATA_PROT_PIO;
3051
3052         case 12:        /* FPDMA */
3053                 return ATA_PROT_NCQ;
3054
3055         case 0:         /* Hard Reset */
3056         case 1:         /* SRST */
3057         case 8:         /* Device Diagnostic */
3058         case 9:         /* Device Reset */
3059         case 7:         /* DMA Queued */
3060         case 15:        /* Return Response Info */
3061         default:        /* Reserved */
3062                 break;
3063         }
3064
3065         return ATA_PROT_UNKNOWN;
3066 }
3067
3068 /**
3069  *      ata_scsi_pass_thru - convert ATA pass-thru CDB to taskfile
3070  *      @qc: command structure to be initialized
3071  *
3072  *      Handles either 12 or 16-byte versions of the CDB.
3073  *
3074  *      RETURNS:
3075  *      Zero on success, non-zero on failure.
3076  */
3077 static unsigned int ata_scsi_pass_thru(struct ata_queued_cmd *qc)
3078 {
3079         struct ata_taskfile *tf = &(qc->tf);
3080         struct scsi_cmnd *scmd = qc->scsicmd;
3081         struct ata_device *dev = qc->dev;
3082         const u8 *cdb = scmd->cmnd;
3083         u16 fp;
3084
3085         if ((tf->protocol = ata_scsi_map_proto(cdb[1])) == ATA_PROT_UNKNOWN) {
3086                 fp = 1;
3087                 goto invalid_fld;
3088         }
3089
3090         if (ata_is_ncq(tf->protocol) && (cdb[2] & 0x3) == 0)
3091                 tf->protocol = ATA_PROT_NCQ_NODATA;
3092
3093         /* enable LBA */
3094         tf->flags |= ATA_TFLAG_LBA;
3095
3096         /*
3097          * 12 and 16 byte CDBs use different offsets to
3098          * provide the various register values.
3099          */
3100         if (cdb[0] == ATA_16) {
3101                 /*
3102                  * 16-byte CDB - may contain extended commands.
3103                  *
3104                  * If that is the case, copy the upper byte register values.
3105                  */
3106                 if (cdb[1] & 0x01) {
3107                         tf->hob_feature = cdb[3];
3108                         tf->hob_nsect = cdb[5];
3109                         tf->hob_lbal = cdb[7];
3110                         tf->hob_lbam = cdb[9];
3111                         tf->hob_lbah = cdb[11];
3112                         tf->flags |= ATA_TFLAG_LBA48;
3113                 } else
3114                         tf->flags &= ~ATA_TFLAG_LBA48;
3115
3116                 /*
3117                  * Always copy low byte, device and command registers.
3118                  */
3119                 tf->feature = cdb[4];
3120                 tf->nsect = cdb[6];
3121                 tf->lbal = cdb[8];
3122                 tf->lbam = cdb[10];
3123                 tf->lbah = cdb[12];
3124                 tf->device = cdb[13];
3125                 tf->command = cdb[14];
3126         } else {
3127                 /*
3128                  * 12-byte CDB - incapable of extended commands.
3129                  */
3130                 tf->flags &= ~ATA_TFLAG_LBA48;
3131
3132                 tf->feature = cdb[3];
3133                 tf->nsect = cdb[4];
3134                 tf->lbal = cdb[5];
3135                 tf->lbam = cdb[6];
3136                 tf->lbah = cdb[7];
3137                 tf->device = cdb[8];
3138                 tf->command = cdb[9];
3139         }
3140
3141         /* For NCQ commands copy the tag value */
3142         if (ata_is_ncq(tf->protocol))
3143                 tf->nsect = qc->tag << 3;
3144
3145         /* enforce correct master/slave bit */
3146         tf->device = dev->devno ?
3147                 tf->device | ATA_DEV1 : tf->device & ~ATA_DEV1;
3148
3149         switch (tf->command) {
3150         /* READ/WRITE LONG use a non-standard sect_size */
3151         case ATA_CMD_READ_LONG:
3152         case ATA_CMD_READ_LONG_ONCE:
3153         case ATA_CMD_WRITE_LONG:
3154         case ATA_CMD_WRITE_LONG_ONCE:
3155                 if (tf->protocol != ATA_PROT_PIO || tf->nsect != 1) {
3156                         fp = 1;
3157                         goto invalid_fld;
3158                 }
3159                 qc->sect_size = scsi_bufflen(scmd);
3160                 break;
3161
3162         /* commands using reported Logical Block size (e.g. 512 or 4K) */
3163         case ATA_CMD_CFA_WRITE_NE:
3164         case ATA_CMD_CFA_TRANS_SECT:
3165         case ATA_CMD_CFA_WRITE_MULT_NE:
3166         /* XXX: case ATA_CMD_CFA_WRITE_SECTORS_WITHOUT_ERASE: */
3167         case ATA_CMD_READ:
3168         case ATA_CMD_READ_EXT:
3169         case ATA_CMD_READ_QUEUED:
3170         /* XXX: case ATA_CMD_READ_QUEUED_EXT: */
3171         case ATA_CMD_FPDMA_READ:
3172         case ATA_CMD_READ_MULTI:
3173         case ATA_CMD_READ_MULTI_EXT:
3174         case ATA_CMD_PIO_READ:
3175         case ATA_CMD_PIO_READ_EXT:
3176         case ATA_CMD_READ_STREAM_DMA_EXT:
3177         case ATA_CMD_READ_STREAM_EXT:
3178         case ATA_CMD_VERIFY:
3179         case ATA_CMD_VERIFY_EXT:
3180         case ATA_CMD_WRITE:
3181         case ATA_CMD_WRITE_EXT:
3182         case ATA_CMD_WRITE_FUA_EXT:
3183         case ATA_CMD_WRITE_QUEUED:
3184         case ATA_CMD_WRITE_QUEUED_FUA_EXT:
3185         case ATA_CMD_FPDMA_WRITE:
3186         case ATA_CMD_WRITE_MULTI:
3187         case ATA_CMD_WRITE_MULTI_EXT:
3188         case ATA_CMD_WRITE_MULTI_FUA_EXT:
3189         case ATA_CMD_PIO_WRITE:
3190         case ATA_CMD_PIO_WRITE_EXT:
3191         case ATA_CMD_WRITE_STREAM_DMA_EXT:
3192         case ATA_CMD_WRITE_STREAM_EXT:
3193                 qc->sect_size = scmd->device->sector_size;
3194                 break;
3195
3196         /* Everything else uses 512 byte "sectors" */
3197         default:
3198                 qc->sect_size = ATA_SECT_SIZE;
3199         }
3200
3201         /*
3202          * Set flags so that all registers will be written, pass on
3203          * write indication (used for PIO/DMA setup), result TF is
3204          * copied back and we don't whine too much about its failure.
3205          */
3206         tf->flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
3207         if (scmd->sc_data_direction == DMA_TO_DEVICE)
3208                 tf->flags |= ATA_TFLAG_WRITE;
3209
3210         qc->flags |= ATA_QCFLAG_RESULT_TF | ATA_QCFLAG_QUIET;
3211
3212         /*
3213          * Set transfer length.
3214          *
3215          * TODO: find out if we need to do more here to
3216          *       cover scatter/gather case.
3217          */
3218         ata_qc_set_pc_nbytes(qc);
3219
3220         /* We may not issue DMA commands if no DMA mode is set */
3221         if (tf->protocol == ATA_PROT_DMA && dev->dma_mode == 0) {
3222                 fp = 1;
3223                 goto invalid_fld;
3224         }
3225
3226         /* sanity check for pio multi commands */
3227         if ((cdb[1] & 0xe0) && !is_multi_taskfile(tf)) {
3228                 fp = 1;
3229                 goto invalid_fld;
3230         }
3231
3232         if (is_multi_taskfile(tf)) {
3233                 unsigned int multi_count = 1 << (cdb[1] >> 5);
3234
3235                 /* compare the passed through multi_count
3236                  * with the cached multi_count of libata
3237                  */
3238                 if (multi_count != dev->multi_count)
3239                         ata_dev_warn(dev, "invalid multi_count %u ignored\n",
3240                                      multi_count);
3241         }
3242
3243         /*
3244          * Filter SET_FEATURES - XFER MODE command -- otherwise,
3245          * SET_FEATURES - XFER MODE must be preceded/succeeded
3246          * by an update to hardware-specific registers for each
3247          * controller (i.e. the reason for ->set_piomode(),
3248          * ->set_dmamode(), and ->post_set_mode() hooks).
3249          */
3250         if (tf->command == ATA_CMD_SET_FEATURES &&
3251             tf->feature == SETFEATURES_XFER) {
3252                 fp = (cdb[0] == ATA_16) ? 4 : 3;
3253                 goto invalid_fld;
3254         }
3255
3256         /*
3257          * Filter TPM commands by default. These provide an
3258          * essentially uncontrolled encrypted "back door" between
3259          * applications and the disk. Set libata.allow_tpm=1 if you
3260          * have a real reason for wanting to use them. This ensures
3261          * that installed software cannot easily mess stuff up without
3262          * user intent. DVR type users will probably ship with this enabled
3263          * for movie content management.
3264          *
3265          * Note that for ATA8 we can issue a DCS change and DCS freeze lock
3266          * for this and should do in future but that it is not sufficient as
3267          * DCS is an optional feature set. Thus we also do the software filter
3268          * so that we comply with the TC consortium stated goal that the user
3269          * can turn off TC features of their system.
3270          */
3271         if (tf->command >= 0x5C && tf->command <= 0x5F && !libata_allow_tpm) {
3272                 fp = (cdb[0] == ATA_16) ? 14 : 9;
3273                 goto invalid_fld;
3274         }
3275
3276         return 0;
3277
3278  invalid_fld:
3279         ata_scsi_set_invalid_field(dev, scmd, fp, 0xff);
3280         return 1;
3281 }
3282
3283 /**
3284  * ata_format_dsm_trim_descr() - SATL Write Same to DSM Trim
3285  * @cmd: SCSI command being translated
3286  * @trmax: Maximum number of entries that will fit in sector_size bytes.
3287  * @sector: Starting sector
3288  * @count: Total Range of request in logical sectors
3289  *
3290  * Rewrite the WRITE SAME descriptor to be a DSM TRIM little-endian formatted
3291  * descriptor.
3292  *
3293  * Upto 64 entries of the format:
3294  *   63:48 Range Length
3295  *   47:0  LBA
3296  *
3297  *  Range Length of 0 is ignored.
3298  *  LBA's should be sorted order and not overlap.
3299  *
3300  * NOTE: this is the same format as ADD LBA(S) TO NV CACHE PINNED SET
3301  *
3302  * Return: Number of bytes copied into sglist.
3303  */
3304 static size_t ata_format_dsm_trim_descr(struct scsi_cmnd *cmd, u32 trmax,
3305                                         u64 sector, u32 count)
3306 {
3307         struct scsi_device *sdp = cmd->device;
3308         size_t len = sdp->sector_size;
3309         size_t r;
3310         __le64 *buf;
3311         u32 i = 0;
3312         unsigned long flags;
3313
3314         WARN_ON(len > ATA_SCSI_RBUF_SIZE);
3315
3316         if (len > ATA_SCSI_RBUF_SIZE)
3317                 len = ATA_SCSI_RBUF_SIZE;
3318
3319         spin_lock_irqsave(&ata_scsi_rbuf_lock, flags);
3320         buf = ((void *)ata_scsi_rbuf);
3321         memset(buf, 0, len);
3322         while (i < trmax) {
3323                 u64 entry = sector |
3324                         ((u64)(count > 0xffff ? 0xffff : count) << 48);
3325                 buf[i++] = __cpu_to_le64(entry);
3326                 if (count <= 0xffff)
3327                         break;
3328                 count -= 0xffff;
3329                 sector += 0xffff;
3330         }
3331         r = sg_copy_from_buffer(scsi_sglist(cmd), scsi_sg_count(cmd), buf, len);
3332         spin_unlock_irqrestore(&ata_scsi_rbuf_lock, flags);
3333
3334         return r;
3335 }
3336
3337 /**
3338  * ata_format_dsm_trim_descr() - SATL Write Same to ATA SCT Write Same
3339  * @cmd: SCSI command being translated
3340  * @lba: Starting sector
3341  * @num: Number of sectors to be zero'd.
3342  *
3343  * Rewrite the WRITE SAME payload to be an SCT Write Same formatted
3344  * descriptor.
3345  * NOTE: Writes a pattern (0's) in the foreground.
3346  *
3347  * Return: Number of bytes copied into sglist.
3348  */
3349 static size_t ata_format_sct_write_same(struct scsi_cmnd *cmd, u64 lba, u64 num)
3350 {
3351         struct scsi_device *sdp = cmd->device;
3352         size_t len = sdp->sector_size;
3353         size_t r;
3354         u16 *buf;
3355         unsigned long flags;
3356
3357         spin_lock_irqsave(&ata_scsi_rbuf_lock, flags);
3358         buf = ((void *)ata_scsi_rbuf);
3359
3360         put_unaligned_le16(0x0002,  &buf[0]); /* SCT_ACT_WRITE_SAME */
3361         put_unaligned_le16(0x0101,  &buf[1]); /* WRITE PTRN FG */
3362         put_unaligned_le64(lba,     &buf[2]);
3363         put_unaligned_le64(num,     &buf[6]);
3364         put_unaligned_le32(0u,      &buf[10]); /* pattern */
3365
3366         WARN_ON(len > ATA_SCSI_RBUF_SIZE);
3367
3368         if (len > ATA_SCSI_RBUF_SIZE)
3369                 len = ATA_SCSI_RBUF_SIZE;
3370
3371         r = sg_copy_from_buffer(scsi_sglist(cmd), scsi_sg_count(cmd), buf, len);
3372         spin_unlock_irqrestore(&ata_scsi_rbuf_lock, flags);
3373
3374         return r;
3375 }
3376
3377 /**
3378  * ata_scsi_write_same_xlat() - SATL Write Same to ATA SCT Write Same
3379  * @qc: Command to be translated
3380  *
3381  * Translate a SCSI WRITE SAME command to be either a DSM TRIM command or
3382  * an SCT Write Same command.
3383  * Based on WRITE SAME has the UNMAP flag
3384  *   When set translate to DSM TRIM
3385  *   When clear translate to SCT Write Same
3386  */
3387 static unsigned int ata_scsi_write_same_xlat(struct ata_queued_cmd *qc)
3388 {
3389         struct ata_taskfile *tf = &qc->tf;
3390         struct scsi_cmnd *scmd = qc->scsicmd;
3391         struct scsi_device *sdp = scmd->device;
3392         size_t len = sdp->sector_size;
3393         struct ata_device *dev = qc->dev;
3394         const u8 *cdb = scmd->cmnd;
3395         u64 block;
3396         u32 n_block;
3397         const u32 trmax = len >> 3;
3398         u32 size;
3399         u16 fp;
3400         u8 bp = 0xff;
3401         u8 unmap = cdb[1] & 0x8;
3402
3403         /* we may not issue DMA commands if no DMA mode is set */
3404         if (unlikely(!dev->dma_mode))
3405                 goto invalid_opcode;
3406
3407         if (unlikely(scmd->cmd_len < 16)) {
3408                 fp = 15;
3409                 goto invalid_fld;
3410         }
3411         scsi_16_lba_len(cdb, &block, &n_block);
3412
3413         if (unmap) {
3414                 /* If trim is not enabled the cmd is invalid. */
3415                 if ((dev->horkage & ATA_HORKAGE_NOTRIM) ||
3416                     !ata_id_has_trim(dev->id)) {
3417                         fp = 1;
3418                         bp = 3;
3419                         goto invalid_fld;
3420                 }
3421                 /* If the request is too large the cmd is invalid */
3422                 if (n_block > 0xffff * trmax) {
3423                         fp = 2;
3424                         goto invalid_fld;
3425                 }
3426         } else {
3427                 /* If write same is not available the cmd is invalid */
3428                 if (!ata_id_sct_write_same(dev->id)) {
3429                         fp = 1;
3430                         bp = 3;
3431                         goto invalid_fld;
3432                 }
3433         }
3434
3435         /*
3436          * WRITE SAME always has a sector sized buffer as payload, this
3437          * should never be a multiple entry S/G list.
3438          */
3439         if (!scsi_sg_count(scmd))
3440                 goto invalid_param_len;
3441
3442         /*
3443          * size must match sector size in bytes
3444          * For DATA SET MANAGEMENT TRIM in ACS-2 nsect (aka count)
3445          * is defined as number of 512 byte blocks to be transferred.
3446          */
3447         if (unmap) {
3448                 size = ata_format_dsm_trim_descr(scmd, trmax, block, n_block);
3449                 if (size != len)
3450                         goto invalid_param_len;
3451
3452                 if (ata_ncq_enabled(dev) && ata_fpdma_dsm_supported(dev)) {
3453                         /* Newer devices support queued TRIM commands */
3454                         tf->protocol = ATA_PROT_NCQ;
3455                         tf->command = ATA_CMD_FPDMA_SEND;
3456                         tf->hob_nsect = ATA_SUBCMD_FPDMA_SEND_DSM & 0x1f;
3457                         tf->nsect = qc->tag << 3;
3458                         tf->hob_feature = (size / 512) >> 8;
3459                         tf->feature = size / 512;
3460
3461                         tf->auxiliary = 1;
3462                 } else {
3463                         tf->protocol = ATA_PROT_DMA;
3464                         tf->hob_feature = 0;
3465                         tf->feature = ATA_DSM_TRIM;
3466                         tf->hob_nsect = (size / 512) >> 8;
3467                         tf->nsect = size / 512;
3468                         tf->command = ATA_CMD_DSM;
3469                 }
3470         } else {
3471                 size = ata_format_sct_write_same(scmd, block, n_block);
3472                 if (size != len)
3473                         goto invalid_param_len;
3474
3475                 tf->hob_feature = 0;
3476                 tf->feature = 0;
3477                 tf->hob_nsect = 0;
3478                 tf->nsect = 1;
3479                 tf->lbah = 0;
3480                 tf->lbam = 0;
3481                 tf->lbal = ATA_CMD_STANDBYNOW1;
3482                 tf->hob_lbah = 0;
3483                 tf->hob_lbam = 0;
3484                 tf->hob_lbal = 0;
3485                 tf->device = ATA_CMD_STANDBYNOW1;
3486                 tf->protocol = ATA_PROT_DMA;
3487                 tf->command = ATA_CMD_WRITE_LOG_DMA_EXT;
3488                 if (unlikely(dev->flags & ATA_DFLAG_PIO))
3489                         tf->command = ATA_CMD_WRITE_LOG_EXT;
3490         }
3491
3492         tf->flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE | ATA_TFLAG_LBA48 |
3493                      ATA_TFLAG_WRITE;
3494
3495         ata_qc_set_pc_nbytes(qc);
3496
3497         return 0;
3498
3499 invalid_fld:
3500         ata_scsi_set_invalid_field(dev, scmd, fp, bp);
3501         return 1;
3502 invalid_param_len:
3503         /* "Parameter list length error" */
3504         ata_scsi_set_sense(dev, scmd, ILLEGAL_REQUEST, 0x1a, 0x0);
3505         return 1;
3506 invalid_opcode:
3507         /* "Invalid command operation code" */
3508         ata_scsi_set_sense(dev, scmd, ILLEGAL_REQUEST, 0x20, 0x0);
3509         return 1;
3510 }
3511
3512 /**
3513  *      ata_scsiop_maint_in - Simulate a subset of MAINTENANCE_IN
3514  *      @args: device MAINTENANCE_IN data / SCSI command of interest.
3515  *      @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
3516  *
3517  *      Yields a subset to satisfy scsi_report_opcode()
3518  *
3519  *      LOCKING:
3520  *      spin_lock_irqsave(host lock)
3521  */
3522 static unsigned int ata_scsiop_maint_in(struct ata_scsi_args *args, u8 *rbuf)
3523 {
3524         struct ata_device *dev = args->dev;
3525         u8 *cdb = args->cmd->cmnd;
3526         u8 supported = 0;
3527         unsigned int err = 0;
3528
3529         if (cdb[2] != 1) {
3530                 ata_dev_warn(dev, "invalid command format %d\n", cdb[2]);
3531                 err = 2;
3532                 goto out;
3533         }
3534         switch (cdb[3]) {
3535         case INQUIRY:
3536         case MODE_SENSE:
3537         case MODE_SENSE_10:
3538         case READ_CAPACITY:
3539         case SERVICE_ACTION_IN_16:
3540         case REPORT_LUNS:
3541         case REQUEST_SENSE:
3542         case SYNCHRONIZE_CACHE:
3543         case REZERO_UNIT:
3544         case SEEK_6:
3545         case SEEK_10:
3546         case TEST_UNIT_READY:
3547         case SEND_DIAGNOSTIC:
3548         case MAINTENANCE_IN:
3549         case READ_6:
3550         case READ_10:
3551         case READ_16:
3552         case WRITE_6:
3553         case WRITE_10:
3554         case WRITE_16:
3555         case ATA_12:
3556         case ATA_16:
3557         case VERIFY:
3558         case VERIFY_16:
3559         case MODE_SELECT:
3560         case MODE_SELECT_10:
3561         case START_STOP:
3562                 supported = 3;
3563                 break;
3564         case WRITE_SAME_16:
3565                 if (!ata_id_sct_write_same(dev->id))
3566                         break;
3567                 /* fallthrough: if SCT ... only enable for ZBC */
3568         case ZBC_IN:
3569         case ZBC_OUT:
3570                 if (ata_id_zoned_cap(dev->id) ||
3571                     dev->class == ATA_DEV_ZAC)
3572                         supported = 3;
3573                 break;
3574         default:
3575                 break;
3576         }
3577 out:
3578         rbuf[1] = supported; /* supported */
3579         return err;
3580 }
3581
3582 /**
3583  *      ata_scsi_report_zones_complete - convert ATA output
3584  *      @qc: command structure returning the data
3585  *
3586  *      Convert T-13 little-endian field representation into
3587  *      T-10 big-endian field representation.
3588  *      What a mess.
3589  */
3590 static void ata_scsi_report_zones_complete(struct ata_queued_cmd *qc)
3591 {
3592         struct scsi_cmnd *scmd = qc->scsicmd;
3593         struct sg_mapping_iter miter;
3594         unsigned long flags;
3595         unsigned int bytes = 0;
3596
3597         sg_miter_start(&miter, scsi_sglist(scmd), scsi_sg_count(scmd),
3598                        SG_MITER_TO_SG | SG_MITER_ATOMIC);
3599
3600         local_irq_save(flags);
3601         while (sg_miter_next(&miter)) {
3602                 unsigned int offset = 0;
3603
3604                 if (bytes == 0) {
3605                         char *hdr;
3606                         u32 list_length;
3607                         u64 max_lba, opt_lba;
3608                         u16 same;
3609
3610                         /* Swizzle header */
3611                         hdr = miter.addr;
3612                         list_length = get_unaligned_le32(&hdr[0]);
3613                         same = get_unaligned_le16(&hdr[4]);
3614                         max_lba = get_unaligned_le64(&hdr[8]);
3615                         opt_lba = get_unaligned_le64(&hdr[16]);
3616                         put_unaligned_be32(list_length, &hdr[0]);
3617                         hdr[4] = same & 0xf;
3618                         put_unaligned_be64(max_lba, &hdr[8]);
3619                         put_unaligned_be64(opt_lba, &hdr[16]);
3620                         offset += 64;
3621                         bytes += 64;
3622                 }
3623                 while (offset < miter.length) {
3624                         char *rec;
3625                         u8 cond, type, non_seq, reset;
3626                         u64 size, start, wp;
3627
3628                         /* Swizzle zone descriptor */
3629                         rec = miter.addr + offset;
3630                         type = rec[0] & 0xf;
3631                         cond = (rec[1] >> 4) & 0xf;
3632                         non_seq = (rec[1] & 2);
3633                         reset = (rec[1] & 1);
3634                         size = get_unaligned_le64(&rec[8]);
3635                         start = get_unaligned_le64(&rec[16]);
3636                         wp = get_unaligned_le64(&rec[24]);
3637                         rec[0] = type;
3638                         rec[1] = (cond << 4) | non_seq | reset;
3639                         put_unaligned_be64(size, &rec[8]);
3640                         put_unaligned_be64(start, &rec[16]);
3641                         put_unaligned_be64(wp, &rec[24]);
3642                         WARN_ON(offset + 64 > miter.length);
3643                         offset += 64;
3644                         bytes += 64;
3645                 }
3646         }
3647         sg_miter_stop(&miter);
3648         local_irq_restore(flags);
3649
3650         ata_scsi_qc_complete(qc);
3651 }
3652
3653 static unsigned int ata_scsi_zbc_in_xlat(struct ata_queued_cmd *qc)
3654 {
3655         struct ata_taskfile *tf = &qc->tf;
3656         struct scsi_cmnd *scmd = qc->scsicmd;
3657         const u8 *cdb = scmd->cmnd;
3658         u16 sect, fp = (u16)-1;
3659         u8 sa, options, bp = 0xff;
3660         u64 block;
3661         u32 n_block;
3662
3663         if (unlikely(scmd->cmd_len < 16)) {
3664                 ata_dev_warn(qc->dev, "invalid cdb length %d\n",
3665                              scmd->cmd_len);
3666                 fp = 15;
3667                 goto invalid_fld;
3668         }
3669         scsi_16_lba_len(cdb, &block, &n_block);
3670         if (n_block != scsi_bufflen(scmd)) {
3671                 ata_dev_warn(qc->dev, "non-matching transfer count (%d/%d)\n",
3672                              n_block, scsi_bufflen(scmd));
3673                 goto invalid_param_len;
3674         }
3675         sa = cdb[1] & 0x1f;
3676         if (sa != ZI_REPORT_ZONES) {
3677                 ata_dev_warn(qc->dev, "invalid service action %d\n", sa);
3678                 fp = 1;
3679                 goto invalid_fld;
3680         }
3681         /*
3682          * ZAC allows only for transfers in 512 byte blocks,
3683          * and uses a 16 bit value for the transfer count.
3684          */
3685         if ((n_block / 512) > 0xffff || n_block < 512 || (n_block % 512)) {
3686                 ata_dev_warn(qc->dev, "invalid transfer count %d\n", n_block);
3687                 goto invalid_param_len;
3688         }
3689         sect = n_block / 512;
3690         options = cdb[14] & 0xbf;
3691
3692         if (ata_ncq_enabled(qc->dev) &&
3693             ata_fpdma_zac_mgmt_in_supported(qc->dev)) {
3694                 tf->protocol = ATA_PROT_NCQ;
3695                 tf->command = ATA_CMD_FPDMA_RECV;
3696                 tf->hob_nsect = ATA_SUBCMD_FPDMA_RECV_ZAC_MGMT_IN & 0x1f;
3697                 tf->nsect = qc->tag << 3;
3698                 tf->feature = sect & 0xff;
3699                 tf->hob_feature = (sect >> 8) & 0xff;
3700                 tf->auxiliary = ATA_SUBCMD_ZAC_MGMT_IN_REPORT_ZONES | (options << 8);
3701         } else {
3702                 tf->command = ATA_CMD_ZAC_MGMT_IN;
3703                 tf->feature = ATA_SUBCMD_ZAC_MGMT_IN_REPORT_ZONES;
3704                 tf->protocol = ATA_PROT_DMA;
3705                 tf->hob_feature = options;
3706                 tf->hob_nsect = (sect >> 8) & 0xff;
3707                 tf->nsect = sect & 0xff;
3708         }
3709         tf->device = ATA_LBA;
3710         tf->lbah = (block >> 16) & 0xff;
3711         tf->lbam = (block >> 8) & 0xff;
3712         tf->lbal = block & 0xff;
3713         tf->hob_lbah = (block >> 40) & 0xff;
3714         tf->hob_lbam = (block >> 32) & 0xff;
3715         tf->hob_lbal = (block >> 24) & 0xff;
3716
3717         tf->flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE | ATA_TFLAG_LBA48;
3718         qc->flags |= ATA_QCFLAG_RESULT_TF;
3719
3720         ata_qc_set_pc_nbytes(qc);
3721
3722         qc->complete_fn = ata_scsi_report_zones_complete;
3723
3724         return 0;
3725
3726 invalid_fld:
3727         ata_scsi_set_invalid_field(qc->dev, scmd, fp, bp);
3728         return 1;
3729
3730 invalid_param_len:
3731         /* "Parameter list length error" */
3732         ata_scsi_set_sense(qc->dev, scmd, ILLEGAL_REQUEST, 0x1a, 0x0);
3733         return 1;
3734 }
3735
3736 static unsigned int ata_scsi_zbc_out_xlat(struct ata_queued_cmd *qc)
3737 {
3738         struct ata_taskfile *tf = &qc->tf;
3739         struct scsi_cmnd *scmd = qc->scsicmd;
3740         struct ata_device *dev = qc->dev;
3741         const u8 *cdb = scmd->cmnd;
3742         u8 all, sa;
3743         u64 block;
3744         u32 n_block;
3745         u16 fp = (u16)-1;
3746
3747         if (unlikely(scmd->cmd_len < 16)) {
3748                 fp = 15;
3749                 goto invalid_fld;
3750         }
3751
3752         sa = cdb[1] & 0x1f;
3753         if ((sa != ZO_CLOSE_ZONE) && (sa != ZO_FINISH_ZONE) &&
3754             (sa != ZO_OPEN_ZONE) && (sa != ZO_RESET_WRITE_POINTER)) {
3755                 fp = 1;
3756                 goto invalid_fld;
3757         }
3758
3759         scsi_16_lba_len(cdb, &block, &n_block);
3760         if (n_block) {
3761                 /*
3762                  * ZAC MANAGEMENT OUT doesn't define any length
3763                  */
3764                 goto invalid_param_len;
3765         }
3766         if (block > dev->n_sectors)
3767                 goto out_of_range;
3768
3769         all = cdb[14] & 0x1;
3770
3771         if (ata_ncq_enabled(qc->dev) &&
3772             ata_fpdma_zac_mgmt_out_supported(qc->dev)) {
3773                 tf->protocol = ATA_PROT_NCQ_NODATA;
3774                 tf->command = ATA_CMD_NCQ_NON_DATA;
3775                 tf->feature = ATA_SUBCMD_NCQ_NON_DATA_ZAC_MGMT_OUT;
3776                 tf->nsect = qc->tag << 3;
3777                 tf->auxiliary = sa | ((u16)all << 8);
3778         } else {
3779                 tf->protocol = ATA_PROT_NODATA;
3780                 tf->command = ATA_CMD_ZAC_MGMT_OUT;
3781                 tf->feature = sa;
3782                 tf->hob_feature = all;
3783         }
3784         tf->lbah = (block >> 16) & 0xff;
3785         tf->lbam = (block >> 8) & 0xff;
3786         tf->lbal = block & 0xff;
3787         tf->hob_lbah = (block >> 40) & 0xff;
3788         tf->hob_lbam = (block >> 32) & 0xff;
3789         tf->hob_lbal = (block >> 24) & 0xff;
3790         tf->device = ATA_LBA;
3791         tf->flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE | ATA_TFLAG_LBA48;
3792
3793         return 0;
3794
3795  invalid_fld:
3796         ata_scsi_set_invalid_field(qc->dev, scmd, fp, 0xff);
3797         return 1;
3798  out_of_range:
3799         /* "Logical Block Address out of range" */
3800         ata_scsi_set_sense(qc->dev, scmd, ILLEGAL_REQUEST, 0x21, 0x00);
3801         return 1;
3802 invalid_param_len:
3803         /* "Parameter list length error" */
3804         ata_scsi_set_sense(qc->dev, scmd, ILLEGAL_REQUEST, 0x1a, 0x0);
3805         return 1;
3806 }
3807
3808 /**
3809  *      ata_mselect_caching - Simulate MODE SELECT for caching info page
3810  *      @qc: Storage for translated ATA taskfile
3811  *      @buf: input buffer
3812  *      @len: number of valid bytes in the input buffer
3813  *      @fp: out parameter for the failed field on error
3814  *
3815  *      Prepare a taskfile to modify caching information for the device.
3816  *
3817  *      LOCKING:
3818  *      None.
3819  */
3820 static int ata_mselect_caching(struct ata_queued_cmd *qc,
3821                                const u8 *buf, int len, u16 *fp)
3822 {
3823         struct ata_taskfile *tf = &qc->tf;
3824         struct ata_device *dev = qc->dev;
3825         u8 mpage[CACHE_MPAGE_LEN];
3826         u8 wce;
3827         int i;
3828
3829         /*
3830          * The first two bytes of def_cache_mpage are a header, so offsets
3831          * in mpage are off by 2 compared to buf.  Same for len.
3832          */
3833
3834         if (len != CACHE_MPAGE_LEN - 2) {
3835                 if (len < CACHE_MPAGE_LEN - 2)
3836                         *fp = len;
3837                 else
3838                         *fp = CACHE_MPAGE_LEN - 2;
3839                 return -EINVAL;
3840         }
3841
3842         wce = buf[0] & (1 << 2);
3843
3844         /*
3845          * Check that read-only bits are not modified.
3846          */
3847         ata_msense_caching(dev->id, mpage, false);
3848         for (i = 0; i < CACHE_MPAGE_LEN - 2; i++) {
3849                 if (i == 0)
3850                         continue;
3851                 if (mpage[i + 2] != buf[i]) {
3852                         *fp = i;
3853                         return -EINVAL;
3854                 }
3855         }
3856
3857         tf->flags |= ATA_TFLAG_DEVICE | ATA_TFLAG_ISADDR;
3858         tf->protocol = ATA_PROT_NODATA;
3859         tf->nsect = 0;
3860         tf->command = ATA_CMD_SET_FEATURES;
3861         tf->feature = wce ? SETFEATURES_WC_ON : SETFEATURES_WC_OFF;
3862         return 0;
3863 }
3864
3865 /**
3866  *      ata_mselect_control - Simulate MODE SELECT for control page
3867  *      @qc: Storage for translated ATA taskfile
3868  *      @buf: input buffer
3869  *      @len: number of valid bytes in the input buffer
3870  *      @fp: out parameter for the failed field on error
3871  *
3872  *      Prepare a taskfile to modify caching information for the device.
3873  *
3874  *      LOCKING:
3875  *      None.
3876  */
3877 static int ata_mselect_control(struct ata_queued_cmd *qc,
3878                                const u8 *buf, int len, u16 *fp)
3879 {
3880         struct ata_device *dev = qc->dev;
3881         u8 mpage[CONTROL_MPAGE_LEN];
3882         u8 d_sense;
3883         int i;
3884
3885         /*
3886          * The first two bytes of def_control_mpage are a header, so offsets
3887          * in mpage are off by 2 compared to buf.  Same for len.
3888          */
3889
3890         if (len != CONTROL_MPAGE_LEN - 2) {
3891                 if (len < CONTROL_MPAGE_LEN - 2)
3892                         *fp = len;
3893                 else
3894                         *fp = CONTROL_MPAGE_LEN - 2;
3895                 return -EINVAL;
3896         }
3897
3898         d_sense = buf[0] & (1 << 2);
3899
3900         /*
3901          * Check that read-only bits are not modified.
3902          */
3903         ata_msense_control(dev, mpage, false);
3904         for (i = 0; i < CONTROL_MPAGE_LEN - 2; i++) {
3905                 if (i == 0)
3906                         continue;
3907                 if (mpage[2 + i] != buf[i]) {
3908                         *fp = i;
3909                         return -EINVAL;
3910                 }
3911         }
3912         if (d_sense & (1 << 2))
3913                 dev->flags |= ATA_DFLAG_D_SENSE;
3914         else
3915                 dev->flags &= ~ATA_DFLAG_D_SENSE;
3916         return 0;
3917 }
3918
3919 /**
3920  *      ata_scsiop_mode_select - Simulate MODE SELECT 6, 10 commands
3921  *      @qc: Storage for translated ATA taskfile
3922  *
3923  *      Converts a MODE SELECT command to an ATA SET FEATURES taskfile.
3924  *      Assume this is invoked for direct access devices (e.g. disks) only.
3925  *      There should be no block descriptor for other device types.
3926  *
3927  *      LOCKING:
3928  *      spin_lock_irqsave(host lock)
3929  */
3930 static unsigned int ata_scsi_mode_select_xlat(struct ata_queued_cmd *qc)
3931 {
3932         struct scsi_cmnd *scmd = qc->scsicmd;
3933         const u8 *cdb = scmd->cmnd;
3934         const u8 *p;
3935         u8 pg, spg;
3936         unsigned six_byte, pg_len, hdr_len, bd_len;
3937         int len;
3938         u16 fp = (u16)-1;
3939         u8 bp = 0xff;
3940
3941         VPRINTK("ENTER\n");
3942
3943         six_byte = (cdb[0] == MODE_SELECT);
3944         if (six_byte) {
3945                 if (scmd->cmd_len < 5) {
3946                         fp = 4;
3947                         goto invalid_fld;
3948                 }
3949
3950                 len = cdb[4];
3951                 hdr_len = 4;
3952         } else {
3953                 if (scmd->cmd_len < 9) {
3954                         fp = 8;
3955                         goto invalid_fld;
3956                 }
3957
3958                 len = (cdb[7] << 8) + cdb[8];
3959                 hdr_len = 8;
3960         }
3961
3962         /* We only support PF=1, SP=0.  */
3963         if ((cdb[1] & 0x11) != 0x10) {
3964                 fp = 1;
3965                 bp = (cdb[1] & 0x01) ? 1 : 5;
3966                 goto invalid_fld;
3967         }
3968
3969         /* Test early for possible overrun.  */
3970         if (!scsi_sg_count(scmd) || scsi_sglist(scmd)->length < len)
3971                 goto invalid_param_len;
3972
3973         p = page_address(sg_page(scsi_sglist(scmd)));
3974
3975         /* Move past header and block descriptors.  */
3976         if (len < hdr_len)
3977                 goto invalid_param_len;
3978
3979         if (six_byte)
3980                 bd_len = p[3];
3981         else
3982                 bd_len = (p[6] << 8) + p[7];
3983
3984         len -= hdr_len;
3985         p += hdr_len;
3986         if (len < bd_len)
3987                 goto invalid_param_len;
3988         if (bd_len != 0 && bd_len != 8) {
3989                 fp = (six_byte) ? 3 : 6;
3990                 fp += bd_len + hdr_len;
3991                 goto invalid_param;
3992         }
3993
3994         len -= bd_len;
3995         p += bd_len;
3996         if (len == 0)
3997                 goto skip;
3998
3999         /* Parse both possible formats for the mode page headers.  */
4000         pg = p[0] & 0x3f;
4001         if (p[0] & 0x40) {
4002                 if (len < 4)
4003                         goto invalid_param_len;
4004
4005                 spg = p[1];
4006                 pg_len = (p[2] << 8) | p[3];
4007                 p += 4;
4008                 len -= 4;
4009         } else {
4010                 if (len < 2)
4011                         goto invalid_param_len;
4012
4013                 spg = 0;
4014                 pg_len = p[1];
4015                 p += 2;
4016                 len -= 2;
4017         }
4018
4019         /*
4020          * No mode subpages supported (yet) but asking for _all_
4021          * subpages may be valid
4022          */
4023         if (spg && (spg != ALL_SUB_MPAGES)) {
4024                 fp = (p[0] & 0x40) ? 1 : 0;
4025                 fp += hdr_len + bd_len;
4026                 goto invalid_param;
4027         }
4028         if (pg_len > len)
4029                 goto invalid_param_len;
4030
4031         switch (pg) {
4032         case CACHE_MPAGE:
4033                 if (ata_mselect_caching(qc, p, pg_len, &fp) < 0) {
4034                         fp += hdr_len + bd_len;
4035                         goto invalid_param;
4036                 }
4037                 break;
4038         case CONTROL_MPAGE:
4039                 if (ata_mselect_control(qc, p, pg_len, &fp) < 0) {
4040                         fp += hdr_len + bd_len;
4041                         goto invalid_param;
4042                 } else {
4043                         goto skip; /* No ATA command to send */
4044                 }
4045                 break;
4046         default:                /* invalid page code */
4047                 fp = bd_len + hdr_len;
4048                 goto invalid_param;
4049         }
4050
4051         /*
4052          * Only one page has changeable data, so we only support setting one
4053          * page at a time.
4054          */
4055         if (len > pg_len)
4056                 goto invalid_param;
4057
4058         return 0;
4059
4060  invalid_fld:
4061         ata_scsi_set_invalid_field(qc->dev, scmd, fp, bp);
4062         return 1;
4063
4064  invalid_param:
4065         ata_scsi_set_invalid_parameter(qc->dev, scmd, fp);
4066         return 1;
4067
4068  invalid_param_len:
4069         /* "Parameter list length error" */
4070         ata_scsi_set_sense(qc->dev, scmd, ILLEGAL_REQUEST, 0x1a, 0x0);
4071         return 1;
4072
4073  skip:
4074         scmd->result = SAM_STAT_GOOD;
4075         return 1;
4076 }
4077
4078 /**
4079  *      ata_get_xlat_func - check if SCSI to ATA translation is possible
4080  *      @dev: ATA device
4081  *      @cmd: SCSI command opcode to consider
4082  *
4083  *      Look up the SCSI command given, and determine whether the
4084  *      SCSI command is to be translated or simulated.
4085  *
4086  *      RETURNS:
4087  *      Pointer to translation function if possible, %NULL if not.
4088  */
4089
4090 static inline ata_xlat_func_t ata_get_xlat_func(struct ata_device *dev, u8 cmd)
4091 {
4092         switch (cmd) {
4093         case READ_6:
4094         case READ_10:
4095         case READ_16:
4096
4097         case WRITE_6:
4098         case WRITE_10:
4099         case WRITE_16:
4100                 return ata_scsi_rw_xlat;
4101
4102         case WRITE_SAME_16:
4103                 return ata_scsi_write_same_xlat;
4104
4105         case SYNCHRONIZE_CACHE:
4106                 if (ata_try_flush_cache(dev))
4107                         return ata_scsi_flush_xlat;
4108                 break;
4109
4110         case VERIFY:
4111         case VERIFY_16:
4112                 return ata_scsi_verify_xlat;
4113
4114         case ATA_12:
4115         case ATA_16:
4116                 return ata_scsi_pass_thru;
4117
4118         case MODE_SELECT:
4119         case MODE_SELECT_10:
4120                 return ata_scsi_mode_select_xlat;
4121                 break;
4122
4123         case ZBC_IN:
4124                 return ata_scsi_zbc_in_xlat;
4125
4126         case ZBC_OUT:
4127                 return ata_scsi_zbc_out_xlat;
4128
4129         case START_STOP:
4130                 return ata_scsi_start_stop_xlat;
4131         }
4132
4133         return NULL;
4134 }
4135
4136 /**
4137  *      ata_scsi_dump_cdb - dump SCSI command contents to dmesg
4138  *      @ap: ATA port to which the command was being sent
4139  *      @cmd: SCSI command to dump
4140  *
4141  *      Prints the contents of a SCSI command via printk().
4142  */
4143
4144 static inline void ata_scsi_dump_cdb(struct ata_port *ap,
4145                                      struct scsi_cmnd *cmd)
4146 {
4147 #ifdef ATA_DEBUG
4148         struct scsi_device *scsidev = cmd->device;
4149
4150         DPRINTK("CDB (%u:%d,%d,%d) %9ph\n",
4151                 ap->print_id,
4152                 scsidev->channel, scsidev->id, scsidev->lun,
4153                 cmd->cmnd);
4154 #endif
4155 }
4156
4157 static inline int __ata_scsi_queuecmd(struct scsi_cmnd *scmd,
4158                                       struct ata_device *dev)
4159 {
4160         u8 scsi_op = scmd->cmnd[0];
4161         ata_xlat_func_t xlat_func;
4162         int rc = 0;
4163
4164         if (dev->class == ATA_DEV_ATA || dev->class == ATA_DEV_ZAC) {
4165                 if (unlikely(!scmd->cmd_len || scmd->cmd_len > dev->cdb_len))
4166                         goto bad_cdb_len;
4167
4168                 xlat_func = ata_get_xlat_func(dev, scsi_op);
4169         } else {
4170                 if (unlikely(!scmd->cmd_len))
4171                         goto bad_cdb_len;
4172
4173                 xlat_func = NULL;
4174                 if (likely((scsi_op != ATA_16) || !atapi_passthru16)) {
4175                         /* relay SCSI command to ATAPI device */
4176                         int len = COMMAND_SIZE(scsi_op);
4177                         if (unlikely(len > scmd->cmd_len || len > dev->cdb_len))
4178                                 goto bad_cdb_len;
4179
4180                         xlat_func = atapi_xlat;
4181                 } else {
4182                         /* ATA_16 passthru, treat as an ATA command */
4183                         if (unlikely(scmd->cmd_len > 16))
4184                                 goto bad_cdb_len;
4185
4186                         xlat_func = ata_get_xlat_func(dev, scsi_op);
4187                 }
4188         }
4189
4190         if (xlat_func)
4191                 rc = ata_scsi_translate(dev, scmd, xlat_func);
4192         else
4193                 ata_scsi_simulate(dev, scmd);
4194
4195         return rc;
4196
4197  bad_cdb_len:
4198         DPRINTK("bad CDB len=%u, scsi_op=0x%02x, max=%u\n",
4199                 scmd->cmd_len, scsi_op, dev->cdb_len);
4200         scmd->result = DID_ERROR << 16;
4201         scmd->scsi_done(scmd);
4202         return 0;
4203 }
4204
4205 /**
4206  *      ata_scsi_queuecmd - Issue SCSI cdb to libata-managed device
4207  *      @shost: SCSI host of command to be sent
4208  *      @cmd: SCSI command to be sent
4209  *
4210  *      In some cases, this function translates SCSI commands into
4211  *      ATA taskfiles, and queues the taskfiles to be sent to
4212  *      hardware.  In other cases, this function simulates a
4213  *      SCSI device by evaluating and responding to certain
4214  *      SCSI commands.  This creates the overall effect of
4215  *      ATA and ATAPI devices appearing as SCSI devices.
4216  *
4217  *      LOCKING:
4218  *      ATA host lock
4219  *
4220  *      RETURNS:
4221  *      Return value from __ata_scsi_queuecmd() if @cmd can be queued,
4222  *      0 otherwise.
4223  */
4224 int ata_scsi_queuecmd(struct Scsi_Host *shost, struct scsi_cmnd *cmd)
4225 {
4226         struct ata_port *ap;
4227         struct ata_device *dev;
4228         struct scsi_device *scsidev = cmd->device;
4229         int rc = 0;
4230         unsigned long irq_flags;
4231
4232         ap = ata_shost_to_port(shost);
4233
4234         spin_lock_irqsave(ap->lock, irq_flags);
4235
4236         ata_scsi_dump_cdb(ap, cmd);
4237
4238         dev = ata_scsi_find_dev(ap, scsidev);
4239         if (likely(dev))
4240                 rc = __ata_scsi_queuecmd(cmd, dev);
4241         else {
4242                 cmd->result = (DID_BAD_TARGET << 16);
4243                 cmd->scsi_done(cmd);
4244         }
4245
4246         spin_unlock_irqrestore(ap->lock, irq_flags);
4247
4248         return rc;
4249 }
4250
4251 /**
4252  *      ata_scsi_simulate - simulate SCSI command on ATA device
4253  *      @dev: the target device
4254  *      @cmd: SCSI command being sent to device.
4255  *
4256  *      Interprets and directly executes a select list of SCSI commands
4257  *      that can be handled internally.
4258  *
4259  *      LOCKING:
4260  *      spin_lock_irqsave(host lock)
4261  */
4262
4263 void ata_scsi_simulate(struct ata_device *dev, struct scsi_cmnd *cmd)
4264 {
4265         struct ata_scsi_args args;
4266         const u8 *scsicmd = cmd->cmnd;
4267         u8 tmp8;
4268
4269         args.dev = dev;
4270         args.id = dev->id;
4271         args.cmd = cmd;
4272         args.done = cmd->scsi_done;
4273
4274         switch(scsicmd[0]) {
4275         case INQUIRY:
4276                 if (scsicmd[1] & 2)                /* is CmdDt set?  */
4277                     ata_scsi_invalid_field(dev, cmd, 1);
4278                 else if ((scsicmd[1] & 1) == 0)    /* is EVPD clear? */
4279                         ata_scsi_rbuf_fill(&args, ata_scsiop_inq_std);
4280                 else switch (scsicmd[2]) {
4281                 case 0x00:
4282                         ata_scsi_rbuf_fill(&args, ata_scsiop_inq_00);
4283                         break;
4284                 case 0x80:
4285                         ata_scsi_rbuf_fill(&args, ata_scsiop_inq_80);
4286                         break;
4287                 case 0x83:
4288                         ata_scsi_rbuf_fill(&args, ata_scsiop_inq_83);
4289                         break;
4290                 case 0x89:
4291                         ata_scsi_rbuf_fill(&args, ata_scsiop_inq_89);
4292                         break;
4293                 case 0xb0:
4294                         ata_scsi_rbuf_fill(&args, ata_scsiop_inq_b0);
4295                         break;
4296                 case 0xb1:
4297                         ata_scsi_rbuf_fill(&args, ata_scsiop_inq_b1);
4298                         break;
4299                 case 0xb2:
4300                         ata_scsi_rbuf_fill(&args, ata_scsiop_inq_b2);
4301                         break;
4302                 case 0xb6:
4303                         if (dev->flags & ATA_DFLAG_ZAC) {
4304                                 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_b6);
4305                                 break;
4306                         }
4307                         /* Fallthrough */
4308                 default:
4309                         ata_scsi_invalid_field(dev, cmd, 2);
4310                         break;
4311                 }
4312                 break;
4313
4314         case MODE_SENSE:
4315         case MODE_SENSE_10:
4316                 ata_scsi_rbuf_fill(&args, ata_scsiop_mode_sense);
4317                 break;
4318
4319         case READ_CAPACITY:
4320                 ata_scsi_rbuf_fill(&args, ata_scsiop_read_cap);
4321                 break;
4322
4323         case SERVICE_ACTION_IN_16:
4324                 if ((scsicmd[1] & 0x1f) == SAI_READ_CAPACITY_16)
4325                         ata_scsi_rbuf_fill(&args, ata_scsiop_read_cap);
4326                 else
4327                         ata_scsi_invalid_field(dev, cmd, 1);
4328                 break;
4329
4330         case REPORT_LUNS:
4331                 ata_scsi_rbuf_fill(&args, ata_scsiop_report_luns);
4332                 break;
4333
4334         case REQUEST_SENSE:
4335                 ata_scsi_set_sense(dev, cmd, 0, 0, 0);
4336                 cmd->result = (DRIVER_SENSE << 24);
4337                 cmd->scsi_done(cmd);
4338                 break;
4339
4340         /* if we reach this, then writeback caching is disabled,
4341          * turning this into a no-op.
4342          */
4343         case SYNCHRONIZE_CACHE:
4344                 /* fall through */
4345
4346         /* no-op's, complete with success */
4347         case REZERO_UNIT:
4348         case SEEK_6:
4349         case SEEK_10:
4350         case TEST_UNIT_READY:
4351                 ata_scsi_rbuf_fill(&args, ata_scsiop_noop);
4352                 break;
4353
4354         case SEND_DIAGNOSTIC:
4355                 tmp8 = scsicmd[1] & ~(1 << 3);
4356                 if ((tmp8 == 0x4) && (!scsicmd[3]) && (!scsicmd[4]))
4357                         ata_scsi_rbuf_fill(&args, ata_scsiop_noop);
4358                 else
4359                         ata_scsi_invalid_field(dev, cmd, 1);
4360                 break;
4361
4362         case MAINTENANCE_IN:
4363                 if (scsicmd[1] == MI_REPORT_SUPPORTED_OPERATION_CODES)
4364                         ata_scsi_rbuf_fill(&args, ata_scsiop_maint_in);
4365                 else
4366                         ata_scsi_invalid_field(dev, cmd, 1);
4367                 break;
4368
4369         /* all other commands */
4370         default:
4371                 ata_scsi_set_sense(dev, cmd, ILLEGAL_REQUEST, 0x20, 0x0);
4372                 /* "Invalid command operation code" */
4373                 cmd->scsi_done(cmd);
4374                 break;
4375         }
4376 }
4377
4378 int ata_scsi_add_hosts(struct ata_host *host, struct scsi_host_template *sht)
4379 {
4380         int i, rc;
4381
4382         for (i = 0; i < host->n_ports; i++) {
4383                 struct ata_port *ap = host->ports[i];
4384                 struct Scsi_Host *shost;
4385
4386                 rc = -ENOMEM;
4387                 shost = scsi_host_alloc(sht, sizeof(struct ata_port *));
4388                 if (!shost)
4389                         goto err_alloc;
4390
4391                 shost->eh_noresume = 1;
4392                 *(struct ata_port **)&shost->hostdata[0] = ap;
4393                 ap->scsi_host = shost;
4394
4395                 shost->transportt = ata_scsi_transport_template;
4396                 shost->unique_id = ap->print_id;
4397                 shost->max_id = 16;
4398                 shost->max_lun = 1;
4399                 shost->max_channel = 1;
4400                 shost->max_cmd_len = 16;
4401
4402                 /* Schedule policy is determined by ->qc_defer()
4403                  * callback and it needs to see every deferred qc.
4404                  * Set host_blocked to 1 to prevent SCSI midlayer from
4405                  * automatically deferring requests.
4406                  */
4407                 shost->max_host_blocked = 1;
4408
4409                 rc = scsi_add_host_with_dma(ap->scsi_host,
4410                                                 &ap->tdev, ap->host->dev);
4411                 if (rc)
4412                         goto err_add;
4413         }
4414
4415         return 0;
4416
4417  err_add:
4418         scsi_host_put(host->ports[i]->scsi_host);
4419  err_alloc:
4420         while (--i >= 0) {
4421                 struct Scsi_Host *shost = host->ports[i]->scsi_host;
4422
4423                 scsi_remove_host(shost);
4424                 scsi_host_put(shost);
4425         }
4426         return rc;
4427 }
4428
4429 void ata_scsi_scan_host(struct ata_port *ap, int sync)
4430 {
4431         int tries = 5;
4432         struct ata_device *last_failed_dev = NULL;
4433         struct ata_link *link;
4434         struct ata_device *dev;
4435
4436  repeat:
4437         ata_for_each_link(link, ap, EDGE) {
4438                 ata_for_each_dev(dev, link, ENABLED) {
4439                         struct scsi_device *sdev;
4440                         int channel = 0, id = 0;
4441
4442                         if (dev->sdev)
4443                                 continue;
4444
4445                         if (ata_is_host_link(link))
4446                                 id = dev->devno;
4447                         else
4448                                 channel = link->pmp;
4449
4450                         sdev = __scsi_add_device(ap->scsi_host, channel, id, 0,
4451                                                  NULL);
4452                         if (!IS_ERR(sdev)) {
4453                                 dev->sdev = sdev;
4454                                 scsi_device_put(sdev);
4455                         } else {
4456                                 dev->sdev = NULL;
4457                         }
4458                 }
4459         }
4460
4461         /* If we scanned while EH was in progress or allocation
4462          * failure occurred, scan would have failed silently.  Check
4463          * whether all devices are attached.
4464          */
4465         ata_for_each_link(link, ap, EDGE) {
4466                 ata_for_each_dev(dev, link, ENABLED) {
4467                         if (!dev->sdev)
4468                                 goto exit_loop;
4469                 }
4470         }
4471  exit_loop:
4472         if (!link)
4473                 return;
4474
4475         /* we're missing some SCSI devices */
4476         if (sync) {
4477                 /* If caller requested synchrnous scan && we've made
4478                  * any progress, sleep briefly and repeat.
4479                  */
4480                 if (dev != last_failed_dev) {
4481                         msleep(100);
4482                         last_failed_dev = dev;
4483                         goto repeat;
4484                 }
4485
4486                 /* We might be failing to detect boot device, give it
4487                  * a few more chances.
4488                  */
4489                 if (--tries) {
4490                         msleep(100);
4491                         goto repeat;
4492                 }
4493
4494                 ata_port_err(ap,
4495                              "WARNING: synchronous SCSI scan failed without making any progress, switching to async\n");
4496         }
4497
4498         queue_delayed_work(system_long_wq, &ap->hotplug_task,
4499                            round_jiffies_relative(HZ));
4500 }
4501
4502 /**
4503  *      ata_scsi_offline_dev - offline attached SCSI device
4504  *      @dev: ATA device to offline attached SCSI device for
4505  *
4506  *      This function is called from ata_eh_hotplug() and responsible
4507  *      for taking the SCSI device attached to @dev offline.  This
4508  *      function is called with host lock which protects dev->sdev
4509  *      against clearing.
4510  *
4511  *      LOCKING:
4512  *      spin_lock_irqsave(host lock)
4513  *
4514  *      RETURNS:
4515  *      1 if attached SCSI device exists, 0 otherwise.
4516  */
4517 int ata_scsi_offline_dev(struct ata_device *dev)
4518 {
4519         if (dev->sdev) {
4520                 scsi_device_set_state(dev->sdev, SDEV_OFFLINE);
4521                 return 1;
4522         }
4523         return 0;
4524 }
4525
4526 /**
4527  *      ata_scsi_remove_dev - remove attached SCSI device
4528  *      @dev: ATA device to remove attached SCSI device for
4529  *
4530  *      This function is called from ata_eh_scsi_hotplug() and
4531  *      responsible for removing the SCSI device attached to @dev.
4532  *
4533  *      LOCKING:
4534  *      Kernel thread context (may sleep).
4535  */
4536 static void ata_scsi_remove_dev(struct ata_device *dev)
4537 {
4538         struct ata_port *ap = dev->link->ap;
4539         struct scsi_device *sdev;
4540         unsigned long flags;
4541
4542         /* Alas, we need to grab scan_mutex to ensure SCSI device
4543          * state doesn't change underneath us and thus
4544          * scsi_device_get() always succeeds.  The mutex locking can
4545          * be removed if there is __scsi_device_get() interface which
4546          * increments reference counts regardless of device state.
4547          */
4548         mutex_lock(&ap->scsi_host->scan_mutex);
4549         spin_lock_irqsave(ap->lock, flags);
4550
4551         /* clearing dev->sdev is protected by host lock */
4552         sdev = dev->sdev;
4553         dev->sdev = NULL;
4554
4555         if (sdev) {
4556                 /* If user initiated unplug races with us, sdev can go
4557                  * away underneath us after the host lock and
4558                  * scan_mutex are released.  Hold onto it.
4559                  */
4560                 if (scsi_device_get(sdev) == 0) {
4561                         /* The following ensures the attached sdev is
4562                          * offline on return from ata_scsi_offline_dev()
4563                          * regardless it wins or loses the race
4564                          * against this function.
4565                          */
4566                         scsi_device_set_state(sdev, SDEV_OFFLINE);
4567                 } else {
4568                         WARN_ON(1);
4569                         sdev = NULL;
4570                 }
4571         }
4572
4573         spin_unlock_irqrestore(ap->lock, flags);
4574         mutex_unlock(&ap->scsi_host->scan_mutex);
4575
4576         if (sdev) {
4577                 ata_dev_info(dev, "detaching (SCSI %s)\n",
4578                              dev_name(&sdev->sdev_gendev));
4579
4580                 scsi_remove_device(sdev);
4581                 scsi_device_put(sdev);
4582         }
4583 }
4584
4585 static void ata_scsi_handle_link_detach(struct ata_link *link)
4586 {
4587         struct ata_port *ap = link->ap;
4588         struct ata_device *dev;
4589
4590         ata_for_each_dev(dev, link, ALL) {
4591                 unsigned long flags;
4592
4593                 if (!(dev->flags & ATA_DFLAG_DETACHED))
4594                         continue;
4595
4596                 spin_lock_irqsave(ap->lock, flags);
4597                 dev->flags &= ~ATA_DFLAG_DETACHED;
4598                 spin_unlock_irqrestore(ap->lock, flags);
4599
4600                 if (zpodd_dev_enabled(dev))
4601                         zpodd_exit(dev);
4602
4603                 ata_scsi_remove_dev(dev);
4604         }
4605 }
4606
4607 /**
4608  *      ata_scsi_media_change_notify - send media change event
4609  *      @dev: Pointer to the disk device with media change event
4610  *
4611  *      Tell the block layer to send a media change notification
4612  *      event.
4613  *
4614  *      LOCKING:
4615  *      spin_lock_irqsave(host lock)
4616  */
4617 void ata_scsi_media_change_notify(struct ata_device *dev)
4618 {
4619         if (dev->sdev)
4620                 sdev_evt_send_simple(dev->sdev, SDEV_EVT_MEDIA_CHANGE,
4621                                      GFP_ATOMIC);
4622 }
4623
4624 /**
4625  *      ata_scsi_hotplug - SCSI part of hotplug
4626  *      @work: Pointer to ATA port to perform SCSI hotplug on
4627  *
4628  *      Perform SCSI part of hotplug.  It's executed from a separate
4629  *      workqueue after EH completes.  This is necessary because SCSI
4630  *      hot plugging requires working EH and hot unplugging is
4631  *      synchronized with hot plugging with a mutex.
4632  *
4633  *      LOCKING:
4634  *      Kernel thread context (may sleep).
4635  */
4636 void ata_scsi_hotplug(struct work_struct *work)
4637 {
4638         struct ata_port *ap =
4639                 container_of(work, struct ata_port, hotplug_task.work);
4640         int i;
4641
4642         if (ap->pflags & ATA_PFLAG_UNLOADING) {
4643                 DPRINTK("ENTER/EXIT - unloading\n");
4644                 return;
4645         }
4646
4647         /*
4648          * XXX - UGLY HACK
4649          *
4650          * The block layer suspend/resume path is fundamentally broken due
4651          * to freezable kthreads and workqueue and may deadlock if a block
4652          * device gets removed while resume is in progress.  I don't know
4653          * what the solution is short of removing freezable kthreads and
4654          * workqueues altogether.
4655          *
4656          * The following is an ugly hack to avoid kicking off device
4657          * removal while freezer is active.  This is a joke but does avoid
4658          * this particular deadlock scenario.
4659          *
4660          * https://bugzilla.kernel.org/show_bug.cgi?id=62801
4661          * http://marc.info/?l=linux-kernel&m=138695698516487
4662          */
4663 #ifdef CONFIG_FREEZER
4664         while (pm_freezing)
4665                 msleep(10);
4666 #endif
4667
4668         DPRINTK("ENTER\n");
4669         mutex_lock(&ap->scsi_scan_mutex);
4670
4671         /* Unplug detached devices.  We cannot use link iterator here
4672          * because PMP links have to be scanned even if PMP is
4673          * currently not attached.  Iterate manually.
4674          */
4675         ata_scsi_handle_link_detach(&ap->link);
4676         if (ap->pmp_link)
4677                 for (i = 0; i < SATA_PMP_MAX_PORTS; i++)
4678                         ata_scsi_handle_link_detach(&ap->pmp_link[i]);
4679
4680         /* scan for new ones */
4681         ata_scsi_scan_host(ap, 0);
4682
4683         mutex_unlock(&ap->scsi_scan_mutex);
4684         DPRINTK("EXIT\n");
4685 }
4686
4687 /**
4688  *      ata_scsi_user_scan - indication for user-initiated bus scan
4689  *      @shost: SCSI host to scan
4690  *      @channel: Channel to scan
4691  *      @id: ID to scan
4692  *      @lun: LUN to scan
4693  *
4694  *      This function is called when user explicitly requests bus
4695  *      scan.  Set probe pending flag and invoke EH.
4696  *
4697  *      LOCKING:
4698  *      SCSI layer (we don't care)
4699  *
4700  *      RETURNS:
4701  *      Zero.
4702  */
4703 int ata_scsi_user_scan(struct Scsi_Host *shost, unsigned int channel,
4704                        unsigned int id, u64 lun)
4705 {
4706         struct ata_port *ap = ata_shost_to_port(shost);
4707         unsigned long flags;
4708         int devno, rc = 0;
4709
4710         if (!ap->ops->error_handler)
4711                 return -EOPNOTSUPP;
4712
4713         if (lun != SCAN_WILD_CARD && lun)
4714                 return -EINVAL;
4715
4716         if (!sata_pmp_attached(ap)) {
4717                 if (channel != SCAN_WILD_CARD && channel)
4718                         return -EINVAL;
4719                 devno = id;
4720         } else {
4721                 if (id != SCAN_WILD_CARD && id)
4722                         return -EINVAL;
4723                 devno = channel;
4724         }
4725
4726         spin_lock_irqsave(ap->lock, flags);
4727
4728         if (devno == SCAN_WILD_CARD) {
4729                 struct ata_link *link;
4730
4731                 ata_for_each_link(link, ap, EDGE) {
4732                         struct ata_eh_info *ehi = &link->eh_info;
4733                         ehi->probe_mask |= ATA_ALL_DEVICES;
4734                         ehi->action |= ATA_EH_RESET;
4735                 }
4736         } else {
4737                 struct ata_device *dev = ata_find_dev(ap, devno);
4738
4739                 if (dev) {
4740                         struct ata_eh_info *ehi = &dev->link->eh_info;
4741                         ehi->probe_mask |= 1 << dev->devno;
4742                         ehi->action |= ATA_EH_RESET;
4743                 } else
4744                         rc = -EINVAL;
4745         }
4746
4747         if (rc == 0) {
4748                 ata_port_schedule_eh(ap);
4749                 spin_unlock_irqrestore(ap->lock, flags);
4750                 ata_port_wait_eh(ap);
4751         } else
4752                 spin_unlock_irqrestore(ap->lock, flags);
4753
4754         return rc;
4755 }
4756
4757 /**
4758  *      ata_scsi_dev_rescan - initiate scsi_rescan_device()
4759  *      @work: Pointer to ATA port to perform scsi_rescan_device()
4760  *
4761  *      After ATA pass thru (SAT) commands are executed successfully,
4762  *      libata need to propagate the changes to SCSI layer.
4763  *
4764  *      LOCKING:
4765  *      Kernel thread context (may sleep).
4766  */
4767 void ata_scsi_dev_rescan(struct work_struct *work)
4768 {
4769         struct ata_port *ap =
4770                 container_of(work, struct ata_port, scsi_rescan_task);
4771         struct ata_link *link;
4772         struct ata_device *dev;
4773         unsigned long flags;
4774
4775         mutex_lock(&ap->scsi_scan_mutex);
4776         spin_lock_irqsave(ap->lock, flags);
4777
4778         ata_for_each_link(link, ap, EDGE) {
4779                 ata_for_each_dev(dev, link, ENABLED) {
4780                         struct scsi_device *sdev = dev->sdev;
4781
4782                         if (!sdev)
4783                                 continue;
4784                         if (scsi_device_get(sdev))
4785                                 continue;
4786
4787                         spin_unlock_irqrestore(ap->lock, flags);
4788                         scsi_rescan_device(&(sdev->sdev_gendev));
4789                         scsi_device_put(sdev);
4790                         spin_lock_irqsave(ap->lock, flags);
4791                 }
4792         }
4793
4794         spin_unlock_irqrestore(ap->lock, flags);
4795         mutex_unlock(&ap->scsi_scan_mutex);
4796 }
4797
4798 /**
4799  *      ata_sas_port_alloc - Allocate port for a SAS attached SATA device
4800  *      @host: ATA host container for all SAS ports
4801  *      @port_info: Information from low-level host driver
4802  *      @shost: SCSI host that the scsi device is attached to
4803  *
4804  *      LOCKING:
4805  *      PCI/etc. bus probe sem.
4806  *
4807  *      RETURNS:
4808  *      ata_port pointer on success / NULL on failure.
4809  */
4810
4811 struct ata_port *ata_sas_port_alloc(struct ata_host *host,
4812                                     struct ata_port_info *port_info,
4813                                     struct Scsi_Host *shost)
4814 {
4815         struct ata_port *ap;
4816
4817         ap = ata_port_alloc(host);
4818         if (!ap)
4819                 return NULL;
4820
4821         ap->port_no = 0;
4822         ap->lock = &host->lock;
4823         ap->pio_mask = port_info->pio_mask;
4824         ap->mwdma_mask = port_info->mwdma_mask;
4825         ap->udma_mask = port_info->udma_mask;
4826         ap->flags |= port_info->flags;
4827         ap->ops = port_info->port_ops;
4828         ap->cbl = ATA_CBL_SATA;
4829
4830         return ap;
4831 }
4832 EXPORT_SYMBOL_GPL(ata_sas_port_alloc);
4833
4834 /**
4835  *      ata_sas_port_start - Set port up for dma.
4836  *      @ap: Port to initialize
4837  *
4838  *      Called just after data structures for each port are
4839  *      initialized.
4840  *
4841  *      May be used as the port_start() entry in ata_port_operations.
4842  *
4843  *      LOCKING:
4844  *      Inherited from caller.
4845  */
4846 int ata_sas_port_start(struct ata_port *ap)
4847 {
4848         /*
4849          * the port is marked as frozen at allocation time, but if we don't
4850          * have new eh, we won't thaw it
4851          */
4852         if (!ap->ops->error_handler)
4853                 ap->pflags &= ~ATA_PFLAG_FROZEN;
4854         return 0;
4855 }
4856 EXPORT_SYMBOL_GPL(ata_sas_port_start);
4857
4858 /**
4859  *      ata_port_stop - Undo ata_sas_port_start()
4860  *      @ap: Port to shut down
4861  *
4862  *      May be used as the port_stop() entry in ata_port_operations.
4863  *
4864  *      LOCKING:
4865  *      Inherited from caller.
4866  */
4867
4868 void ata_sas_port_stop(struct ata_port *ap)
4869 {
4870 }
4871 EXPORT_SYMBOL_GPL(ata_sas_port_stop);
4872
4873 /**
4874  * ata_sas_async_probe - simply schedule probing and return
4875  * @ap: Port to probe
4876  *
4877  * For batch scheduling of probe for sas attached ata devices, assumes
4878  * the port has already been through ata_sas_port_init()
4879  */
4880 void ata_sas_async_probe(struct ata_port *ap)
4881 {
4882         __ata_port_probe(ap);
4883 }
4884 EXPORT_SYMBOL_GPL(ata_sas_async_probe);
4885
4886 int ata_sas_sync_probe(struct ata_port *ap)
4887 {
4888         return ata_port_probe(ap);
4889 }
4890 EXPORT_SYMBOL_GPL(ata_sas_sync_probe);
4891
4892
4893 /**
4894  *      ata_sas_port_init - Initialize a SATA device
4895  *      @ap: SATA port to initialize
4896  *
4897  *      LOCKING:
4898  *      PCI/etc. bus probe sem.
4899  *
4900  *      RETURNS:
4901  *      Zero on success, non-zero on error.
4902  */
4903
4904 int ata_sas_port_init(struct ata_port *ap)
4905 {
4906         int rc = ap->ops->port_start(ap);
4907
4908         if (rc)
4909                 return rc;
4910         ap->print_id = atomic_inc_return(&ata_print_id);
4911         return 0;
4912 }
4913 EXPORT_SYMBOL_GPL(ata_sas_port_init);
4914
4915 /**
4916  *      ata_sas_port_destroy - Destroy a SATA port allocated by ata_sas_port_alloc
4917  *      @ap: SATA port to destroy
4918  *
4919  */
4920
4921 void ata_sas_port_destroy(struct ata_port *ap)
4922 {
4923         if (ap->ops->port_stop)
4924                 ap->ops->port_stop(ap);
4925         kfree(ap);
4926 }
4927 EXPORT_SYMBOL_GPL(ata_sas_port_destroy);
4928
4929 /**
4930  *      ata_sas_slave_configure - Default slave_config routine for libata devices
4931  *      @sdev: SCSI device to configure
4932  *      @ap: ATA port to which SCSI device is attached
4933  *
4934  *      RETURNS:
4935  *      Zero.
4936  */
4937
4938 int ata_sas_slave_configure(struct scsi_device *sdev, struct ata_port *ap)
4939 {
4940         ata_scsi_sdev_config(sdev);
4941         ata_scsi_dev_config(sdev, ap->link.device);
4942         return 0;
4943 }
4944 EXPORT_SYMBOL_GPL(ata_sas_slave_configure);
4945
4946 /**
4947  *      ata_sas_queuecmd - Issue SCSI cdb to libata-managed device
4948  *      @cmd: SCSI command to be sent
4949  *      @ap:    ATA port to which the command is being sent
4950  *
4951  *      RETURNS:
4952  *      Return value from __ata_scsi_queuecmd() if @cmd can be queued,
4953  *      0 otherwise.
4954  */
4955
4956 int ata_sas_queuecmd(struct scsi_cmnd *cmd, struct ata_port *ap)
4957 {
4958         int rc = 0;
4959
4960         ata_scsi_dump_cdb(ap, cmd);
4961
4962         if (likely(ata_dev_enabled(ap->link.device)))
4963                 rc = __ata_scsi_queuecmd(cmd, ap->link.device);
4964         else {
4965                 cmd->result = (DID_BAD_TARGET << 16);
4966                 cmd->scsi_done(cmd);
4967         }
4968         return rc;
4969 }
4970 EXPORT_SYMBOL_GPL(ata_sas_queuecmd);
4971
4972 int ata_sas_allocate_tag(struct ata_port *ap)
4973 {
4974         unsigned int max_queue = ap->host->n_tags;
4975         unsigned int i, tag;
4976
4977         for (i = 0, tag = ap->sas_last_tag + 1; i < max_queue; i++, tag++) {
4978                 tag = tag < max_queue ? tag : 0;
4979
4980                 /* the last tag is reserved for internal command. */
4981                 if (tag == ATA_TAG_INTERNAL)
4982                         continue;
4983
4984                 if (!test_and_set_bit(tag, &ap->sas_tag_allocated)) {
4985                         ap->sas_last_tag = tag;
4986                         return tag;
4987                 }
4988         }
4989         return -1;
4990 }
4991
4992 void ata_sas_free_tag(unsigned int tag, struct ata_port *ap)
4993 {
4994         clear_bit(tag, &ap->sas_tag_allocated);
4995 }