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