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