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