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