Merge branch 'master' into upstream
[linux-2.6.git] / drivers / scsi / 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 <asm/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, const u8 *scsicmd);
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[] = {
75         RW_RECOVERY_MPAGE,
76         RW_RECOVERY_MPAGE_LEN - 2,
77         (1 << 7) |      /* AWRE, sat-r06 say it shall be 0 */
78             (1 << 6),   /* ARRE (auto read reallocation) */
79         0,              /* read retry count */
80         0, 0, 0, 0,
81         0,              /* write retry count */
82         0, 0, 0
83 };
84
85 static const u8 def_cache_mpage[CACHE_MPAGE_LEN] = {
86         CACHE_MPAGE,
87         CACHE_MPAGE_LEN - 2,
88         0,              /* contains WCE, needs to be 0 for logic */
89         0, 0, 0, 0, 0, 0, 0, 0, 0,
90         0,              /* contains DRA, needs to be 0 for logic */
91         0, 0, 0, 0, 0, 0, 0
92 };
93
94 static const u8 def_control_mpage[CONTROL_MPAGE_LEN] = {
95         CONTROL_MPAGE,
96         CONTROL_MPAGE_LEN - 2,
97         2,      /* DSENSE=0, GLTSD=1 */
98         0,      /* [QAM+QERR may be 1, see 05-359r1] */
99         0, 0, 0, 0, 0xff, 0xff,
100         0, 30   /* extended self test time, see 05-359r1 */
101 };
102
103 /*
104  * libata transport template.  libata doesn't do real transport stuff.
105  * It just needs the eh_timed_out hook.
106  */
107 struct scsi_transport_template ata_scsi_transport_template = {
108         .eh_strategy_handler    = ata_scsi_error,
109         .eh_timed_out           = ata_scsi_timed_out,
110         .user_scan              = ata_scsi_user_scan,
111 };
112
113
114 static void ata_scsi_invalid_field(struct scsi_cmnd *cmd,
115                                    void (*done)(struct scsi_cmnd *))
116 {
117         ata_scsi_set_sense(cmd, ILLEGAL_REQUEST, 0x24, 0x0);
118         /* "Invalid field in cbd" */
119         done(cmd);
120 }
121
122 /**
123  *      ata_std_bios_param - generic bios head/sector/cylinder calculator used by sd.
124  *      @sdev: SCSI device for which BIOS geometry is to be determined
125  *      @bdev: block device associated with @sdev
126  *      @capacity: capacity of SCSI device
127  *      @geom: location to which geometry will be output
128  *
129  *      Generic bios head/sector/cylinder calculator
130  *      used by sd. Most BIOSes nowadays expect a XXX/255/16  (CHS)
131  *      mapping. Some situations may arise where the disk is not
132  *      bootable if this is not used.
133  *
134  *      LOCKING:
135  *      Defined by the SCSI layer.  We don't really care.
136  *
137  *      RETURNS:
138  *      Zero.
139  */
140 int ata_std_bios_param(struct scsi_device *sdev, struct block_device *bdev,
141                        sector_t capacity, int geom[])
142 {
143         geom[0] = 255;
144         geom[1] = 63;
145         sector_div(capacity, 255*63);
146         geom[2] = capacity;
147
148         return 0;
149 }
150
151 /**
152  *      ata_cmd_ioctl - Handler for HDIO_DRIVE_CMD ioctl
153  *      @scsidev: Device to which we are issuing command
154  *      @arg: User provided data for issuing command
155  *
156  *      LOCKING:
157  *      Defined by the SCSI layer.  We don't really care.
158  *
159  *      RETURNS:
160  *      Zero on success, negative errno on error.
161  */
162
163 int ata_cmd_ioctl(struct scsi_device *scsidev, void __user *arg)
164 {
165         int rc = 0;
166         u8 scsi_cmd[MAX_COMMAND_SIZE];
167         u8 args[4], *argbuf = NULL;
168         int argsize = 0;
169         struct scsi_sense_hdr sshdr;
170         enum dma_data_direction data_dir;
171
172         if (arg == NULL)
173                 return -EINVAL;
174
175         if (copy_from_user(args, arg, sizeof(args)))
176                 return -EFAULT;
177
178         memset(scsi_cmd, 0, sizeof(scsi_cmd));
179
180         if (args[3]) {
181                 argsize = SECTOR_SIZE * args[3];
182                 argbuf = kmalloc(argsize, GFP_KERNEL);
183                 if (argbuf == NULL) {
184                         rc = -ENOMEM;
185                         goto error;
186                 }
187
188                 scsi_cmd[1]  = (4 << 1); /* PIO Data-in */
189                 scsi_cmd[2]  = 0x0e;     /* no off.line or cc, read from dev,
190                                             block count in sector count field */
191                 data_dir = DMA_FROM_DEVICE;
192         } else {
193                 scsi_cmd[1]  = (3 << 1); /* Non-data */
194                 /* scsi_cmd[2] is already 0 -- no off.line, cc, or data xfer */
195                 data_dir = DMA_NONE;
196         }
197
198         scsi_cmd[0] = ATA_16;
199
200         scsi_cmd[4] = args[2];
201         if (args[0] == WIN_SMART) { /* hack -- ide driver does this too... */
202                 scsi_cmd[6]  = args[3];
203                 scsi_cmd[8]  = args[1];
204                 scsi_cmd[10] = 0x4f;
205                 scsi_cmd[12] = 0xc2;
206         } else {
207                 scsi_cmd[6]  = args[1];
208         }
209         scsi_cmd[14] = args[0];
210
211         /* Good values for timeout and retries?  Values below
212            from scsi_ioctl_send_command() for default case... */
213         if (scsi_execute_req(scsidev, scsi_cmd, data_dir, argbuf, argsize,
214                              &sshdr, (10*HZ), 5)) {
215                 rc = -EIO;
216                 goto error;
217         }
218
219         /* Need code to retrieve data from check condition? */
220
221         if ((argbuf)
222          && copy_to_user(arg + sizeof(args), argbuf, argsize))
223                 rc = -EFAULT;
224 error:
225         if (argbuf)
226                 kfree(argbuf);
227
228         return rc;
229 }
230
231 /**
232  *      ata_task_ioctl - Handler for HDIO_DRIVE_TASK ioctl
233  *      @scsidev: Device to which we are issuing command
234  *      @arg: User provided data for issuing command
235  *
236  *      LOCKING:
237  *      Defined by the SCSI layer.  We don't really care.
238  *
239  *      RETURNS:
240  *      Zero on success, negative errno on error.
241  */
242 int ata_task_ioctl(struct scsi_device *scsidev, void __user *arg)
243 {
244         int rc = 0;
245         u8 scsi_cmd[MAX_COMMAND_SIZE];
246         u8 args[7];
247         struct scsi_sense_hdr sshdr;
248
249         if (arg == NULL)
250                 return -EINVAL;
251
252         if (copy_from_user(args, arg, sizeof(args)))
253                 return -EFAULT;
254
255         memset(scsi_cmd, 0, sizeof(scsi_cmd));
256         scsi_cmd[0]  = ATA_16;
257         scsi_cmd[1]  = (3 << 1); /* Non-data */
258         /* scsi_cmd[2] is already 0 -- no off.line, cc, or data xfer */
259         scsi_cmd[4]  = args[1];
260         scsi_cmd[6]  = args[2];
261         scsi_cmd[8]  = args[3];
262         scsi_cmd[10] = args[4];
263         scsi_cmd[12] = args[5];
264         scsi_cmd[14] = args[0];
265
266         /* Good values for timeout and retries?  Values below
267            from scsi_ioctl_send_command() for default case... */
268         if (scsi_execute_req(scsidev, scsi_cmd, DMA_NONE, NULL, 0, &sshdr,
269                              (10*HZ), 5))
270                 rc = -EIO;
271
272         /* Need code to retrieve data from check condition? */
273         return rc;
274 }
275
276 int ata_scsi_ioctl(struct scsi_device *scsidev, int cmd, void __user *arg)
277 {
278         int val = -EINVAL, rc = -EINVAL;
279
280         switch (cmd) {
281         case ATA_IOC_GET_IO32:
282                 val = 0;
283                 if (copy_to_user(arg, &val, 1))
284                         return -EFAULT;
285                 return 0;
286
287         case ATA_IOC_SET_IO32:
288                 val = (unsigned long) arg;
289                 if (val != 0)
290                         return -EINVAL;
291                 return 0;
292
293         case HDIO_DRIVE_CMD:
294                 if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
295                         return -EACCES;
296                 return ata_cmd_ioctl(scsidev, arg);
297
298         case HDIO_DRIVE_TASK:
299                 if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
300                         return -EACCES;
301                 return ata_task_ioctl(scsidev, arg);
302
303         default:
304                 rc = -ENOTTY;
305                 break;
306         }
307
308         return rc;
309 }
310
311 /**
312  *      ata_scsi_qc_new - acquire new ata_queued_cmd reference
313  *      @dev: ATA device to which the new command is attached
314  *      @cmd: SCSI command that originated this ATA command
315  *      @done: SCSI command completion function
316  *
317  *      Obtain a reference to an unused ata_queued_cmd structure,
318  *      which is the basic libata structure representing a single
319  *      ATA command sent to the hardware.
320  *
321  *      If a command was available, fill in the SCSI-specific
322  *      portions of the structure with information on the
323  *      current command.
324  *
325  *      LOCKING:
326  *      spin_lock_irqsave(host_set lock)
327  *
328  *      RETURNS:
329  *      Command allocated, or %NULL if none available.
330  */
331 struct ata_queued_cmd *ata_scsi_qc_new(struct ata_device *dev,
332                                        struct scsi_cmnd *cmd,
333                                        void (*done)(struct scsi_cmnd *))
334 {
335         struct ata_queued_cmd *qc;
336
337         qc = ata_qc_new_init(dev);
338         if (qc) {
339                 qc->scsicmd = cmd;
340                 qc->scsidone = done;
341
342                 if (cmd->use_sg) {
343                         qc->__sg = (struct scatterlist *) cmd->request_buffer;
344                         qc->n_elem = cmd->use_sg;
345                 } else {
346                         qc->__sg = &qc->sgent;
347                         qc->n_elem = 1;
348                 }
349         } else {
350                 cmd->result = (DID_OK << 16) | (QUEUE_FULL << 1);
351                 done(cmd);
352         }
353
354         return qc;
355 }
356
357 /**
358  *      ata_dump_status - user friendly display of error info
359  *      @id: id of the port in question
360  *      @tf: ptr to filled out taskfile
361  *
362  *      Decode and dump the ATA error/status registers for the user so
363  *      that they have some idea what really happened at the non
364  *      make-believe layer.
365  *
366  *      LOCKING:
367  *      inherited from caller
368  */
369 void ata_dump_status(unsigned id, struct ata_taskfile *tf)
370 {
371         u8 stat = tf->command, err = tf->feature;
372
373         printk(KERN_WARNING "ata%u: status=0x%02x { ", id, stat);
374         if (stat & ATA_BUSY) {
375                 printk("Busy }\n");     /* Data is not valid in this case */
376         } else {
377                 if (stat & 0x40)        printk("DriveReady ");
378                 if (stat & 0x20)        printk("DeviceFault ");
379                 if (stat & 0x10)        printk("SeekComplete ");
380                 if (stat & 0x08)        printk("DataRequest ");
381                 if (stat & 0x04)        printk("CorrectedError ");
382                 if (stat & 0x02)        printk("Index ");
383                 if (stat & 0x01)        printk("Error ");
384                 printk("}\n");
385
386                 if (err) {
387                         printk(KERN_WARNING "ata%u: error=0x%02x { ", id, err);
388                         if (err & 0x04)         printk("DriveStatusError ");
389                         if (err & 0x80) {
390                                 if (err & 0x04) printk("BadCRC ");
391                                 else            printk("Sector ");
392                         }
393                         if (err & 0x40)         printk("UncorrectableError ");
394                         if (err & 0x10)         printk("SectorIdNotFound ");
395                         if (err & 0x02)         printk("TrackZeroNotFound ");
396                         if (err & 0x01)         printk("AddrMarkNotFound ");
397                         printk("}\n");
398                 }
399         }
400 }
401
402 int ata_scsi_device_resume(struct scsi_device *sdev)
403 {
404         struct ata_port *ap = ata_shost_to_port(sdev->host);
405         struct ata_device *dev = __ata_scsi_find_dev(ap, sdev);
406
407         return ata_device_resume(dev);
408 }
409
410 int ata_scsi_device_suspend(struct scsi_device *sdev, pm_message_t state)
411 {
412         struct ata_port *ap = ata_shost_to_port(sdev->host);
413         struct ata_device *dev = __ata_scsi_find_dev(ap, sdev);
414
415         return ata_device_suspend(dev, state);
416 }
417
418 /**
419  *      ata_to_sense_error - convert ATA error to SCSI error
420  *      @id: ATA device number
421  *      @drv_stat: value contained in ATA status register
422  *      @drv_err: value contained in ATA error register
423  *      @sk: the sense key we'll fill out
424  *      @asc: the additional sense code we'll fill out
425  *      @ascq: the additional sense code qualifier we'll fill out
426  *      @verbose: be verbose
427  *
428  *      Converts an ATA error into a SCSI error.  Fill out pointers to
429  *      SK, ASC, and ASCQ bytes for later use in fixed or descriptor
430  *      format sense blocks.
431  *
432  *      LOCKING:
433  *      spin_lock_irqsave(host_set lock)
434  */
435 void ata_to_sense_error(unsigned id, u8 drv_stat, u8 drv_err, u8 *sk, u8 *asc,
436                         u8 *ascq, int verbose)
437 {
438         int i;
439
440         /* Based on the 3ware driver translation table */
441         static const unsigned char sense_table[][4] = {
442                 /* BBD|ECC|ID|MAR */
443                 {0xd1,          ABORTED_COMMAND, 0x00, 0x00},   // Device busy                  Aborted command
444                 /* BBD|ECC|ID */
445                 {0xd0,          ABORTED_COMMAND, 0x00, 0x00},   // Device busy                  Aborted command
446                 /* ECC|MC|MARK */
447                 {0x61,          HARDWARE_ERROR, 0x00, 0x00},    // Device fault                 Hardware error
448                 /* ICRC|ABRT */         /* NB: ICRC & !ABRT is BBD */
449                 {0x84,          ABORTED_COMMAND, 0x47, 0x00},   // Data CRC error               SCSI parity error
450                 /* MC|ID|ABRT|TRK0|MARK */
451                 {0x37,          NOT_READY, 0x04, 0x00},         // Unit offline                 Not ready
452                 /* MCR|MARK */
453                 {0x09,          NOT_READY, 0x04, 0x00},         // Unrecovered disk error       Not ready
454                 /*  Bad address mark */
455                 {0x01,          MEDIUM_ERROR, 0x13, 0x00},      // Address mark not found       Address mark not found for data field
456                 /* TRK0 */
457                 {0x02,          HARDWARE_ERROR, 0x00, 0x00},    // Track 0 not found              Hardware error
458                 /* Abort & !ICRC */
459                 {0x04,          ABORTED_COMMAND, 0x00, 0x00},   // Aborted command              Aborted command
460                 /* Media change request */
461                 {0x08,          NOT_READY, 0x04, 0x00},         // Media change request   FIXME: faking offline
462                 /* SRV */
463                 {0x10,          ABORTED_COMMAND, 0x14, 0x00},   // ID not found                 Recorded entity not found
464                 /* Media change */
465                 {0x08,          NOT_READY, 0x04, 0x00},         // Media change           FIXME: faking offline
466                 /* ECC */
467                 {0x40,          MEDIUM_ERROR, 0x11, 0x04},      // Uncorrectable ECC error      Unrecovered read error
468                 /* BBD - block marked bad */
469                 {0x80,          MEDIUM_ERROR, 0x11, 0x04},      // Block marked bad               Medium error, unrecovered read error
470                 {0xFF, 0xFF, 0xFF, 0xFF}, // END mark
471         };
472         static const unsigned char stat_table[][4] = {
473                 /* Must be first because BUSY means no other bits valid */
474                 {0x80,          ABORTED_COMMAND, 0x47, 0x00},   // Busy, fake parity for now
475                 {0x20,          HARDWARE_ERROR,  0x00, 0x00},   // Device fault
476                 {0x08,          ABORTED_COMMAND, 0x47, 0x00},   // Timed out in xfer, fake parity for now
477                 {0x04,          RECOVERED_ERROR, 0x11, 0x00},   // Recovered ECC error    Medium error, recovered
478                 {0xFF, 0xFF, 0xFF, 0xFF}, // END mark
479         };
480
481         /*
482          *      Is this an error we can process/parse
483          */
484         if (drv_stat & ATA_BUSY) {
485                 drv_err = 0;    /* Ignore the err bits, they're invalid */
486         }
487
488         if (drv_err) {
489                 /* Look for drv_err */
490                 for (i = 0; sense_table[i][0] != 0xFF; i++) {
491                         /* Look for best matches first */
492                         if ((sense_table[i][0] & drv_err) ==
493                             sense_table[i][0]) {
494                                 *sk = sense_table[i][1];
495                                 *asc = sense_table[i][2];
496                                 *ascq = sense_table[i][3];
497                                 goto translate_done;
498                         }
499                 }
500                 /* No immediate match */
501                 if (verbose)
502                         printk(KERN_WARNING "ata%u: no sense translation for "
503                                "error 0x%02x\n", id, drv_err);
504         }
505
506         /* Fall back to interpreting status bits */
507         for (i = 0; stat_table[i][0] != 0xFF; i++) {
508                 if (stat_table[i][0] & drv_stat) {
509                         *sk = stat_table[i][1];
510                         *asc = stat_table[i][2];
511                         *ascq = stat_table[i][3];
512                         goto translate_done;
513                 }
514         }
515         /* No error?  Undecoded? */
516         if (verbose)
517                 printk(KERN_WARNING "ata%u: no sense translation for "
518                        "status: 0x%02x\n", id, drv_stat);
519
520         /* We need a sensible error return here, which is tricky, and one
521            that won't cause people to do things like return a disk wrongly */
522         *sk = ABORTED_COMMAND;
523         *asc = 0x00;
524         *ascq = 0x00;
525
526  translate_done:
527         if (verbose)
528                 printk(KERN_ERR "ata%u: translated ATA stat/err 0x%02x/%02x "
529                        "to SCSI SK/ASC/ASCQ 0x%x/%02x/%02x\n",
530                        id, drv_stat, drv_err, *sk, *asc, *ascq);
531         return;
532 }
533
534 /*
535  *      ata_gen_ata_desc_sense - Generate check condition sense block.
536  *      @qc: Command that completed.
537  *
538  *      This function is specific to the ATA descriptor format sense
539  *      block specified for the ATA pass through commands.  Regardless
540  *      of whether the command errored or not, return a sense
541  *      block. Copy all controller registers into the sense
542  *      block. Clear sense key, ASC & ASCQ if there is no error.
543  *
544  *      LOCKING:
545  *      spin_lock_irqsave(host_set lock)
546  */
547 void ata_gen_ata_desc_sense(struct ata_queued_cmd *qc)
548 {
549         struct scsi_cmnd *cmd = qc->scsicmd;
550         struct ata_taskfile *tf = &qc->result_tf;
551         unsigned char *sb = cmd->sense_buffer;
552         unsigned char *desc = sb + 8;
553         int verbose = qc->ap->ops->error_handler == NULL;
554
555         memset(sb, 0, SCSI_SENSE_BUFFERSIZE);
556
557         cmd->result = (DRIVER_SENSE << 24) | SAM_STAT_CHECK_CONDITION;
558
559         /*
560          * Use ata_to_sense_error() to map status register bits
561          * onto sense key, asc & ascq.
562          */
563         if (qc->err_mask ||
564             tf->command & (ATA_BUSY | ATA_DF | ATA_ERR | ATA_DRQ)) {
565                 ata_to_sense_error(qc->ap->id, tf->command, tf->feature,
566                                    &sb[1], &sb[2], &sb[3], verbose);
567                 sb[1] &= 0x0f;
568         }
569
570         /*
571          * Sense data is current and format is descriptor.
572          */
573         sb[0] = 0x72;
574
575         desc[0] = 0x09;
576
577         /*
578          * Set length of additional sense data.
579          * Since we only populate descriptor 0, the total
580          * length is the same (fixed) length as descriptor 0.
581          */
582         desc[1] = sb[7] = 14;
583
584         /*
585          * Copy registers into sense buffer.
586          */
587         desc[2] = 0x00;
588         desc[3] = tf->feature;  /* == error reg */
589         desc[5] = tf->nsect;
590         desc[7] = tf->lbal;
591         desc[9] = tf->lbam;
592         desc[11] = tf->lbah;
593         desc[12] = tf->device;
594         desc[13] = tf->command; /* == status reg */
595
596         /*
597          * Fill in Extend bit, and the high order bytes
598          * if applicable.
599          */
600         if (tf->flags & ATA_TFLAG_LBA48) {
601                 desc[2] |= 0x01;
602                 desc[4] = tf->hob_nsect;
603                 desc[6] = tf->hob_lbal;
604                 desc[8] = tf->hob_lbam;
605                 desc[10] = tf->hob_lbah;
606         }
607 }
608
609 /**
610  *      ata_gen_fixed_sense - generate a SCSI fixed sense block
611  *      @qc: Command that we are erroring out
612  *
613  *      Leverage ata_to_sense_error() to give us the codes.  Fit our
614  *      LBA in here if there's room.
615  *
616  *      LOCKING:
617  *      inherited from caller
618  */
619 void ata_gen_fixed_sense(struct ata_queued_cmd *qc)
620 {
621         struct scsi_cmnd *cmd = qc->scsicmd;
622         struct ata_taskfile *tf = &qc->result_tf;
623         unsigned char *sb = cmd->sense_buffer;
624         int verbose = qc->ap->ops->error_handler == NULL;
625
626         memset(sb, 0, SCSI_SENSE_BUFFERSIZE);
627
628         cmd->result = (DRIVER_SENSE << 24) | SAM_STAT_CHECK_CONDITION;
629
630         /*
631          * Use ata_to_sense_error() to map status register bits
632          * onto sense key, asc & ascq.
633          */
634         if (qc->err_mask ||
635             tf->command & (ATA_BUSY | ATA_DF | ATA_ERR | ATA_DRQ)) {
636                 ata_to_sense_error(qc->ap->id, tf->command, tf->feature,
637                                    &sb[2], &sb[12], &sb[13], verbose);
638                 sb[2] &= 0x0f;
639         }
640
641         sb[0] = 0x70;
642         sb[7] = 0x0a;
643
644         if (tf->flags & ATA_TFLAG_LBA48) {
645                 /* TODO: find solution for LBA48 descriptors */
646         }
647
648         else if (tf->flags & ATA_TFLAG_LBA) {
649                 /* A small (28b) LBA will fit in the 32b info field */
650                 sb[0] |= 0x80;          /* set valid bit */
651                 sb[3] = tf->device & 0x0f;
652                 sb[4] = tf->lbah;
653                 sb[5] = tf->lbam;
654                 sb[6] = tf->lbal;
655         }
656
657         else {
658                 /* TODO: C/H/S */
659         }
660 }
661
662 static void ata_scsi_sdev_config(struct scsi_device *sdev)
663 {
664         sdev->use_10_for_rw = 1;
665         sdev->use_10_for_ms = 1;
666 }
667
668 static void ata_scsi_dev_config(struct scsi_device *sdev,
669                                 struct ata_device *dev)
670 {
671         unsigned int max_sectors;
672
673         /* TODO: 2048 is an arbitrary number, not the
674          * hardware maximum.  This should be increased to
675          * 65534 when Jens Axboe's patch for dynamically
676          * determining max_sectors is merged.
677          */
678         max_sectors = ATA_MAX_SECTORS;
679         if (dev->flags & ATA_DFLAG_LBA48)
680                 max_sectors = ATA_MAX_SECTORS_LBA48;
681         if (dev->max_sectors)
682                 max_sectors = dev->max_sectors;
683
684         blk_queue_max_sectors(sdev->request_queue, max_sectors);
685
686         /*
687          * SATA DMA transfers must be multiples of 4 byte, so
688          * we need to pad ATAPI transfers using an extra sg.
689          * Decrement max hw segments accordingly.
690          */
691         if (dev->class == ATA_DEV_ATAPI) {
692                 request_queue_t *q = sdev->request_queue;
693                 blk_queue_max_hw_segments(q, q->max_hw_segments - 1);
694         }
695
696         if (dev->flags & ATA_DFLAG_NCQ) {
697                 int depth;
698
699                 depth = min(sdev->host->can_queue, ata_id_queue_depth(dev->id));
700                 depth = min(ATA_MAX_QUEUE - 1, depth);
701                 scsi_adjust_queue_depth(sdev, MSG_SIMPLE_TAG, depth);
702         }
703 }
704
705 /**
706  *      ata_scsi_slave_config - Set SCSI device attributes
707  *      @sdev: SCSI device to examine
708  *
709  *      This is called before we actually start reading
710  *      and writing to the device, to configure certain
711  *      SCSI mid-layer behaviors.
712  *
713  *      LOCKING:
714  *      Defined by SCSI layer.  We don't really care.
715  */
716
717 int ata_scsi_slave_config(struct scsi_device *sdev)
718 {
719         struct ata_port *ap = ata_shost_to_port(sdev->host);
720         struct ata_device *dev = __ata_scsi_find_dev(ap, sdev);
721
722         ata_scsi_sdev_config(sdev);
723
724         blk_queue_max_phys_segments(sdev->request_queue, LIBATA_MAX_PRD);
725
726         if (dev)
727                 ata_scsi_dev_config(sdev, dev);
728
729         return 0;       /* scsi layer doesn't check return value, sigh */
730 }
731
732 /**
733  *      ata_scsi_slave_destroy - SCSI device is about to be destroyed
734  *      @sdev: SCSI device to be destroyed
735  *
736  *      @sdev is about to be destroyed for hot/warm unplugging.  If
737  *      this unplugging was initiated by libata as indicated by NULL
738  *      dev->sdev, this function doesn't have to do anything.
739  *      Otherwise, SCSI layer initiated warm-unplug is in progress.
740  *      Clear dev->sdev, schedule the device for ATA detach and invoke
741  *      EH.
742  *
743  *      LOCKING:
744  *      Defined by SCSI layer.  We don't really care.
745  */
746 void ata_scsi_slave_destroy(struct scsi_device *sdev)
747 {
748         struct ata_port *ap = ata_shost_to_port(sdev->host);
749         unsigned long flags;
750         struct ata_device *dev;
751
752         if (!ap->ops->error_handler)
753                 return;
754
755         spin_lock_irqsave(&ap->host_set->lock, flags);
756         dev = __ata_scsi_find_dev(ap, sdev);
757         if (dev && dev->sdev) {
758                 /* SCSI device already in CANCEL state, no need to offline it */
759                 dev->sdev = NULL;
760                 dev->flags |= ATA_DFLAG_DETACH;
761                 ata_port_schedule_eh(ap);
762         }
763         spin_unlock_irqrestore(&ap->host_set->lock, flags);
764 }
765
766 /**
767  *      ata_scsi_change_queue_depth - SCSI callback for queue depth config
768  *      @sdev: SCSI device to configure queue depth for
769  *      @queue_depth: new queue depth
770  *
771  *      This is libata standard hostt->change_queue_depth callback.
772  *      SCSI will call into this callback when user tries to set queue
773  *      depth via sysfs.
774  *
775  *      LOCKING:
776  *      SCSI layer (we don't care)
777  *
778  *      RETURNS:
779  *      Newly configured queue depth.
780  */
781 int ata_scsi_change_queue_depth(struct scsi_device *sdev, int queue_depth)
782 {
783         struct ata_port *ap = ata_shost_to_port(sdev->host);
784         struct ata_device *dev;
785         int max_depth;
786
787         if (queue_depth < 1)
788                 return sdev->queue_depth;
789
790         dev = ata_scsi_find_dev(ap, sdev);
791         if (!dev || !ata_dev_enabled(dev))
792                 return sdev->queue_depth;
793
794         max_depth = min(sdev->host->can_queue, ata_id_queue_depth(dev->id));
795         max_depth = min(ATA_MAX_QUEUE - 1, max_depth);
796         if (queue_depth > max_depth)
797                 queue_depth = max_depth;
798
799         scsi_adjust_queue_depth(sdev, MSG_SIMPLE_TAG, queue_depth);
800         return queue_depth;
801 }
802
803 /**
804  *      ata_scsi_start_stop_xlat - Translate SCSI START STOP UNIT command
805  *      @qc: Storage for translated ATA taskfile
806  *      @scsicmd: SCSI command to translate
807  *
808  *      Sets up an ATA taskfile to issue STANDBY (to stop) or READ VERIFY
809  *      (to start). Perhaps these commands should be preceded by
810  *      CHECK POWER MODE to see what power mode the device is already in.
811  *      [See SAT revision 5 at www.t10.org]
812  *
813  *      LOCKING:
814  *      spin_lock_irqsave(host_set lock)
815  *
816  *      RETURNS:
817  *      Zero on success, non-zero on error.
818  */
819
820 static unsigned int ata_scsi_start_stop_xlat(struct ata_queued_cmd *qc,
821                                              const u8 *scsicmd)
822 {
823         struct ata_taskfile *tf = &qc->tf;
824
825         tf->flags |= ATA_TFLAG_DEVICE | ATA_TFLAG_ISADDR;
826         tf->protocol = ATA_PROT_NODATA;
827         if (scsicmd[1] & 0x1) {
828                 ;       /* ignore IMMED bit, violates sat-r05 */
829         }
830         if (scsicmd[4] & 0x2)
831                 goto invalid_fld;       /* LOEJ bit set not supported */
832         if (((scsicmd[4] >> 4) & 0xf) != 0)
833                 goto invalid_fld;       /* power conditions not supported */
834         if (scsicmd[4] & 0x1) {
835                 tf->nsect = 1;  /* 1 sector, lba=0 */
836
837                 if (qc->dev->flags & ATA_DFLAG_LBA) {
838                         tf->flags |= ATA_TFLAG_LBA;
839
840                         tf->lbah = 0x0;
841                         tf->lbam = 0x0;
842                         tf->lbal = 0x0;
843                         tf->device |= ATA_LBA;
844                 } else {
845                         /* CHS */
846                         tf->lbal = 0x1; /* sect */
847                         tf->lbam = 0x0; /* cyl low */
848                         tf->lbah = 0x0; /* cyl high */
849                 }
850
851                 tf->command = ATA_CMD_VERIFY;   /* READ VERIFY */
852         } else {
853                 tf->nsect = 0;  /* time period value (0 implies now) */
854                 tf->command = ATA_CMD_STANDBY;
855                 /* Consider: ATA STANDBY IMMEDIATE command */
856         }
857         /*
858          * Standby and Idle condition timers could be implemented but that
859          * would require libata to implement the Power condition mode page
860          * and allow the user to change it. Changing mode pages requires
861          * MODE SELECT to be implemented.
862          */
863
864         return 0;
865
866 invalid_fld:
867         ata_scsi_set_sense(qc->scsicmd, ILLEGAL_REQUEST, 0x24, 0x0);
868         /* "Invalid field in cbd" */
869         return 1;
870 }
871
872
873 /**
874  *      ata_scsi_flush_xlat - Translate SCSI SYNCHRONIZE CACHE command
875  *      @qc: Storage for translated ATA taskfile
876  *      @scsicmd: SCSI command to translate (ignored)
877  *
878  *      Sets up an ATA taskfile to issue FLUSH CACHE or
879  *      FLUSH CACHE EXT.
880  *
881  *      LOCKING:
882  *      spin_lock_irqsave(host_set lock)
883  *
884  *      RETURNS:
885  *      Zero on success, non-zero on error.
886  */
887
888 static unsigned int ata_scsi_flush_xlat(struct ata_queued_cmd *qc, const u8 *scsicmd)
889 {
890         struct ata_taskfile *tf = &qc->tf;
891
892         tf->flags |= ATA_TFLAG_DEVICE;
893         tf->protocol = ATA_PROT_NODATA;
894
895         if ((qc->dev->flags & ATA_DFLAG_LBA48) &&
896             (ata_id_has_flush_ext(qc->dev->id)))
897                 tf->command = ATA_CMD_FLUSH_EXT;
898         else
899                 tf->command = ATA_CMD_FLUSH;
900
901         return 0;
902 }
903
904 /**
905  *      scsi_6_lba_len - Get LBA and transfer length
906  *      @scsicmd: SCSI command to translate
907  *
908  *      Calculate LBA and transfer length for 6-byte commands.
909  *
910  *      RETURNS:
911  *      @plba: the LBA
912  *      @plen: the transfer length
913  */
914
915 static void scsi_6_lba_len(const u8 *scsicmd, u64 *plba, u32 *plen)
916 {
917         u64 lba = 0;
918         u32 len = 0;
919
920         VPRINTK("six-byte command\n");
921
922         lba |= ((u64)scsicmd[2]) << 8;
923         lba |= ((u64)scsicmd[3]);
924
925         len |= ((u32)scsicmd[4]);
926
927         *plba = lba;
928         *plen = len;
929 }
930
931 /**
932  *      scsi_10_lba_len - Get LBA and transfer length
933  *      @scsicmd: SCSI command to translate
934  *
935  *      Calculate LBA and transfer length for 10-byte commands.
936  *
937  *      RETURNS:
938  *      @plba: the LBA
939  *      @plen: the transfer length
940  */
941
942 static void scsi_10_lba_len(const u8 *scsicmd, u64 *plba, u32 *plen)
943 {
944         u64 lba = 0;
945         u32 len = 0;
946
947         VPRINTK("ten-byte command\n");
948
949         lba |= ((u64)scsicmd[2]) << 24;
950         lba |= ((u64)scsicmd[3]) << 16;
951         lba |= ((u64)scsicmd[4]) << 8;
952         lba |= ((u64)scsicmd[5]);
953
954         len |= ((u32)scsicmd[7]) << 8;
955         len |= ((u32)scsicmd[8]);
956
957         *plba = lba;
958         *plen = len;
959 }
960
961 /**
962  *      scsi_16_lba_len - Get LBA and transfer length
963  *      @scsicmd: SCSI command to translate
964  *
965  *      Calculate LBA and transfer length for 16-byte commands.
966  *
967  *      RETURNS:
968  *      @plba: the LBA
969  *      @plen: the transfer length
970  */
971
972 static void scsi_16_lba_len(const u8 *scsicmd, u64 *plba, u32 *plen)
973 {
974         u64 lba = 0;
975         u32 len = 0;
976
977         VPRINTK("sixteen-byte command\n");
978
979         lba |= ((u64)scsicmd[2]) << 56;
980         lba |= ((u64)scsicmd[3]) << 48;
981         lba |= ((u64)scsicmd[4]) << 40;
982         lba |= ((u64)scsicmd[5]) << 32;
983         lba |= ((u64)scsicmd[6]) << 24;
984         lba |= ((u64)scsicmd[7]) << 16;
985         lba |= ((u64)scsicmd[8]) << 8;
986         lba |= ((u64)scsicmd[9]);
987
988         len |= ((u32)scsicmd[10]) << 24;
989         len |= ((u32)scsicmd[11]) << 16;
990         len |= ((u32)scsicmd[12]) << 8;
991         len |= ((u32)scsicmd[13]);
992
993         *plba = lba;
994         *plen = len;
995 }
996
997 /**
998  *      ata_scsi_verify_xlat - Translate SCSI VERIFY command into an ATA one
999  *      @qc: Storage for translated ATA taskfile
1000  *      @scsicmd: SCSI command to translate
1001  *
1002  *      Converts SCSI VERIFY command to an ATA READ VERIFY command.
1003  *
1004  *      LOCKING:
1005  *      spin_lock_irqsave(host_set lock)
1006  *
1007  *      RETURNS:
1008  *      Zero on success, non-zero on error.
1009  */
1010
1011 static unsigned int ata_scsi_verify_xlat(struct ata_queued_cmd *qc, const u8 *scsicmd)
1012 {
1013         struct ata_taskfile *tf = &qc->tf;
1014         struct ata_device *dev = qc->dev;
1015         u64 dev_sectors = qc->dev->n_sectors;
1016         u64 block;
1017         u32 n_block;
1018
1019         tf->flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
1020         tf->protocol = ATA_PROT_NODATA;
1021
1022         if (scsicmd[0] == VERIFY)
1023                 scsi_10_lba_len(scsicmd, &block, &n_block);
1024         else if (scsicmd[0] == VERIFY_16)
1025                 scsi_16_lba_len(scsicmd, &block, &n_block);
1026         else
1027                 goto invalid_fld;
1028
1029         if (!n_block)
1030                 goto nothing_to_do;
1031         if (block >= dev_sectors)
1032                 goto out_of_range;
1033         if ((block + n_block) > dev_sectors)
1034                 goto out_of_range;
1035
1036         if (dev->flags & ATA_DFLAG_LBA) {
1037                 tf->flags |= ATA_TFLAG_LBA;
1038
1039                 if (lba_28_ok(block, n_block)) {
1040                         /* use LBA28 */
1041                         tf->command = ATA_CMD_VERIFY;
1042                         tf->device |= (block >> 24) & 0xf;
1043                 } else if (lba_48_ok(block, n_block)) {
1044                         if (!(dev->flags & ATA_DFLAG_LBA48))
1045                                 goto out_of_range;
1046
1047                         /* use LBA48 */
1048                         tf->flags |= ATA_TFLAG_LBA48;
1049                         tf->command = ATA_CMD_VERIFY_EXT;
1050
1051                         tf->hob_nsect = (n_block >> 8) & 0xff;
1052
1053                         tf->hob_lbah = (block >> 40) & 0xff;
1054                         tf->hob_lbam = (block >> 32) & 0xff;
1055                         tf->hob_lbal = (block >> 24) & 0xff;
1056                 } else
1057                         /* request too large even for LBA48 */
1058                         goto out_of_range;
1059
1060                 tf->nsect = n_block & 0xff;
1061
1062                 tf->lbah = (block >> 16) & 0xff;
1063                 tf->lbam = (block >> 8) & 0xff;
1064                 tf->lbal = block & 0xff;
1065
1066                 tf->device |= ATA_LBA;
1067         } else {
1068                 /* CHS */
1069                 u32 sect, head, cyl, track;
1070
1071                 if (!lba_28_ok(block, n_block))
1072                         goto out_of_range;
1073
1074                 /* Convert LBA to CHS */
1075                 track = (u32)block / dev->sectors;
1076                 cyl   = track / dev->heads;
1077                 head  = track % dev->heads;
1078                 sect  = (u32)block % dev->sectors + 1;
1079
1080                 DPRINTK("block %u track %u cyl %u head %u sect %u\n",
1081                         (u32)block, track, cyl, head, sect);
1082
1083                 /* Check whether the converted CHS can fit.
1084                    Cylinder: 0-65535
1085                    Head: 0-15
1086                    Sector: 1-255*/
1087                 if ((cyl >> 16) || (head >> 4) || (sect >> 8) || (!sect))
1088                         goto out_of_range;
1089
1090                 tf->command = ATA_CMD_VERIFY;
1091                 tf->nsect = n_block & 0xff; /* Sector count 0 means 256 sectors */
1092                 tf->lbal = sect;
1093                 tf->lbam = cyl;
1094                 tf->lbah = cyl >> 8;
1095                 tf->device |= head;
1096         }
1097
1098         return 0;
1099
1100 invalid_fld:
1101         ata_scsi_set_sense(qc->scsicmd, ILLEGAL_REQUEST, 0x24, 0x0);
1102         /* "Invalid field in cbd" */
1103         return 1;
1104
1105 out_of_range:
1106         ata_scsi_set_sense(qc->scsicmd, ILLEGAL_REQUEST, 0x21, 0x0);
1107         /* "Logical Block Address out of range" */
1108         return 1;
1109
1110 nothing_to_do:
1111         qc->scsicmd->result = SAM_STAT_GOOD;
1112         return 1;
1113 }
1114
1115 /**
1116  *      ata_scsi_rw_xlat - Translate SCSI r/w command into an ATA one
1117  *      @qc: Storage for translated ATA taskfile
1118  *      @scsicmd: SCSI command to translate
1119  *
1120  *      Converts any of six SCSI read/write commands into the
1121  *      ATA counterpart, including starting sector (LBA),
1122  *      sector count, and taking into account the device's LBA48
1123  *      support.
1124  *
1125  *      Commands %READ_6, %READ_10, %READ_16, %WRITE_6, %WRITE_10, and
1126  *      %WRITE_16 are currently supported.
1127  *
1128  *      LOCKING:
1129  *      spin_lock_irqsave(host_set lock)
1130  *
1131  *      RETURNS:
1132  *      Zero on success, non-zero on error.
1133  */
1134
1135 static unsigned int ata_scsi_rw_xlat(struct ata_queued_cmd *qc, const u8 *scsicmd)
1136 {
1137         struct ata_taskfile *tf = &qc->tf;
1138         struct ata_device *dev = qc->dev;
1139         u64 block;
1140         u32 n_block;
1141
1142         qc->flags |= ATA_QCFLAG_IO;
1143         tf->flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
1144
1145         if (scsicmd[0] == WRITE_10 || scsicmd[0] == WRITE_6 ||
1146             scsicmd[0] == WRITE_16)
1147                 tf->flags |= ATA_TFLAG_WRITE;
1148
1149         /* Calculate the SCSI LBA, transfer length and FUA. */
1150         switch (scsicmd[0]) {
1151         case READ_10:
1152         case WRITE_10:
1153                 scsi_10_lba_len(scsicmd, &block, &n_block);
1154                 if (unlikely(scsicmd[1] & (1 << 3)))
1155                         tf->flags |= ATA_TFLAG_FUA;
1156                 break;
1157         case READ_6:
1158         case WRITE_6:
1159                 scsi_6_lba_len(scsicmd, &block, &n_block);
1160
1161                 /* for 6-byte r/w commands, transfer length 0
1162                  * means 256 blocks of data, not 0 block.
1163                  */
1164                 if (!n_block)
1165                         n_block = 256;
1166                 break;
1167         case READ_16:
1168         case WRITE_16:
1169                 scsi_16_lba_len(scsicmd, &block, &n_block);
1170                 if (unlikely(scsicmd[1] & (1 << 3)))
1171                         tf->flags |= ATA_TFLAG_FUA;
1172                 break;
1173         default:
1174                 DPRINTK("no-byte command\n");
1175                 goto invalid_fld;
1176         }
1177
1178         /* Check and compose ATA command */
1179         if (!n_block)
1180                 /* For 10-byte and 16-byte SCSI R/W commands, transfer
1181                  * length 0 means transfer 0 block of data.
1182                  * However, for ATA R/W commands, sector count 0 means
1183                  * 256 or 65536 sectors, not 0 sectors as in SCSI.
1184                  *
1185                  * WARNING: one or two older ATA drives treat 0 as 0...
1186                  */
1187                 goto nothing_to_do;
1188
1189         if ((dev->flags & (ATA_DFLAG_PIO | ATA_DFLAG_NCQ)) == ATA_DFLAG_NCQ) {
1190                 /* yay, NCQ */
1191                 if (!lba_48_ok(block, n_block))
1192                         goto out_of_range;
1193
1194                 tf->protocol = ATA_PROT_NCQ;
1195                 tf->flags |= ATA_TFLAG_LBA | ATA_TFLAG_LBA48;
1196
1197                 if (tf->flags & ATA_TFLAG_WRITE)
1198                         tf->command = ATA_CMD_FPDMA_WRITE;
1199                 else
1200                         tf->command = ATA_CMD_FPDMA_READ;
1201
1202                 qc->nsect = n_block;
1203
1204                 tf->nsect = qc->tag << 3;
1205                 tf->hob_feature = (n_block >> 8) & 0xff;
1206                 tf->feature = n_block & 0xff;
1207
1208                 tf->hob_lbah = (block >> 40) & 0xff;
1209                 tf->hob_lbam = (block >> 32) & 0xff;
1210                 tf->hob_lbal = (block >> 24) & 0xff;
1211                 tf->lbah = (block >> 16) & 0xff;
1212                 tf->lbam = (block >> 8) & 0xff;
1213                 tf->lbal = block & 0xff;
1214
1215                 tf->device = 1 << 6;
1216                 if (tf->flags & ATA_TFLAG_FUA)
1217                         tf->device |= 1 << 7;
1218         } else if (dev->flags & ATA_DFLAG_LBA) {
1219                 tf->flags |= ATA_TFLAG_LBA;
1220
1221                 if (lba_28_ok(block, n_block)) {
1222                         /* use LBA28 */
1223                         tf->device |= (block >> 24) & 0xf;
1224                 } else if (lba_48_ok(block, n_block)) {
1225                         if (!(dev->flags & ATA_DFLAG_LBA48))
1226                                 goto out_of_range;
1227
1228                         /* use LBA48 */
1229                         tf->flags |= ATA_TFLAG_LBA48;
1230
1231                         tf->hob_nsect = (n_block >> 8) & 0xff;
1232
1233                         tf->hob_lbah = (block >> 40) & 0xff;
1234                         tf->hob_lbam = (block >> 32) & 0xff;
1235                         tf->hob_lbal = (block >> 24) & 0xff;
1236                 } else
1237                         /* request too large even for LBA48 */
1238                         goto out_of_range;
1239
1240                 if (unlikely(ata_rwcmd_protocol(qc) < 0))
1241                         goto invalid_fld;
1242
1243                 qc->nsect = n_block;
1244                 tf->nsect = n_block & 0xff;
1245
1246                 tf->lbah = (block >> 16) & 0xff;
1247                 tf->lbam = (block >> 8) & 0xff;
1248                 tf->lbal = block & 0xff;
1249
1250                 tf->device |= ATA_LBA;
1251         } else {
1252                 /* CHS */
1253                 u32 sect, head, cyl, track;
1254
1255                 /* The request -may- be too large for CHS addressing. */
1256                 if (!lba_28_ok(block, n_block))
1257                         goto out_of_range;
1258
1259                 if (unlikely(ata_rwcmd_protocol(qc) < 0))
1260                         goto invalid_fld;
1261
1262                 /* Convert LBA to CHS */
1263                 track = (u32)block / dev->sectors;
1264                 cyl   = track / dev->heads;
1265                 head  = track % dev->heads;
1266                 sect  = (u32)block % dev->sectors + 1;
1267
1268                 DPRINTK("block %u track %u cyl %u head %u sect %u\n",
1269                         (u32)block, track, cyl, head, sect);
1270
1271                 /* Check whether the converted CHS can fit.
1272                    Cylinder: 0-65535
1273                    Head: 0-15
1274                    Sector: 1-255*/
1275                 if ((cyl >> 16) || (head >> 4) || (sect >> 8) || (!sect))
1276                         goto out_of_range;
1277
1278                 qc->nsect = n_block;
1279                 tf->nsect = n_block & 0xff; /* Sector count 0 means 256 sectors */
1280                 tf->lbal = sect;
1281                 tf->lbam = cyl;
1282                 tf->lbah = cyl >> 8;
1283                 tf->device |= head;
1284         }
1285
1286         return 0;
1287
1288 invalid_fld:
1289         ata_scsi_set_sense(qc->scsicmd, ILLEGAL_REQUEST, 0x24, 0x0);
1290         /* "Invalid field in cbd" */
1291         return 1;
1292
1293 out_of_range:
1294         ata_scsi_set_sense(qc->scsicmd, ILLEGAL_REQUEST, 0x21, 0x0);
1295         /* "Logical Block Address out of range" */
1296         return 1;
1297
1298 nothing_to_do:
1299         qc->scsicmd->result = SAM_STAT_GOOD;
1300         return 1;
1301 }
1302
1303 static void ata_scsi_qc_complete(struct ata_queued_cmd *qc)
1304 {
1305         struct scsi_cmnd *cmd = qc->scsicmd;
1306         u8 *cdb = cmd->cmnd;
1307         int need_sense = (qc->err_mask != 0);
1308
1309         /* We snoop the SET_FEATURES - Write Cache ON/OFF command, and
1310          * schedule EH_REVALIDATE operation to update the IDENTIFY DEVICE
1311          * cache
1312          */
1313         if (!need_sense && (qc->tf.command == ATA_CMD_SET_FEATURES) &&
1314             ((qc->tf.feature == SETFEATURES_WC_ON) ||
1315              (qc->tf.feature == SETFEATURES_WC_OFF))) {
1316                 qc->ap->eh_info.action |= ATA_EH_REVALIDATE;
1317                 ata_port_schedule_eh(qc->ap);
1318         }
1319
1320         /* For ATA pass thru (SAT) commands, generate a sense block if
1321          * user mandated it or if there's an error.  Note that if we
1322          * generate because the user forced us to, a check condition
1323          * is generated and the ATA register values are returned
1324          * whether the command completed successfully or not. If there
1325          * was no error, SK, ASC and ASCQ will all be zero.
1326          */
1327         if (((cdb[0] == ATA_16) || (cdb[0] == ATA_12)) &&
1328             ((cdb[2] & 0x20) || need_sense)) {
1329                 ata_gen_ata_desc_sense(qc);
1330         } else {
1331                 if (!need_sense) {
1332                         cmd->result = SAM_STAT_GOOD;
1333                 } else {
1334                         /* TODO: decide which descriptor format to use
1335                          * for 48b LBA devices and call that here
1336                          * instead of the fixed desc, which is only
1337                          * good for smaller LBA (and maybe CHS?)
1338                          * devices.
1339                          */
1340                         ata_gen_fixed_sense(qc);
1341                 }
1342         }
1343
1344         if (need_sense && !qc->ap->ops->error_handler)
1345                 ata_dump_status(qc->ap->id, &qc->result_tf);
1346
1347         qc->scsidone(cmd);
1348
1349         ata_qc_free(qc);
1350 }
1351
1352 /**
1353  *      ata_scmd_need_defer - Check whether we need to defer scmd
1354  *      @dev: ATA device to which the command is addressed
1355  *      @is_io: Is the command IO (and thus possibly NCQ)?
1356  *
1357  *      NCQ and non-NCQ commands cannot run together.  As upper layer
1358  *      only knows the queue depth, we are responsible for maintaining
1359  *      exclusion.  This function checks whether a new command can be
1360  *      issued to @dev.
1361  *
1362  *      LOCKING:
1363  *      spin_lock_irqsave(host_set lock)
1364  *
1365  *      RETURNS:
1366  *      1 if deferring is needed, 0 otherwise.
1367  */
1368 static int ata_scmd_need_defer(struct ata_device *dev, int is_io)
1369 {
1370         struct ata_port *ap = dev->ap;
1371
1372         if (!(dev->flags & ATA_DFLAG_NCQ))
1373                 return 0;
1374
1375         if (is_io) {
1376                 if (!ata_tag_valid(ap->active_tag))
1377                         return 0;
1378         } else {
1379                 if (!ata_tag_valid(ap->active_tag) && !ap->sactive)
1380                         return 0;
1381         }
1382         return 1;
1383 }
1384
1385 /**
1386  *      ata_scsi_translate - Translate then issue SCSI command to ATA device
1387  *      @dev: ATA device to which the command is addressed
1388  *      @cmd: SCSI command to execute
1389  *      @done: SCSI command completion function
1390  *      @xlat_func: Actor which translates @cmd to an ATA taskfile
1391  *
1392  *      Our ->queuecommand() function has decided that the SCSI
1393  *      command issued can be directly translated into an ATA
1394  *      command, rather than handled internally.
1395  *
1396  *      This function sets up an ata_queued_cmd structure for the
1397  *      SCSI command, and sends that ata_queued_cmd to the hardware.
1398  *
1399  *      The xlat_func argument (actor) returns 0 if ready to execute
1400  *      ATA command, else 1 to finish translation. If 1 is returned
1401  *      then cmd->result (and possibly cmd->sense_buffer) are assumed
1402  *      to be set reflecting an error condition or clean (early)
1403  *      termination.
1404  *
1405  *      LOCKING:
1406  *      spin_lock_irqsave(host_set lock)
1407  *
1408  *      RETURNS:
1409  *      0 on success, SCSI_ML_QUEUE_DEVICE_BUSY if the command
1410  *      needs to be deferred.
1411  */
1412 static int ata_scsi_translate(struct ata_device *dev, struct scsi_cmnd *cmd,
1413                               void (*done)(struct scsi_cmnd *),
1414                               ata_xlat_func_t xlat_func)
1415 {
1416         struct ata_queued_cmd *qc;
1417         u8 *scsicmd = cmd->cmnd;
1418         int is_io = xlat_func == ata_scsi_rw_xlat;
1419
1420         VPRINTK("ENTER\n");
1421
1422         if (unlikely(ata_scmd_need_defer(dev, is_io)))
1423                 goto defer;
1424
1425         qc = ata_scsi_qc_new(dev, cmd, done);
1426         if (!qc)
1427                 goto err_mem;
1428
1429         /* data is present; dma-map it */
1430         if (cmd->sc_data_direction == DMA_FROM_DEVICE ||
1431             cmd->sc_data_direction == DMA_TO_DEVICE) {
1432                 if (unlikely(cmd->request_bufflen < 1)) {
1433                         ata_dev_printk(dev, KERN_WARNING,
1434                                        "WARNING: zero len r/w req\n");
1435                         goto err_did;
1436                 }
1437
1438                 if (cmd->use_sg)
1439                         ata_sg_init(qc, cmd->request_buffer, cmd->use_sg);
1440                 else
1441                         ata_sg_init_one(qc, cmd->request_buffer,
1442                                         cmd->request_bufflen);
1443
1444                 qc->dma_dir = cmd->sc_data_direction;
1445         }
1446
1447         qc->complete_fn = ata_scsi_qc_complete;
1448
1449         if (xlat_func(qc, scsicmd))
1450                 goto early_finish;
1451
1452         /* select device, send command to hardware */
1453         ata_qc_issue(qc);
1454
1455         VPRINTK("EXIT\n");
1456         return 0;
1457
1458 early_finish:
1459         ata_qc_free(qc);
1460         done(cmd);
1461         DPRINTK("EXIT - early finish (good or error)\n");
1462         return 0;
1463
1464 err_did:
1465         ata_qc_free(qc);
1466 err_mem:
1467         cmd->result = (DID_ERROR << 16);
1468         done(cmd);
1469         DPRINTK("EXIT - internal\n");
1470         return 0;
1471
1472 defer:
1473         DPRINTK("EXIT - defer\n");
1474         return SCSI_MLQUEUE_DEVICE_BUSY;
1475 }
1476
1477 /**
1478  *      ata_scsi_rbuf_get - Map response buffer.
1479  *      @cmd: SCSI command containing buffer to be mapped.
1480  *      @buf_out: Pointer to mapped area.
1481  *
1482  *      Maps buffer contained within SCSI command @cmd.
1483  *
1484  *      LOCKING:
1485  *      spin_lock_irqsave(host_set lock)
1486  *
1487  *      RETURNS:
1488  *      Length of response buffer.
1489  */
1490
1491 static unsigned int ata_scsi_rbuf_get(struct scsi_cmnd *cmd, u8 **buf_out)
1492 {
1493         u8 *buf;
1494         unsigned int buflen;
1495
1496         if (cmd->use_sg) {
1497                 struct scatterlist *sg;
1498
1499                 sg = (struct scatterlist *) cmd->request_buffer;
1500                 buf = kmap_atomic(sg->page, KM_USER0) + sg->offset;
1501                 buflen = sg->length;
1502         } else {
1503                 buf = cmd->request_buffer;
1504                 buflen = cmd->request_bufflen;
1505         }
1506
1507         *buf_out = buf;
1508         return buflen;
1509 }
1510
1511 /**
1512  *      ata_scsi_rbuf_put - Unmap response buffer.
1513  *      @cmd: SCSI command containing buffer to be unmapped.
1514  *      @buf: buffer to unmap
1515  *
1516  *      Unmaps response buffer contained within @cmd.
1517  *
1518  *      LOCKING:
1519  *      spin_lock_irqsave(host_set lock)
1520  */
1521
1522 static inline void ata_scsi_rbuf_put(struct scsi_cmnd *cmd, u8 *buf)
1523 {
1524         if (cmd->use_sg) {
1525                 struct scatterlist *sg;
1526
1527                 sg = (struct scatterlist *) cmd->request_buffer;
1528                 kunmap_atomic(buf - sg->offset, KM_USER0);
1529         }
1530 }
1531
1532 /**
1533  *      ata_scsi_rbuf_fill - wrapper for SCSI command simulators
1534  *      @args: device IDENTIFY data / SCSI command of interest.
1535  *      @actor: Callback hook for desired SCSI command simulator
1536  *
1537  *      Takes care of the hard work of simulating a SCSI command...
1538  *      Mapping the response buffer, calling the command's handler,
1539  *      and handling the handler's return value.  This return value
1540  *      indicates whether the handler wishes the SCSI command to be
1541  *      completed successfully (0), or not (in which case cmd->result
1542  *      and sense buffer are assumed to be set).
1543  *
1544  *      LOCKING:
1545  *      spin_lock_irqsave(host_set lock)
1546  */
1547
1548 void ata_scsi_rbuf_fill(struct ata_scsi_args *args,
1549                         unsigned int (*actor) (struct ata_scsi_args *args,
1550                                            u8 *rbuf, unsigned int buflen))
1551 {
1552         u8 *rbuf;
1553         unsigned int buflen, rc;
1554         struct scsi_cmnd *cmd = args->cmd;
1555
1556         buflen = ata_scsi_rbuf_get(cmd, &rbuf);
1557         memset(rbuf, 0, buflen);
1558         rc = actor(args, rbuf, buflen);
1559         ata_scsi_rbuf_put(cmd, rbuf);
1560
1561         if (rc == 0)
1562                 cmd->result = SAM_STAT_GOOD;
1563         args->done(cmd);
1564 }
1565
1566 /**
1567  *      ata_scsiop_inq_std - Simulate INQUIRY command
1568  *      @args: device IDENTIFY data / SCSI command of interest.
1569  *      @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1570  *      @buflen: Response buffer length.
1571  *
1572  *      Returns standard device identification data associated
1573  *      with non-VPD INQUIRY command output.
1574  *
1575  *      LOCKING:
1576  *      spin_lock_irqsave(host_set lock)
1577  */
1578
1579 unsigned int ata_scsiop_inq_std(struct ata_scsi_args *args, u8 *rbuf,
1580                                unsigned int buflen)
1581 {
1582         u8 hdr[] = {
1583                 TYPE_DISK,
1584                 0,
1585                 0x5,    /* claim SPC-3 version compatibility */
1586                 2,
1587                 95 - 4
1588         };
1589
1590         /* set scsi removeable (RMB) bit per ata bit */
1591         if (ata_id_removeable(args->id))
1592                 hdr[1] |= (1 << 7);
1593
1594         VPRINTK("ENTER\n");
1595
1596         memcpy(rbuf, hdr, sizeof(hdr));
1597
1598         if (buflen > 35) {
1599                 memcpy(&rbuf[8], "ATA     ", 8);
1600                 ata_id_string(args->id, &rbuf[16], ATA_ID_PROD_OFS, 16);
1601                 ata_id_string(args->id, &rbuf[32], ATA_ID_FW_REV_OFS, 4);
1602                 if (rbuf[32] == 0 || rbuf[32] == ' ')
1603                         memcpy(&rbuf[32], "n/a ", 4);
1604         }
1605
1606         if (buflen > 63) {
1607                 const u8 versions[] = {
1608                         0x60,   /* SAM-3 (no version claimed) */
1609
1610                         0x03,
1611                         0x20,   /* SBC-2 (no version claimed) */
1612
1613                         0x02,
1614                         0x60    /* SPC-3 (no version claimed) */
1615                 };
1616
1617                 memcpy(rbuf + 59, versions, sizeof(versions));
1618         }
1619
1620         return 0;
1621 }
1622
1623 /**
1624  *      ata_scsiop_inq_00 - Simulate INQUIRY VPD page 0, list of pages
1625  *      @args: device IDENTIFY data / SCSI command of interest.
1626  *      @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1627  *      @buflen: Response buffer length.
1628  *
1629  *      Returns list of inquiry VPD pages available.
1630  *
1631  *      LOCKING:
1632  *      spin_lock_irqsave(host_set lock)
1633  */
1634
1635 unsigned int ata_scsiop_inq_00(struct ata_scsi_args *args, u8 *rbuf,
1636                               unsigned int buflen)
1637 {
1638         const u8 pages[] = {
1639                 0x00,   /* page 0x00, this page */
1640                 0x80,   /* page 0x80, unit serial no page */
1641                 0x83    /* page 0x83, device ident page */
1642         };
1643         rbuf[3] = sizeof(pages);        /* number of supported VPD pages */
1644
1645         if (buflen > 6)
1646                 memcpy(rbuf + 4, pages, sizeof(pages));
1647
1648         return 0;
1649 }
1650
1651 /**
1652  *      ata_scsiop_inq_80 - Simulate INQUIRY VPD page 80, device serial number
1653  *      @args: device IDENTIFY data / SCSI command of interest.
1654  *      @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1655  *      @buflen: Response buffer length.
1656  *
1657  *      Returns ATA device serial number.
1658  *
1659  *      LOCKING:
1660  *      spin_lock_irqsave(host_set lock)
1661  */
1662
1663 unsigned int ata_scsiop_inq_80(struct ata_scsi_args *args, u8 *rbuf,
1664                               unsigned int buflen)
1665 {
1666         const u8 hdr[] = {
1667                 0,
1668                 0x80,                   /* this page code */
1669                 0,
1670                 ATA_SERNO_LEN,          /* page len */
1671         };
1672         memcpy(rbuf, hdr, sizeof(hdr));
1673
1674         if (buflen > (ATA_SERNO_LEN + 4 - 1))
1675                 ata_id_string(args->id, (unsigned char *) &rbuf[4],
1676                               ATA_ID_SERNO_OFS, ATA_SERNO_LEN);
1677
1678         return 0;
1679 }
1680
1681 /**
1682  *      ata_scsiop_inq_83 - Simulate INQUIRY VPD page 83, device identity
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  *      Yields two logical unit device identification designators:
1688  *       - vendor specific ASCII containing the ATA serial number
1689  *       - SAT defined "t10 vendor id based" containing ASCII vendor
1690  *         name ("ATA     "), model and serial numbers.
1691  *
1692  *      LOCKING:
1693  *      spin_lock_irqsave(host_set lock)
1694  */
1695
1696 unsigned int ata_scsiop_inq_83(struct ata_scsi_args *args, u8 *rbuf,
1697                               unsigned int buflen)
1698 {
1699         int num;
1700         const int sat_model_serial_desc_len = 68;
1701         const int ata_model_byte_len = 40;
1702
1703         rbuf[1] = 0x83;                 /* this page code */
1704         num = 4;
1705
1706         if (buflen > (ATA_SERNO_LEN + num + 3)) {
1707                 /* piv=0, assoc=lu, code_set=ACSII, designator=vendor */
1708                 rbuf[num + 0] = 2;
1709                 rbuf[num + 3] = ATA_SERNO_LEN;
1710                 num += 4;
1711                 ata_id_string(args->id, (unsigned char *) rbuf + num,
1712                               ATA_ID_SERNO_OFS, ATA_SERNO_LEN);
1713                 num += ATA_SERNO_LEN;
1714         }
1715         if (buflen > (sat_model_serial_desc_len + num + 3)) {
1716                 /* SAT defined lu model and serial numbers descriptor */
1717                 /* piv=0, assoc=lu, code_set=ACSII, designator=t10 vendor id */
1718                 rbuf[num + 0] = 2;
1719                 rbuf[num + 1] = 1;
1720                 rbuf[num + 3] = sat_model_serial_desc_len;
1721                 num += 4;
1722                 memcpy(rbuf + num, "ATA     ", 8);
1723                 num += 8;
1724                 ata_id_string(args->id, (unsigned char *) rbuf + num,
1725                               ATA_ID_PROD_OFS, ata_model_byte_len);
1726                 num += ata_model_byte_len;
1727                 ata_id_string(args->id, (unsigned char *) rbuf + num,
1728                               ATA_ID_SERNO_OFS, ATA_SERNO_LEN);
1729                 num += ATA_SERNO_LEN;
1730         }
1731         rbuf[3] = num - 4;    /* page len (assume less than 256 bytes) */
1732         return 0;
1733 }
1734
1735 /**
1736  *      ata_scsiop_noop - Command handler that simply returns success.
1737  *      @args: device IDENTIFY data / SCSI command of interest.
1738  *      @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1739  *      @buflen: Response buffer length.
1740  *
1741  *      No operation.  Simply returns success to caller, to indicate
1742  *      that the caller should successfully complete this SCSI command.
1743  *
1744  *      LOCKING:
1745  *      spin_lock_irqsave(host_set lock)
1746  */
1747
1748 unsigned int ata_scsiop_noop(struct ata_scsi_args *args, u8 *rbuf,
1749                             unsigned int buflen)
1750 {
1751         VPRINTK("ENTER\n");
1752         return 0;
1753 }
1754
1755 /**
1756  *      ata_msense_push - Push data onto MODE SENSE data output buffer
1757  *      @ptr_io: (input/output) Location to store more output data
1758  *      @last: End of output data buffer
1759  *      @buf: Pointer to BLOB being added to output buffer
1760  *      @buflen: Length of BLOB
1761  *
1762  *      Store MODE SENSE data on an output buffer.
1763  *
1764  *      LOCKING:
1765  *      None.
1766  */
1767
1768 static void ata_msense_push(u8 **ptr_io, const u8 *last,
1769                             const u8 *buf, unsigned int buflen)
1770 {
1771         u8 *ptr = *ptr_io;
1772
1773         if ((ptr + buflen - 1) > last)
1774                 return;
1775
1776         memcpy(ptr, buf, buflen);
1777
1778         ptr += buflen;
1779
1780         *ptr_io = ptr;
1781 }
1782
1783 /**
1784  *      ata_msense_caching - Simulate MODE SENSE caching info page
1785  *      @id: device IDENTIFY data
1786  *      @ptr_io: (input/output) Location to store more output data
1787  *      @last: End of output data buffer
1788  *
1789  *      Generate a caching info page, which conditionally indicates
1790  *      write caching to the SCSI layer, depending on device
1791  *      capabilities.
1792  *
1793  *      LOCKING:
1794  *      None.
1795  */
1796
1797 static unsigned int ata_msense_caching(u16 *id, u8 **ptr_io,
1798                                        const u8 *last)
1799 {
1800         u8 page[CACHE_MPAGE_LEN];
1801
1802         memcpy(page, def_cache_mpage, sizeof(page));
1803         if (ata_id_wcache_enabled(id))
1804                 page[2] |= (1 << 2);    /* write cache enable */
1805         if (!ata_id_rahead_enabled(id))
1806                 page[12] |= (1 << 5);   /* disable read ahead */
1807
1808         ata_msense_push(ptr_io, last, page, sizeof(page));
1809         return sizeof(page);
1810 }
1811
1812 /**
1813  *      ata_msense_ctl_mode - Simulate MODE SENSE control mode page
1814  *      @dev: Device associated with this MODE SENSE command
1815  *      @ptr_io: (input/output) Location to store more output data
1816  *      @last: End of output data buffer
1817  *
1818  *      Generate a generic MODE SENSE control mode page.
1819  *
1820  *      LOCKING:
1821  *      None.
1822  */
1823
1824 static unsigned int ata_msense_ctl_mode(u8 **ptr_io, const u8 *last)
1825 {
1826         ata_msense_push(ptr_io, last, def_control_mpage,
1827                         sizeof(def_control_mpage));
1828         return sizeof(def_control_mpage);
1829 }
1830
1831 /**
1832  *      ata_msense_rw_recovery - Simulate MODE SENSE r/w error recovery page
1833  *      @dev: Device associated with this MODE SENSE command
1834  *      @ptr_io: (input/output) Location to store more output data
1835  *      @last: End of output data buffer
1836  *
1837  *      Generate a generic MODE SENSE r/w error recovery page.
1838  *
1839  *      LOCKING:
1840  *      None.
1841  */
1842
1843 static unsigned int ata_msense_rw_recovery(u8 **ptr_io, const u8 *last)
1844 {
1845
1846         ata_msense_push(ptr_io, last, def_rw_recovery_mpage,
1847                         sizeof(def_rw_recovery_mpage));
1848         return sizeof(def_rw_recovery_mpage);
1849 }
1850
1851 /*
1852  * We can turn this into a real blacklist if it's needed, for now just
1853  * blacklist any Maxtor BANC1G10 revision firmware
1854  */
1855 static int ata_dev_supports_fua(u16 *id)
1856 {
1857         unsigned char model[41], fw[9];
1858
1859         if (!libata_fua)
1860                 return 0;
1861         if (!ata_id_has_fua(id))
1862                 return 0;
1863
1864         ata_id_c_string(id, model, ATA_ID_PROD_OFS, sizeof(model));
1865         ata_id_c_string(id, fw, ATA_ID_FW_REV_OFS, sizeof(fw));
1866
1867         if (strcmp(model, "Maxtor"))
1868                 return 1;
1869         if (strcmp(fw, "BANC1G10"))
1870                 return 1;
1871
1872         return 0; /* blacklisted */
1873 }
1874
1875 /**
1876  *      ata_scsiop_mode_sense - Simulate MODE SENSE 6, 10 commands
1877  *      @args: device IDENTIFY data / SCSI command of interest.
1878  *      @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1879  *      @buflen: Response buffer length.
1880  *
1881  *      Simulate MODE SENSE commands. Assume this is invoked for direct
1882  *      access devices (e.g. disks) only. There should be no block
1883  *      descriptor for other device types.
1884  *
1885  *      LOCKING:
1886  *      spin_lock_irqsave(host_set lock)
1887  */
1888
1889 unsigned int ata_scsiop_mode_sense(struct ata_scsi_args *args, u8 *rbuf,
1890                                   unsigned int buflen)
1891 {
1892         struct ata_device *dev = args->dev;
1893         u8 *scsicmd = args->cmd->cmnd, *p, *last;
1894         const u8 sat_blk_desc[] = {
1895                 0, 0, 0, 0,     /* number of blocks: sat unspecified */
1896                 0,
1897                 0, 0x2, 0x0     /* block length: 512 bytes */
1898         };
1899         u8 pg, spg;
1900         unsigned int ebd, page_control, six_byte, output_len, alloc_len, minlen;
1901         u8 dpofua;
1902
1903         VPRINTK("ENTER\n");
1904
1905         six_byte = (scsicmd[0] == MODE_SENSE);
1906         ebd = !(scsicmd[1] & 0x8);      /* dbd bit inverted == edb */
1907         /*
1908          * LLBA bit in msense(10) ignored (compliant)
1909          */
1910
1911         page_control = scsicmd[2] >> 6;
1912         switch (page_control) {
1913         case 0: /* current */
1914                 break;  /* supported */
1915         case 3: /* saved */
1916                 goto saving_not_supp;
1917         case 1: /* changeable */
1918         case 2: /* defaults */
1919         default:
1920                 goto invalid_fld;
1921         }
1922
1923         if (six_byte) {
1924                 output_len = 4 + (ebd ? 8 : 0);
1925                 alloc_len = scsicmd[4];
1926         } else {
1927                 output_len = 8 + (ebd ? 8 : 0);
1928                 alloc_len = (scsicmd[7] << 8) + scsicmd[8];
1929         }
1930         minlen = (alloc_len < buflen) ? alloc_len : buflen;
1931
1932         p = rbuf + output_len;
1933         last = rbuf + minlen - 1;
1934
1935         pg = scsicmd[2] & 0x3f;
1936         spg = scsicmd[3];
1937         /*
1938          * No mode subpages supported (yet) but asking for _all_
1939          * subpages may be valid
1940          */
1941         if (spg && (spg != ALL_SUB_MPAGES))
1942                 goto invalid_fld;
1943
1944         switch(pg) {
1945         case RW_RECOVERY_MPAGE:
1946                 output_len += ata_msense_rw_recovery(&p, last);
1947                 break;
1948
1949         case CACHE_MPAGE:
1950                 output_len += ata_msense_caching(args->id, &p, last);
1951                 break;
1952
1953         case CONTROL_MPAGE: {
1954                 output_len += ata_msense_ctl_mode(&p, last);
1955                 break;
1956                 }
1957
1958         case ALL_MPAGES:
1959                 output_len += ata_msense_rw_recovery(&p, last);
1960                 output_len += ata_msense_caching(args->id, &p, last);
1961                 output_len += ata_msense_ctl_mode(&p, last);
1962                 break;
1963
1964         default:                /* invalid page code */
1965                 goto invalid_fld;
1966         }
1967
1968         if (minlen < 1)
1969                 return 0;
1970
1971         dpofua = 0;
1972         if (ata_dev_supports_fua(args->id) && (dev->flags & ATA_DFLAG_LBA48) &&
1973             (!(dev->flags & ATA_DFLAG_PIO) || dev->multi_count))
1974                 dpofua = 1 << 4;
1975
1976         if (six_byte) {
1977                 output_len--;
1978                 rbuf[0] = output_len;
1979                 if (minlen > 2)
1980                         rbuf[2] |= dpofua;
1981                 if (ebd) {
1982                         if (minlen > 3)
1983                                 rbuf[3] = sizeof(sat_blk_desc);
1984                         if (minlen > 11)
1985                                 memcpy(rbuf + 4, sat_blk_desc,
1986                                        sizeof(sat_blk_desc));
1987                 }
1988         } else {
1989                 output_len -= 2;
1990                 rbuf[0] = output_len >> 8;
1991                 if (minlen > 1)
1992                         rbuf[1] = output_len;
1993                 if (minlen > 3)
1994                         rbuf[3] |= dpofua;
1995                 if (ebd) {
1996                         if (minlen > 7)
1997                                 rbuf[7] = sizeof(sat_blk_desc);
1998                         if (minlen > 15)
1999                                 memcpy(rbuf + 8, sat_blk_desc,
2000                                        sizeof(sat_blk_desc));
2001                 }
2002         }
2003         return 0;
2004
2005 invalid_fld:
2006         ata_scsi_set_sense(args->cmd, ILLEGAL_REQUEST, 0x24, 0x0);
2007         /* "Invalid field in cbd" */
2008         return 1;
2009
2010 saving_not_supp:
2011         ata_scsi_set_sense(args->cmd, ILLEGAL_REQUEST, 0x39, 0x0);
2012          /* "Saving parameters not supported" */
2013         return 1;
2014 }
2015
2016 /**
2017  *      ata_scsiop_read_cap - Simulate READ CAPACITY[ 16] commands
2018  *      @args: device IDENTIFY data / SCSI command of interest.
2019  *      @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2020  *      @buflen: Response buffer length.
2021  *
2022  *      Simulate READ CAPACITY commands.
2023  *
2024  *      LOCKING:
2025  *      spin_lock_irqsave(host_set lock)
2026  */
2027
2028 unsigned int ata_scsiop_read_cap(struct ata_scsi_args *args, u8 *rbuf,
2029                                 unsigned int buflen)
2030 {
2031         u64 n_sectors;
2032         u32 tmp;
2033
2034         VPRINTK("ENTER\n");
2035
2036         if (ata_id_has_lba(args->id)) {
2037                 if (ata_id_has_lba48(args->id))
2038                         n_sectors = ata_id_u64(args->id, 100);
2039                 else
2040                         n_sectors = ata_id_u32(args->id, 60);
2041         } else {
2042                 /* CHS default translation */
2043                 n_sectors = args->id[1] * args->id[3] * args->id[6];
2044
2045                 if (ata_id_current_chs_valid(args->id))
2046                         /* CHS current translation */
2047                         n_sectors = ata_id_u32(args->id, 57);
2048         }
2049
2050         n_sectors--;            /* ATA TotalUserSectors - 1 */
2051
2052         if (args->cmd->cmnd[0] == READ_CAPACITY) {
2053                 if( n_sectors >= 0xffffffffULL )
2054                         tmp = 0xffffffff ;  /* Return max count on overflow */
2055                 else
2056                         tmp = n_sectors ;
2057
2058                 /* sector count, 32-bit */
2059                 rbuf[0] = tmp >> (8 * 3);
2060                 rbuf[1] = tmp >> (8 * 2);
2061                 rbuf[2] = tmp >> (8 * 1);
2062                 rbuf[3] = tmp;
2063
2064                 /* sector size */
2065                 tmp = ATA_SECT_SIZE;
2066                 rbuf[6] = tmp >> 8;
2067                 rbuf[7] = tmp;
2068
2069         } else {
2070                 /* sector count, 64-bit */
2071                 tmp = n_sectors >> (8 * 4);
2072                 rbuf[2] = tmp >> (8 * 3);
2073                 rbuf[3] = tmp >> (8 * 2);
2074                 rbuf[4] = tmp >> (8 * 1);
2075                 rbuf[5] = tmp;
2076                 tmp = n_sectors;
2077                 rbuf[6] = tmp >> (8 * 3);
2078                 rbuf[7] = tmp >> (8 * 2);
2079                 rbuf[8] = tmp >> (8 * 1);
2080                 rbuf[9] = tmp;
2081
2082                 /* sector size */
2083                 tmp = ATA_SECT_SIZE;
2084                 rbuf[12] = tmp >> 8;
2085                 rbuf[13] = tmp;
2086         }
2087
2088         return 0;
2089 }
2090
2091 /**
2092  *      ata_scsiop_report_luns - Simulate REPORT LUNS command
2093  *      @args: device IDENTIFY data / SCSI command of interest.
2094  *      @rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2095  *      @buflen: Response buffer length.
2096  *
2097  *      Simulate REPORT LUNS command.
2098  *
2099  *      LOCKING:
2100  *      spin_lock_irqsave(host_set lock)
2101  */
2102
2103 unsigned int ata_scsiop_report_luns(struct ata_scsi_args *args, u8 *rbuf,
2104                                    unsigned int buflen)
2105 {
2106         VPRINTK("ENTER\n");
2107         rbuf[3] = 8;    /* just one lun, LUN 0, size 8 bytes */
2108
2109         return 0;
2110 }
2111
2112 /**
2113  *      ata_scsi_set_sense - Set SCSI sense data and status
2114  *      @cmd: SCSI request to be handled
2115  *      @sk: SCSI-defined sense key
2116  *      @asc: SCSI-defined additional sense code
2117  *      @ascq: SCSI-defined additional sense code qualifier
2118  *
2119  *      Helper function that builds a valid fixed format, current
2120  *      response code and the given sense key (sk), additional sense
2121  *      code (asc) and additional sense code qualifier (ascq) with
2122  *      a SCSI command status of %SAM_STAT_CHECK_CONDITION and
2123  *      DRIVER_SENSE set in the upper bits of scsi_cmnd::result .
2124  *
2125  *      LOCKING:
2126  *      Not required
2127  */
2128
2129 void ata_scsi_set_sense(struct scsi_cmnd *cmd, u8 sk, u8 asc, u8 ascq)
2130 {
2131         cmd->result = (DRIVER_SENSE << 24) | SAM_STAT_CHECK_CONDITION;
2132
2133         cmd->sense_buffer[0] = 0x70;    /* fixed format, current */
2134         cmd->sense_buffer[2] = sk;
2135         cmd->sense_buffer[7] = 18 - 8;  /* additional sense length */
2136         cmd->sense_buffer[12] = asc;
2137         cmd->sense_buffer[13] = ascq;
2138 }
2139
2140 /**
2141  *      ata_scsi_badcmd - End a SCSI request with an error
2142  *      @cmd: SCSI request to be handled
2143  *      @done: SCSI command completion function
2144  *      @asc: SCSI-defined additional sense code
2145  *      @ascq: SCSI-defined additional sense code qualifier
2146  *
2147  *      Helper function that completes a SCSI command with
2148  *      %SAM_STAT_CHECK_CONDITION, with a sense key %ILLEGAL_REQUEST
2149  *      and the specified additional sense codes.
2150  *
2151  *      LOCKING:
2152  *      spin_lock_irqsave(host_set lock)
2153  */
2154
2155 void ata_scsi_badcmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *), u8 asc, u8 ascq)
2156 {
2157         DPRINTK("ENTER\n");
2158         ata_scsi_set_sense(cmd, ILLEGAL_REQUEST, asc, ascq);
2159
2160         done(cmd);
2161 }
2162
2163 static void atapi_sense_complete(struct ata_queued_cmd *qc)
2164 {
2165         if (qc->err_mask && ((qc->err_mask & AC_ERR_DEV) == 0)) {
2166                 /* FIXME: not quite right; we don't want the
2167                  * translation of taskfile registers into
2168                  * a sense descriptors, since that's only
2169                  * correct for ATA, not ATAPI
2170                  */
2171                 ata_gen_ata_desc_sense(qc);
2172         }
2173
2174         qc->scsidone(qc->scsicmd);
2175         ata_qc_free(qc);
2176 }
2177
2178 /* is it pointless to prefer PIO for "safety reasons"? */
2179 static inline int ata_pio_use_silly(struct ata_port *ap)
2180 {
2181         return (ap->flags & ATA_FLAG_PIO_DMA);
2182 }
2183
2184 static void atapi_request_sense(struct ata_queued_cmd *qc)
2185 {
2186         struct ata_port *ap = qc->ap;
2187         struct scsi_cmnd *cmd = qc->scsicmd;
2188
2189         DPRINTK("ATAPI request sense\n");
2190
2191         /* FIXME: is this needed? */
2192         memset(cmd->sense_buffer, 0, sizeof(cmd->sense_buffer));
2193
2194         ap->ops->tf_read(ap, &qc->tf);
2195
2196         /* fill these in, for the case where they are -not- overwritten */
2197         cmd->sense_buffer[0] = 0x70;
2198         cmd->sense_buffer[2] = qc->tf.feature >> 4;
2199
2200         ata_qc_reinit(qc);
2201
2202         ata_sg_init_one(qc, cmd->sense_buffer, sizeof(cmd->sense_buffer));
2203         qc->dma_dir = DMA_FROM_DEVICE;
2204
2205         memset(&qc->cdb, 0, qc->dev->cdb_len);
2206         qc->cdb[0] = REQUEST_SENSE;
2207         qc->cdb[4] = SCSI_SENSE_BUFFERSIZE;
2208
2209         qc->tf.flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
2210         qc->tf.command = ATA_CMD_PACKET;
2211
2212         if (ata_pio_use_silly(ap)) {
2213                 qc->tf.protocol = ATA_PROT_ATAPI_DMA;
2214                 qc->tf.feature |= ATAPI_PKT_DMA;
2215         } else {
2216                 qc->tf.protocol = ATA_PROT_ATAPI;
2217                 qc->tf.lbam = (8 * 1024) & 0xff;
2218                 qc->tf.lbah = (8 * 1024) >> 8;
2219         }
2220         qc->nbytes = SCSI_SENSE_BUFFERSIZE;
2221
2222         qc->complete_fn = atapi_sense_complete;
2223
2224         ata_qc_issue(qc);
2225
2226         DPRINTK("EXIT\n");
2227 }
2228
2229 static void atapi_qc_complete(struct ata_queued_cmd *qc)
2230 {
2231         struct scsi_cmnd *cmd = qc->scsicmd;
2232         unsigned int err_mask = qc->err_mask;
2233
2234         VPRINTK("ENTER, err_mask 0x%X\n", err_mask);
2235
2236         /* handle completion from new EH */
2237         if (unlikely(qc->ap->ops->error_handler &&
2238                      (err_mask || qc->flags & ATA_QCFLAG_SENSE_VALID))) {
2239
2240                 if (!(qc->flags & ATA_QCFLAG_SENSE_VALID)) {
2241                         /* FIXME: not quite right; we don't want the
2242                          * translation of taskfile registers into a
2243                          * sense descriptors, since that's only
2244                          * correct for ATA, not ATAPI
2245                          */
2246                         ata_gen_ata_desc_sense(qc);
2247                 }
2248
2249                 qc->scsicmd->result = SAM_STAT_CHECK_CONDITION;
2250                 qc->scsidone(cmd);
2251                 ata_qc_free(qc);
2252                 return;
2253         }
2254
2255         /* successful completion or old EH failure path */
2256         if (unlikely(err_mask & AC_ERR_DEV)) {
2257                 cmd->result = SAM_STAT_CHECK_CONDITION;
2258                 atapi_request_sense(qc);
2259                 return;
2260         } else if (unlikely(err_mask)) {
2261                 /* FIXME: not quite right; we don't want the
2262                  * translation of taskfile registers into
2263                  * a sense descriptors, since that's only
2264                  * correct for ATA, not ATAPI
2265                  */
2266                 ata_gen_ata_desc_sense(qc);
2267         } else {
2268                 u8 *scsicmd = cmd->cmnd;
2269
2270                 if ((scsicmd[0] == INQUIRY) && ((scsicmd[1] & 0x03) == 0)) {
2271                         u8 *buf = NULL;
2272                         unsigned int buflen;
2273
2274                         buflen = ata_scsi_rbuf_get(cmd, &buf);
2275
2276         /* ATAPI devices typically report zero for their SCSI version,
2277          * and sometimes deviate from the spec WRT response data
2278          * format.  If SCSI version is reported as zero like normal,
2279          * then we make the following fixups:  1) Fake MMC-5 version,
2280          * to indicate to the Linux scsi midlayer this is a modern
2281          * device.  2) Ensure response data format / ATAPI information
2282          * are always correct.
2283          */
2284                         if (buf[2] == 0) {
2285                                 buf[2] = 0x5;
2286                                 buf[3] = 0x32;
2287                         }
2288
2289                         ata_scsi_rbuf_put(cmd, buf);
2290                 }
2291
2292                 cmd->result = SAM_STAT_GOOD;
2293         }
2294
2295         qc->scsidone(cmd);
2296         ata_qc_free(qc);
2297 }
2298 /**
2299  *      atapi_xlat - Initialize PACKET taskfile
2300  *      @qc: command structure to be initialized
2301  *      @scsicmd: SCSI CDB associated with this PACKET command
2302  *
2303  *      LOCKING:
2304  *      spin_lock_irqsave(host_set lock)
2305  *
2306  *      RETURNS:
2307  *      Zero on success, non-zero on failure.
2308  */
2309
2310 static unsigned int atapi_xlat(struct ata_queued_cmd *qc, const u8 *scsicmd)
2311 {
2312         struct scsi_cmnd *cmd = qc->scsicmd;
2313         struct ata_device *dev = qc->dev;
2314         int using_pio = (dev->flags & ATA_DFLAG_PIO);
2315         int nodata = (cmd->sc_data_direction == DMA_NONE);
2316
2317         if (!using_pio)
2318                 /* Check whether ATAPI DMA is safe */
2319                 if (ata_check_atapi_dma(qc))
2320                         using_pio = 1;
2321
2322         memcpy(&qc->cdb, scsicmd, dev->cdb_len);
2323
2324         qc->complete_fn = atapi_qc_complete;
2325
2326         qc->tf.flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
2327         if (cmd->sc_data_direction == DMA_TO_DEVICE) {
2328                 qc->tf.flags |= ATA_TFLAG_WRITE;
2329                 DPRINTK("direction: write\n");
2330         }
2331
2332         qc->tf.command = ATA_CMD_PACKET;
2333
2334         /* no data, or PIO data xfer */
2335         if (using_pio || nodata) {
2336                 if (nodata)
2337                         qc->tf.protocol = ATA_PROT_ATAPI_NODATA;
2338                 else
2339                         qc->tf.protocol = ATA_PROT_ATAPI;
2340                 qc->tf.lbam = (8 * 1024) & 0xff;
2341                 qc->tf.lbah = (8 * 1024) >> 8;
2342         }
2343
2344         /* DMA data xfer */
2345         else {
2346                 qc->tf.protocol = ATA_PROT_ATAPI_DMA;
2347                 qc->tf.feature |= ATAPI_PKT_DMA;
2348
2349                 if (atapi_dmadir && (cmd->sc_data_direction != DMA_TO_DEVICE))
2350                         /* some SATA bridges need us to indicate data xfer direction */
2351                         qc->tf.feature |= ATAPI_DMADIR;
2352         }
2353
2354         qc->nbytes = cmd->request_bufflen;
2355
2356         return 0;
2357 }
2358
2359 static struct ata_device * ata_find_dev(struct ata_port *ap, int id)
2360 {
2361         if (likely(id < ATA_MAX_DEVICES))
2362                 return &ap->device[id];
2363         return NULL;
2364 }
2365
2366 static struct ata_device * __ata_scsi_find_dev(struct ata_port *ap,
2367                                         const struct scsi_device *scsidev)
2368 {
2369         /* skip commands not addressed to targets we simulate */
2370         if (unlikely(scsidev->channel || scsidev->lun))
2371                 return NULL;
2372
2373         return ata_find_dev(ap, scsidev->id);
2374 }
2375
2376 /**
2377  *      ata_scsi_find_dev - lookup ata_device from scsi_cmnd
2378  *      @ap: ATA port to which the device is attached
2379  *      @scsidev: SCSI device from which we derive the ATA device
2380  *
2381  *      Given various information provided in struct scsi_cmnd,
2382  *      map that onto an ATA bus, and using that mapping
2383  *      determine which ata_device is associated with the
2384  *      SCSI command to be sent.
2385  *
2386  *      LOCKING:
2387  *      spin_lock_irqsave(host_set lock)
2388  *
2389  *      RETURNS:
2390  *      Associated ATA device, or %NULL if not found.
2391  */
2392 static struct ata_device *
2393 ata_scsi_find_dev(struct ata_port *ap, const struct scsi_device *scsidev)
2394 {
2395         struct ata_device *dev = __ata_scsi_find_dev(ap, scsidev);
2396
2397         if (unlikely(!dev || !ata_dev_enabled(dev)))
2398                 return NULL;
2399
2400         if (!atapi_enabled || (ap->flags & ATA_FLAG_NO_ATAPI)) {
2401                 if (unlikely(dev->class == ATA_DEV_ATAPI)) {
2402                         ata_dev_printk(dev, KERN_WARNING,
2403                                 "WARNING: ATAPI is %s, device ignored.\n",
2404                                 atapi_enabled ? "not supported with this driver" : "disabled");
2405                         return NULL;
2406                 }
2407         }
2408
2409         return dev;
2410 }
2411
2412 /*
2413  *      ata_scsi_map_proto - Map pass-thru protocol value to taskfile value.
2414  *      @byte1: Byte 1 from pass-thru CDB.
2415  *
2416  *      RETURNS:
2417  *      ATA_PROT_UNKNOWN if mapping failed/unimplemented, protocol otherwise.
2418  */
2419 static u8
2420 ata_scsi_map_proto(u8 byte1)
2421 {
2422         switch((byte1 & 0x1e) >> 1) {
2423                 case 3:         /* Non-data */
2424                         return ATA_PROT_NODATA;
2425
2426                 case 6:         /* DMA */
2427                         return ATA_PROT_DMA;
2428
2429                 case 4:         /* PIO Data-in */
2430                 case 5:         /* PIO Data-out */
2431                         return ATA_PROT_PIO;
2432
2433                 case 10:        /* Device Reset */
2434                 case 0:         /* Hard Reset */
2435                 case 1:         /* SRST */
2436                 case 2:         /* Bus Idle */
2437                 case 7:         /* Packet */
2438                 case 8:         /* DMA Queued */
2439                 case 9:         /* Device Diagnostic */
2440                 case 11:        /* UDMA Data-in */
2441                 case 12:        /* UDMA Data-Out */
2442                 case 13:        /* FPDMA */
2443                 default:        /* Reserved */
2444                         break;
2445         }
2446
2447         return ATA_PROT_UNKNOWN;
2448 }
2449
2450 /**
2451  *      ata_scsi_pass_thru - convert ATA pass-thru CDB to taskfile
2452  *      @qc: command structure to be initialized
2453  *      @scsicmd: SCSI command to convert
2454  *
2455  *      Handles either 12 or 16-byte versions of the CDB.
2456  *
2457  *      RETURNS:
2458  *      Zero on success, non-zero on failure.
2459  */
2460 static unsigned int
2461 ata_scsi_pass_thru(struct ata_queued_cmd *qc, const u8 *scsicmd)
2462 {
2463         struct ata_taskfile *tf = &(qc->tf);
2464         struct scsi_cmnd *cmd = qc->scsicmd;
2465         struct ata_device *dev = qc->dev;
2466
2467         if ((tf->protocol = ata_scsi_map_proto(scsicmd[1])) == ATA_PROT_UNKNOWN)
2468                 goto invalid_fld;
2469
2470         /* We may not issue DMA commands if no DMA mode is set */
2471         if (tf->protocol == ATA_PROT_DMA && dev->dma_mode == 0)
2472                 goto invalid_fld;
2473
2474         if (scsicmd[1] & 0xe0)
2475                 /* PIO multi not supported yet */
2476                 goto invalid_fld;
2477
2478         /*
2479          * 12 and 16 byte CDBs use different offsets to
2480          * provide the various register values.
2481          */
2482         if (scsicmd[0] == ATA_16) {
2483                 /*
2484                  * 16-byte CDB - may contain extended commands.
2485                  *
2486                  * If that is the case, copy the upper byte register values.
2487                  */
2488                 if (scsicmd[1] & 0x01) {
2489                         tf->hob_feature = scsicmd[3];
2490                         tf->hob_nsect = scsicmd[5];
2491                         tf->hob_lbal = scsicmd[7];
2492                         tf->hob_lbam = scsicmd[9];
2493                         tf->hob_lbah = scsicmd[11];
2494                         tf->flags |= ATA_TFLAG_LBA48;
2495                 } else
2496                         tf->flags &= ~ATA_TFLAG_LBA48;
2497
2498                 /*
2499                  * Always copy low byte, device and command registers.
2500                  */
2501                 tf->feature = scsicmd[4];
2502                 tf->nsect = scsicmd[6];
2503                 tf->lbal = scsicmd[8];
2504                 tf->lbam = scsicmd[10];
2505                 tf->lbah = scsicmd[12];
2506                 tf->device = scsicmd[13];
2507                 tf->command = scsicmd[14];
2508         } else {
2509                 /*
2510                  * 12-byte CDB - incapable of extended commands.
2511                  */
2512                 tf->flags &= ~ATA_TFLAG_LBA48;
2513
2514                 tf->feature = scsicmd[3];
2515                 tf->nsect = scsicmd[4];
2516                 tf->lbal = scsicmd[5];
2517                 tf->lbam = scsicmd[6];
2518                 tf->lbah = scsicmd[7];
2519                 tf->device = scsicmd[8];
2520                 tf->command = scsicmd[9];
2521         }
2522         /*
2523          * If slave is possible, enforce correct master/slave bit
2524         */
2525         if (qc->ap->flags & ATA_FLAG_SLAVE_POSS)
2526                 tf->device = qc->dev->devno ?
2527                         tf->device | ATA_DEV1 : tf->device & ~ATA_DEV1;
2528
2529         /*
2530          * Filter SET_FEATURES - XFER MODE command -- otherwise,
2531          * SET_FEATURES - XFER MODE must be preceded/succeeded
2532          * by an update to hardware-specific registers for each
2533          * controller (i.e. the reason for ->set_piomode(),
2534          * ->set_dmamode(), and ->post_set_mode() hooks).
2535          */
2536         if ((tf->command == ATA_CMD_SET_FEATURES)
2537          && (tf->feature == SETFEATURES_XFER))
2538                 goto invalid_fld;
2539
2540         /*
2541          * Set flags so that all registers will be written,
2542          * and pass on write indication (used for PIO/DMA
2543          * setup.)
2544          */
2545         tf->flags |= (ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE);
2546
2547         if (cmd->sc_data_direction == DMA_TO_DEVICE)
2548                 tf->flags |= ATA_TFLAG_WRITE;
2549
2550         /*
2551          * Set transfer length.
2552          *
2553          * TODO: find out if we need to do more here to
2554          *       cover scatter/gather case.
2555          */
2556         qc->nsect = cmd->request_bufflen / ATA_SECT_SIZE;
2557
2558         /* request result TF */
2559         qc->flags |= ATA_QCFLAG_RESULT_TF;
2560
2561         return 0;
2562
2563  invalid_fld:
2564         ata_scsi_set_sense(qc->scsicmd, ILLEGAL_REQUEST, 0x24, 0x00);
2565         /* "Invalid field in cdb" */
2566         return 1;
2567 }
2568
2569 /**
2570  *      ata_get_xlat_func - check if SCSI to ATA translation is possible
2571  *      @dev: ATA device
2572  *      @cmd: SCSI command opcode to consider
2573  *
2574  *      Look up the SCSI command given, and determine whether the
2575  *      SCSI command is to be translated or simulated.
2576  *
2577  *      RETURNS:
2578  *      Pointer to translation function if possible, %NULL if not.
2579  */
2580
2581 static inline ata_xlat_func_t ata_get_xlat_func(struct ata_device *dev, u8 cmd)
2582 {
2583         switch (cmd) {
2584         case READ_6:
2585         case READ_10:
2586         case READ_16:
2587
2588         case WRITE_6:
2589         case WRITE_10:
2590         case WRITE_16:
2591                 return ata_scsi_rw_xlat;
2592
2593         case SYNCHRONIZE_CACHE:
2594                 if (ata_try_flush_cache(dev))
2595                         return ata_scsi_flush_xlat;
2596                 break;
2597
2598         case VERIFY:
2599         case VERIFY_16:
2600                 return ata_scsi_verify_xlat;
2601
2602         case ATA_12:
2603         case ATA_16:
2604                 return ata_scsi_pass_thru;
2605
2606         case START_STOP:
2607                 return ata_scsi_start_stop_xlat;
2608         }
2609
2610         return NULL;
2611 }
2612
2613 /**
2614  *      ata_scsi_dump_cdb - dump SCSI command contents to dmesg
2615  *      @ap: ATA port to which the command was being sent
2616  *      @cmd: SCSI command to dump
2617  *
2618  *      Prints the contents of a SCSI command via printk().
2619  */
2620
2621 static inline void ata_scsi_dump_cdb(struct ata_port *ap,
2622                                      struct scsi_cmnd *cmd)
2623 {
2624 #ifdef ATA_DEBUG
2625         struct scsi_device *scsidev = cmd->device;
2626         u8 *scsicmd = cmd->cmnd;
2627
2628         DPRINTK("CDB (%u:%d,%d,%d) %02x %02x %02x %02x %02x %02x %02x %02x %02x\n",
2629                 ap->id,
2630                 scsidev->channel, scsidev->id, scsidev->lun,
2631                 scsicmd[0], scsicmd[1], scsicmd[2], scsicmd[3],
2632                 scsicmd[4], scsicmd[5], scsicmd[6], scsicmd[7],
2633                 scsicmd[8]);
2634 #endif
2635 }
2636
2637 static inline int __ata_scsi_queuecmd(struct scsi_cmnd *cmd,
2638                                       void (*done)(struct scsi_cmnd *),
2639                                       struct ata_device *dev)
2640 {
2641         int rc = 0;
2642
2643         if (dev->class == ATA_DEV_ATA) {
2644                 ata_xlat_func_t xlat_func = ata_get_xlat_func(dev,
2645                                                               cmd->cmnd[0]);
2646
2647                 if (xlat_func)
2648                         rc = ata_scsi_translate(dev, cmd, done, xlat_func);
2649                 else
2650                         ata_scsi_simulate(dev, cmd, done);
2651         } else
2652                 rc = ata_scsi_translate(dev, cmd, done, atapi_xlat);
2653
2654         return rc;
2655 }
2656
2657 /**
2658  *      ata_scsi_queuecmd - Issue SCSI cdb to libata-managed device
2659  *      @cmd: SCSI command to be sent
2660  *      @done: Completion function, called when command is complete
2661  *
2662  *      In some cases, this function translates SCSI commands into
2663  *      ATA taskfiles, and queues the taskfiles to be sent to
2664  *      hardware.  In other cases, this function simulates a
2665  *      SCSI device by evaluating and responding to certain
2666  *      SCSI commands.  This creates the overall effect of
2667  *      ATA and ATAPI devices appearing as SCSI devices.
2668  *
2669  *      LOCKING:
2670  *      Releases scsi-layer-held lock, and obtains host_set lock.
2671  *
2672  *      RETURNS:
2673  *      Return value from __ata_scsi_queuecmd() if @cmd can be queued,
2674  *      0 otherwise.
2675  */
2676 int ata_scsi_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *))
2677 {
2678         struct ata_port *ap;
2679         struct ata_device *dev;
2680         struct scsi_device *scsidev = cmd->device;
2681         struct Scsi_Host *shost = scsidev->host;
2682         int rc = 0;
2683
2684         ap = ata_shost_to_port(shost);
2685
2686         spin_unlock(shost->host_lock);
2687         spin_lock(&ap->host_set->lock);
2688
2689         ata_scsi_dump_cdb(ap, cmd);
2690
2691         dev = ata_scsi_find_dev(ap, scsidev);
2692         if (likely(dev))
2693                 rc = __ata_scsi_queuecmd(cmd, done, dev);
2694         else {
2695                 cmd->result = (DID_BAD_TARGET << 16);
2696                 done(cmd);
2697         }
2698
2699         spin_unlock(&ap->host_set->lock);
2700         spin_lock(shost->host_lock);
2701         return rc;
2702 }
2703
2704 /**
2705  *      ata_scsi_simulate - simulate SCSI command on ATA device
2706  *      @dev: the target device
2707  *      @cmd: SCSI command being sent to device.
2708  *      @done: SCSI command completion function.
2709  *
2710  *      Interprets and directly executes a select list of SCSI commands
2711  *      that can be handled internally.
2712  *
2713  *      LOCKING:
2714  *      spin_lock_irqsave(host_set lock)
2715  */
2716
2717 void ata_scsi_simulate(struct ata_device *dev, struct scsi_cmnd *cmd,
2718                       void (*done)(struct scsi_cmnd *))
2719 {
2720         struct ata_scsi_args args;
2721         const u8 *scsicmd = cmd->cmnd;
2722
2723         args.dev = dev;
2724         args.id = dev->id;
2725         args.cmd = cmd;
2726         args.done = done;
2727
2728         switch(scsicmd[0]) {
2729                 /* no-op's, complete with success */
2730                 case SYNCHRONIZE_CACHE:
2731                 case REZERO_UNIT:
2732                 case SEEK_6:
2733                 case SEEK_10:
2734                 case TEST_UNIT_READY:
2735                 case FORMAT_UNIT:               /* FIXME: correct? */
2736                 case SEND_DIAGNOSTIC:           /* FIXME: correct? */
2737                         ata_scsi_rbuf_fill(&args, ata_scsiop_noop);
2738                         break;
2739
2740                 case INQUIRY:
2741                         if (scsicmd[1] & 2)                /* is CmdDt set?  */
2742                                 ata_scsi_invalid_field(cmd, done);
2743                         else if ((scsicmd[1] & 1) == 0)    /* is EVPD clear? */
2744                                 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_std);
2745                         else if (scsicmd[2] == 0x00)
2746                                 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_00);
2747                         else if (scsicmd[2] == 0x80)
2748                                 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_80);
2749                         else if (scsicmd[2] == 0x83)
2750                                 ata_scsi_rbuf_fill(&args, ata_scsiop_inq_83);
2751                         else
2752                                 ata_scsi_invalid_field(cmd, done);
2753                         break;
2754
2755                 case MODE_SENSE:
2756                 case MODE_SENSE_10:
2757                         ata_scsi_rbuf_fill(&args, ata_scsiop_mode_sense);
2758                         break;
2759
2760                 case MODE_SELECT:       /* unconditionally return */
2761                 case MODE_SELECT_10:    /* bad-field-in-cdb */
2762                         ata_scsi_invalid_field(cmd, done);
2763                         break;
2764
2765                 case READ_CAPACITY:
2766                         ata_scsi_rbuf_fill(&args, ata_scsiop_read_cap);
2767                         break;
2768
2769                 case SERVICE_ACTION_IN:
2770                         if ((scsicmd[1] & 0x1f) == SAI_READ_CAPACITY_16)
2771                                 ata_scsi_rbuf_fill(&args, ata_scsiop_read_cap);
2772                         else
2773                                 ata_scsi_invalid_field(cmd, done);
2774                         break;
2775
2776                 case REPORT_LUNS:
2777                         ata_scsi_rbuf_fill(&args, ata_scsiop_report_luns);
2778                         break;
2779
2780                 /* mandatory commands we haven't implemented yet */
2781                 case REQUEST_SENSE:
2782
2783                 /* all other commands */
2784                 default:
2785                         ata_scsi_set_sense(cmd, ILLEGAL_REQUEST, 0x20, 0x0);
2786                         /* "Invalid command operation code" */
2787                         done(cmd);
2788                         break;
2789         }
2790 }
2791
2792 void ata_scsi_scan_host(struct ata_port *ap)
2793 {
2794         unsigned int i;
2795
2796         if (ap->flags & ATA_FLAG_DISABLED)
2797                 return;
2798
2799         for (i = 0; i < ATA_MAX_DEVICES; i++) {
2800                 struct ata_device *dev = &ap->device[i];
2801                 struct scsi_device *sdev;
2802
2803                 if (!ata_dev_enabled(dev) || dev->sdev)
2804                         continue;
2805
2806                 sdev = __scsi_add_device(ap->host, 0, i, 0, NULL);
2807                 if (!IS_ERR(sdev)) {
2808                         dev->sdev = sdev;
2809                         scsi_device_put(sdev);
2810                 }
2811         }
2812 }
2813
2814 /**
2815  *      ata_scsi_offline_dev - offline attached SCSI device
2816  *      @dev: ATA device to offline attached SCSI device for
2817  *
2818  *      This function is called from ata_eh_hotplug() and responsible
2819  *      for taking the SCSI device attached to @dev offline.  This
2820  *      function is called with host_set lock which protects dev->sdev
2821  *      against clearing.
2822  *
2823  *      LOCKING:
2824  *      spin_lock_irqsave(host_set lock)
2825  *
2826  *      RETURNS:
2827  *      1 if attached SCSI device exists, 0 otherwise.
2828  */
2829 int ata_scsi_offline_dev(struct ata_device *dev)
2830 {
2831         if (dev->sdev) {
2832                 scsi_device_set_state(dev->sdev, SDEV_OFFLINE);
2833                 return 1;
2834         }
2835         return 0;
2836 }
2837
2838 /**
2839  *      ata_scsi_remove_dev - remove attached SCSI device
2840  *      @dev: ATA device to remove attached SCSI device for
2841  *
2842  *      This function is called from ata_eh_scsi_hotplug() and
2843  *      responsible for removing the SCSI device attached to @dev.
2844  *
2845  *      LOCKING:
2846  *      Kernel thread context (may sleep).
2847  */
2848 static void ata_scsi_remove_dev(struct ata_device *dev)
2849 {
2850         struct ata_port *ap = dev->ap;
2851         struct scsi_device *sdev;
2852         unsigned long flags;
2853
2854         /* Alas, we need to grab scan_mutex to ensure SCSI device
2855          * state doesn't change underneath us and thus
2856          * scsi_device_get() always succeeds.  The mutex locking can
2857          * be removed if there is __scsi_device_get() interface which
2858          * increments reference counts regardless of device state.
2859          */
2860         mutex_lock(&ap->host->scan_mutex);
2861         spin_lock_irqsave(&ap->host_set->lock, flags);
2862
2863         /* clearing dev->sdev is protected by host_set lock */
2864         sdev = dev->sdev;
2865         dev->sdev = NULL;
2866
2867         if (sdev) {
2868                 /* If user initiated unplug races with us, sdev can go
2869                  * away underneath us after the host_set lock and
2870                  * scan_mutex are released.  Hold onto it.
2871                  */
2872                 if (scsi_device_get(sdev) == 0) {
2873                         /* The following ensures the attached sdev is
2874                          * offline on return from ata_scsi_offline_dev()
2875                          * regardless it wins or loses the race
2876                          * against this function.
2877                          */
2878                         scsi_device_set_state(sdev, SDEV_OFFLINE);
2879                 } else {
2880                         WARN_ON(1);
2881                         sdev = NULL;
2882                 }
2883         }
2884
2885         spin_unlock_irqrestore(&ap->host_set->lock, flags);
2886         mutex_unlock(&ap->host->scan_mutex);
2887
2888         if (sdev) {
2889                 ata_dev_printk(dev, KERN_INFO, "detaching (SCSI %s)\n",
2890                                sdev->sdev_gendev.bus_id);
2891
2892                 scsi_remove_device(sdev);
2893                 scsi_device_put(sdev);
2894         }
2895 }
2896
2897 /**
2898  *      ata_scsi_hotplug - SCSI part of hotplug
2899  *      @data: Pointer to ATA port to perform SCSI hotplug on
2900  *
2901  *      Perform SCSI part of hotplug.  It's executed from a separate
2902  *      workqueue after EH completes.  This is necessary because SCSI
2903  *      hot plugging requires working EH and hot unplugging is
2904  *      synchronized with hot plugging with a mutex.
2905  *
2906  *      LOCKING:
2907  *      Kernel thread context (may sleep).
2908  */
2909 void ata_scsi_hotplug(void *data)
2910 {
2911         struct ata_port *ap = data;
2912         int i;
2913
2914         if (ap->flags & ATA_FLAG_UNLOADING) {
2915                 DPRINTK("ENTER/EXIT - unloading\n");
2916                 return;
2917         }
2918
2919         DPRINTK("ENTER\n");
2920
2921         /* unplug detached devices */
2922         for (i = 0; i < ATA_MAX_DEVICES; i++) {
2923                 struct ata_device *dev = &ap->device[i];
2924                 unsigned long flags;
2925
2926                 if (!(dev->flags & ATA_DFLAG_DETACHED))
2927                         continue;
2928
2929                 spin_lock_irqsave(&ap->host_set->lock, flags);
2930                 dev->flags &= ~ATA_DFLAG_DETACHED;
2931                 spin_unlock_irqrestore(&ap->host_set->lock, flags);
2932
2933                 ata_scsi_remove_dev(dev);
2934         }
2935
2936         /* scan for new ones */
2937         ata_scsi_scan_host(ap);
2938
2939         /* If we scanned while EH was in progress, scan would have
2940          * failed silently.  Requeue if there are enabled but
2941          * unattached devices.
2942          */
2943         for (i = 0; i < ATA_MAX_DEVICES; i++) {
2944                 struct ata_device *dev = &ap->device[i];
2945                 if (ata_dev_enabled(dev) && !dev->sdev) {
2946                         queue_delayed_work(ata_aux_wq, &ap->hotplug_task, HZ);
2947                         break;
2948                 }
2949         }
2950
2951         DPRINTK("EXIT\n");
2952 }
2953
2954 /**
2955  *      ata_scsi_user_scan - indication for user-initiated bus scan
2956  *      @shost: SCSI host to scan
2957  *      @channel: Channel to scan
2958  *      @id: ID to scan
2959  *      @lun: LUN to scan
2960  *
2961  *      This function is called when user explicitly requests bus
2962  *      scan.  Set probe pending flag and invoke EH.
2963  *
2964  *      LOCKING:
2965  *      SCSI layer (we don't care)
2966  *
2967  *      RETURNS:
2968  *      Zero.
2969  */
2970 static int ata_scsi_user_scan(struct Scsi_Host *shost, unsigned int channel,
2971                               unsigned int id, unsigned int lun)
2972 {
2973         struct ata_port *ap = ata_shost_to_port(shost);
2974         unsigned long flags;
2975         int rc = 0;
2976
2977         if (!ap->ops->error_handler)
2978                 return -EOPNOTSUPP;
2979
2980         if ((channel != SCAN_WILD_CARD && channel != 0) ||
2981             (lun != SCAN_WILD_CARD && lun != 0))
2982                 return -EINVAL;
2983
2984         spin_lock_irqsave(&ap->host_set->lock, flags);
2985
2986         if (id == SCAN_WILD_CARD) {
2987                 ap->eh_info.probe_mask |= (1 << ATA_MAX_DEVICES) - 1;
2988                 ap->eh_info.action |= ATA_EH_SOFTRESET;
2989         } else {
2990                 struct ata_device *dev = ata_find_dev(ap, id);
2991
2992                 if (dev) {
2993                         ap->eh_info.probe_mask |= 1 << dev->devno;
2994                         ap->eh_info.action |= ATA_EH_SOFTRESET;
2995                 } else
2996                         rc = -EINVAL;
2997         }
2998
2999         if (rc == 0)
3000                 ata_port_schedule_eh(ap);
3001
3002         spin_unlock_irqrestore(&ap->host_set->lock, flags);
3003
3004         return rc;
3005 }
3006
3007 /**
3008  *      ata_scsi_dev_rescan - initiate scsi_rescan_device()
3009  *      @data: Pointer to ATA port to perform scsi_rescan_device()
3010  *
3011  *      After ATA pass thru (SAT) commands are executed successfully,
3012  *      libata need to propagate the changes to SCSI layer.  This
3013  *      function must be executed from ata_aux_wq such that sdev
3014  *      attach/detach don't race with rescan.
3015  *
3016  *      LOCKING:
3017  *      Kernel thread context (may sleep).
3018  */
3019 void ata_scsi_dev_rescan(void *data)
3020 {
3021         struct ata_port *ap = data;
3022         struct ata_device *dev;
3023         unsigned int i;
3024
3025         for (i = 0; i < ATA_MAX_DEVICES; i++) {
3026                 dev = &ap->device[i];
3027
3028                 if (ata_dev_enabled(dev) && dev->sdev)
3029                         scsi_rescan_device(&(dev->sdev->sdev_gendev));
3030         }
3031 }