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