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