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