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