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