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